planetj.dataengine.display
Class ActionDisplayDescriptor

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.HashMap
              |
              +--planetj.property.PropertyGroup
                    |
                    +--planetj.property.DefaultPropertyGroup
                          |
                          +--planetj.dataengine.display.ActionDisplayDescriptor

All Implemented Interfaces:

Cloneable, Comparable, Map, Serializable

public class ActionDisplayDescriptor

extends DefaultPropertyGroup

An ActionDisplayDescriptor property group contains all the information needed in order to display the action.

Author:

PlanetJ Corporation

See Also:

Serialized Form

Field Summary

static String	ACTION_DISPLAY_DESCRIPTOR Used for the default ActionDisplayDescriptor's property group name.
static String	ACTION_NAME Action name (e.g.
static String	ACTION_TYPE Action type (e.g.
static String	className Class name.
static String	DESCRIPTION Description of action to display.
static String	DISPLAY_TYPE How to display the action (e.g.
static String	DISPLAY_TYPE_BUTTON
static String	DISPLAY_TYPE_LINK
static String	IMAGE_URI Image URI to use for generated action's background.
static String	LABEL Label when displaying action.
static String	LOCATION Location of where to generate the action.

Fields inherited from class planetj.property.DefaultPropertyGroup

NONE

Fields inherited from class planetj.property.PropertyGroup

ALL_FALSE, ALL_TRUE, BOOLEAN_PROPERTY, DATE_PROPERTY, DOUBLE_PROPERTY, INTEGER_PROPERTY, LIST_PROPERTY, ROW_COLLECTION_KEY, STRING_PROPERTY

Constructor Summary

ActionDisplayDescriptor()
ActionDescriptor constructor comment.

ActionDisplayDescriptor(int initialCapacity)
ActionDescriptor constructor comment.

ActionDisplayDescriptor(String pName)
ActionDescriptor constructor comment.

Method Summary

AbstractAction	getAction() Gets the action associated with this descriptor.
String	getActionName() Get the name of action being described for display.
String	getActionType() Get the type of action being described for display.
List	getAllPropertyNames() Gets a List containing the names of all the supported properties, not including metaproperties.
String	getDescription() Get the description of the action.
String	getDisplayType() Get the display type to generate for action.
String	getImageURI() Get the URI of image to use for the background of the display type.
String	getLabel() Get the label of the action to generate when displayed.
List	getLayoutPropertyNames() Gets a List containing the names of all the supported properties, not including metaproperties.
String	getLocation() Get the location where the action should be displayed.

Methods inherited from class planetj.property.DefaultPropertyGroup

getDefaultPropertiesString, getRequiredPropertyNames

Methods inherited from class planetj.property.PropertyGroup

add, addProperty, addProperty, append, clone, compareTo, compareTo, compareTo, containsProperty, createProperty, getAllMetapropertyNames, getAllSetBooleanPropertyNames, getAllSetIntPropertyNames, getAllSetListPropertyNames, getAllSetPropertyNames, getAllSetStringPropertyNames, getBooleanValue, getDateValue, getDoubleValue, getIntValue, getListValue, getName, getProperty, getPropertyType, getStringValue, getValue, isMergeableOnList, isMetaproperty, iterator, mergeOnList, put, put, put, setName, toString, updateProperty

Methods inherited from class java.util.HashMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

className

public static final String className

Class name.

ACTION_DISPLAY_DESCRIPTOR

public static final String ACTION_DISPLAY_DESCRIPTOR

Used for the default ActionDisplayDescriptor's property group name.

See Also:

Constant Field Values

ACTION_TYPE

public static final String ACTION_TYPE

Action type (e.g. rc, row, column).

See Also:

Constant Field Values

ACTION_NAME

public static final String ACTION_NAME

Action name (e.g. insert, update, etc...).

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Description of action to display.

See Also:

Constant Field Values

DISPLAY_TYPE

public static final String DISPLAY_TYPE

How to display the action (e.g. button, link, etc...).

See Also:

Constant Field Values

DISPLAY_TYPE_BUTTON

public static final String DISPLAY_TYPE_BUTTON

See Also:

Constant Field Values

DISPLAY_TYPE_LINK

public static final String DISPLAY_TYPE_LINK

See Also:

Constant Field Values

IMAGE_URI

public static final String IMAGE_URI

Image URI to use for generated action's background.

See Also:

Constant Field Values

LABEL

public static final String LABEL

Label when displaying action.

See Also:

Constant Field Values

LOCATION

public static final String LOCATION

Location of where to generate the action.

See Also:

Constant Field Values

Constructor Detail

ActionDisplayDescriptor

public ActionDisplayDescriptor()

ActionDescriptor constructor comment.

ActionDisplayDescriptor

public ActionDisplayDescriptor(int initialCapacity)

ActionDescriptor constructor comment.

Parameters:

initialCapacity - int

ActionDisplayDescriptor

public ActionDisplayDescriptor(String pName)

ActionDescriptor constructor comment.

Parameters:

pName - java.lang.String

Method Detail

getAction

public AbstractAction getAction()

Gets the action associated with this descriptor.

getActionName

public String getActionName()

Get the name of action being described for display. (e.g. insert, update, etc...)

getActionType

public String getActionType()

Get the type of action being described for display. (e.g. rc, row, col)

getAllPropertyNames

public List getAllPropertyNames()

Gets a List containing the names of all the supported properties, not including metaproperties.

Overrides:

getAllPropertyNames in class DefaultPropertyGroup

getDescription

public String getDescription()

Get the description of the action.

getDisplayType

public String getDisplayType()

Get the display type to generate for action. (e.g. button, link, etc...)

getImageURI

public String getImageURI()

Get the URI of image to use for the background of the display type.

getLabel

public String getLabel()

Get the label of the action to generate when displayed.

getLayoutPropertyNames

public List getLayoutPropertyNames()

Gets a List containing the names of all the supported properties, not including metaproperties.

getLocation

public String getLocation()

Get the location where the action should be displayed.