planetj.dataengine.display
Class ActionDescriptor

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

All Implemented Interfaces:

Cloneable, Comparable, Map, Serializable

public class ActionDescriptor

extends DefaultPropertyGroup

An ActionDescriptor contains all the actions of a given type that should be shown or hidden when displaying.

Author:

PlanetJ Corporation

See Also:

Serialized Form

Field Summary

static String	ACTION_DESCRIPTOR Used for the default ActionDisplayDescriptor's property group name.
static String	className Class name.
static String	HIDE Actions to hide.
static String	SHOW Actions to show.
static String	TYPE Type of actions to show or hide (e.g.
static String	TYPE_COLUMN
static String	TYPE_ROW
static String	TYPE_ROWCOLLECTION

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

ActionDescriptor()
ActionDescriptor constructor comment.

ActionDescriptor(int initialCapacity)
ActionDescriptor constructor comment.

ActionDescriptor(String pName)
ActionDescriptor constructor comment.

Method Summary

List	getAllPropertyNames() Gets a List containing the names of all the supported properties.
List	getHiddenActionNames() Get list of actions to hide.
List	getShownActionNames() Get list of actions to show.
String	getType() Get the type of actions shown or hidden.

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_DESCRIPTOR

public static final String ACTION_DESCRIPTOR

Used for the default ActionDisplayDescriptor's property group name.

See Also:

Constant Field Values

TYPE

public static final String TYPE

Type of actions to show or hide (e.g. rc, row, column).

See Also:

Constant Field Values

TYPE_ROWCOLLECTION

public static final String TYPE_ROWCOLLECTION

See Also:

Constant Field Values

TYPE_ROW

public static final String TYPE_ROW

See Also:

Constant Field Values

TYPE_COLUMN

public static final String TYPE_COLUMN

See Also:

Constant Field Values

SHOW

public static final String SHOW

Actions to show.

See Also:

Constant Field Values

HIDE

public static final String HIDE

Actions to hide.

See Also:

Constant Field Values

Constructor Detail

ActionDescriptor

public ActionDescriptor()

ActionDescriptor constructor comment.

ActionDescriptor

public ActionDescriptor(int initialCapacity)

ActionDescriptor constructor comment.

Parameters:

initialCapacity - int

ActionDescriptor

public ActionDescriptor(String pName)

ActionDescriptor constructor comment.

Parameters:

pName - java.lang.String

Method Detail

getAllPropertyNames

public List getAllPropertyNames()

Gets a List containing the names of all the supported properties.

Overrides:

getAllPropertyNames in class DefaultPropertyGroup

getHiddenActionNames

public List getHiddenActionNames()

Get list of actions to hide.

getShownActionNames

public List getShownActionNames()

Get list of actions to show.

getType

public String getType()

Get the type of actions shown or hidden.