psdi.webclient.system.runtime

Class BaseDescriptor

java.lang.Object

psdi.webclient.system.runtime.BaseDescriptor

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

CmsMenuDescriptor, ComponentDescriptor, ControlDescriptor, MboAttributeDescriptor

public class BaseDescriptor
extends java.lang.Object
implements java.lang.Cloneable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATATYPE_BOOLEAN
static java.lang.String	DATATYPE_INTEGER
static java.lang.String	DATATYPE_POSITVE_INTEGER
static java.lang.String	DATATYPE_STRING
static java.lang.String	DESCRIPTORATTRIBUTE_CLASS
static java.lang.String	DESCRIPTORATTRIBUTE_DEFAULT
static java.lang.String	DESCRIPTORATTRIBUTE_DESCRIPTORCLASS
static java.lang.String	DESCRIPTORATTRIBUTE_HANDLER
static java.lang.String	DESCRIPTORATTRIBUTE_NAME
static java.lang.String	DESCRIPTORATTRIBUTE_SHORTNAME
static java.lang.String	DESCRIPTORATTRIBUTE_TYPE
static java.lang.String	DESCRIPTORCLASS_COMPONENTDESCRIPTOR
static java.lang.String	DESCRIPTORCLASS_CONTROLDESCRIPTOR
static java.lang.String	DESCRIPTORTAG_ATTRIBUTE
static java.lang.String	DESCRIPTORTAG_BINDLIST
static java.lang.String	DESCRIPTORTAG_CHILDCONTROLS
static java.lang.String	DESCRIPTORTAG_COMPONENTDESCRIPTOR
static java.lang.String	DESCRIPTORTAG_COMPONENTLIST
static java.lang.String	DESCRIPTORTAG_COMPONENTS
static java.lang.String	DESCRIPTORTAG_CONTAINER
static java.lang.String	DESCRIPTORTAG_CONTROLDESCRIPTOR
static java.lang.String	DESCRIPTORTAG_DEFAULTVALUE
static java.lang.String	DESCRIPTORTAG_DESCRIPTION
static java.lang.String	DESCRIPTORTAG_FLAG
static java.lang.String	DESCRIPTORTAG_INPUTMODE
static java.lang.String	DESCRIPTORTAG_LABEL
static java.lang.String	DESCRIPTORTAG_PROPERTY
static java.lang.String	DESCRIPTORTAG_PROPERTYLIST
static java.lang.String	DESCRIPTORTAG_RENDERCONTROLS
static java.lang.String	DESCRIPTORTAG_TEMPLATE
static java.lang.String	DESCRIPTORTAG_USERAGENT
static java.lang.String	DESCRIPTORTAG_VALUE
static java.lang.String	DESCRIPTORTAG_VALUELIST
static java.lang.String	DESCRIPTORTYPE_ACTION
static java.lang.String	DESCRIPTORTYPE_DIALOG
static java.lang.String	DESCRIPTORTYPE_MENU
static java.lang.String	DESCRIPTORTYPE_MESSAGEBOX
static java.lang.String	DESCRIPTORTYPE_MODELESSDIALOG
static java.lang.String	DESCRIPTORTYPE_MOVABLEWINDOWDIALOG
static java.lang.String	DESCRIPTORTYPE_PAGE
static java.lang.String	DESCRIPTORTYPE_POPUP
static java.lang.String	DESCRIPTORTYPE_PRESENTATION
static java.lang.String	DESCRIPTORTYPE_RECORDHOVER
static java.lang.String	DESCRIPTORTYPE_TABLE
static java.lang.String	INSTANCECLASS_COMPONENTINSTANCE
static java.lang.String	INSTANCECLASS_CONTROLINSTANCE
java.util.List<Property>	orderedProperties

Method Summary

Modifier and Type	Method and Description
void	cleanup()
org.w3c.dom.Element	getElement()
BaseInstance	getInstance(WebClientSession wcs)
java.lang.String	getName()
java.util.HashMap<java.lang.String,Property>	getProperties()
java.lang.String	getProperty(java.lang.Object key) Returns the String value of the specified property
java.lang.String	getShortName()
boolean	hasProperty(java.lang.String key) Checks to see if the property with the given key exists
void	initialize(org.w3c.dom.Element controlElement) Should be extended to do any setup required by the descriptor.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DESCRIPTORCLASS_CONTROLDESCRIPTOR

public static final java.lang.String DESCRIPTORCLASS_CONTROLDESCRIPTOR

See Also:

Constant Field Values

DESCRIPTORCLASS_COMPONENTDESCRIPTOR

public static final java.lang.String DESCRIPTORCLASS_COMPONENTDESCRIPTOR

See Also:

Constant Field Values

DESCRIPTORATTRIBUTE_CLASS

public static final java.lang.String DESCRIPTORATTRIBUTE_CLASS

See Also:

Constant Field Values

DESCRIPTORATTRIBUTE_HANDLER

public static final java.lang.String DESCRIPTORATTRIBUTE_HANDLER

See Also:

Constant Field Values

DESCRIPTORATTRIBUTE_NAME

public static final java.lang.String DESCRIPTORATTRIBUTE_NAME

See Also:

Constant Field Values

DESCRIPTORATTRIBUTE_SHORTNAME

public static final java.lang.String DESCRIPTORATTRIBUTE_SHORTNAME

See Also:

Constant Field Values

DESCRIPTORATTRIBUTE_DESCRIPTORCLASS

public static final java.lang.String DESCRIPTORATTRIBUTE_DESCRIPTORCLASS

See Also:

Constant Field Values

DESCRIPTORATTRIBUTE_DEFAULT

public static final java.lang.String DESCRIPTORATTRIBUTE_DEFAULT

See Also:

Constant Field Values

DESCRIPTORATTRIBUTE_TYPE

public static final java.lang.String DESCRIPTORATTRIBUTE_TYPE

See Also:

Constant Field Values

DESCRIPTORTAG_CONTROLDESCRIPTOR

public static final java.lang.String DESCRIPTORTAG_CONTROLDESCRIPTOR

See Also:

Constant Field Values

DESCRIPTORTAG_CONTAINER

public static final java.lang.String DESCRIPTORTAG_CONTAINER

See Also:

Constant Field Values

DESCRIPTORTAG_COMPONENTDESCRIPTOR

public static final java.lang.String DESCRIPTORTAG_COMPONENTDESCRIPTOR

See Also:

Constant Field Values

DESCRIPTORTAG_COMPONENTLIST

public static final java.lang.String DESCRIPTORTAG_COMPONENTLIST

See Also:

Constant Field Values

DESCRIPTORTAG_CHILDCONTROLS

public static final java.lang.String DESCRIPTORTAG_CHILDCONTROLS

See Also:

Constant Field Values

DESCRIPTORTAG_COMPONENTS

public static final java.lang.String DESCRIPTORTAG_COMPONENTS

See Also:

Constant Field Values

DESCRIPTORTAG_DEFAULTVALUE

public static final java.lang.String DESCRIPTORTAG_DEFAULTVALUE

See Also:

Constant Field Values

DESCRIPTORTAG_DESCRIPTION

public static final java.lang.String DESCRIPTORTAG_DESCRIPTION

See Also:

Constant Field Values

DESCRIPTORTAG_FLAG

public static final java.lang.String DESCRIPTORTAG_FLAG

See Also:

Constant Field Values

DESCRIPTORTAG_PROPERTY

public static final java.lang.String DESCRIPTORTAG_PROPERTY

See Also:

Constant Field Values

DESCRIPTORTAG_PROPERTYLIST

public static final java.lang.String DESCRIPTORTAG_PROPERTYLIST

See Also:

Constant Field Values

DESCRIPTORTAG_VALUE

public static final java.lang.String DESCRIPTORTAG_VALUE

See Also:

Constant Field Values

DESCRIPTORTAG_VALUELIST

public static final java.lang.String DESCRIPTORTAG_VALUELIST

See Also:

Constant Field Values

DESCRIPTORTAG_BINDLIST

public static final java.lang.String DESCRIPTORTAG_BINDLIST

See Also:

Constant Field Values

DESCRIPTORTAG_ATTRIBUTE

public static final java.lang.String DESCRIPTORTAG_ATTRIBUTE

See Also:

Constant Field Values

DESCRIPTORTAG_LABEL

public static final java.lang.String DESCRIPTORTAG_LABEL

See Also:

Constant Field Values

DESCRIPTORTAG_INPUTMODE

public static final java.lang.String DESCRIPTORTAG_INPUTMODE

See Also:

Constant Field Values

DESCRIPTORTAG_TEMPLATE

public static final java.lang.String DESCRIPTORTAG_TEMPLATE

See Also:

Constant Field Values

DESCRIPTORTAG_USERAGENT

public static final java.lang.String DESCRIPTORTAG_USERAGENT

See Also:

Constant Field Values

DESCRIPTORTAG_RENDERCONTROLS

public static final java.lang.String DESCRIPTORTAG_RENDERCONTROLS

See Also:

Constant Field Values

DESCRIPTORTYPE_MENU

public static final java.lang.String DESCRIPTORTYPE_MENU

See Also:

Constant Field Values

DESCRIPTORTYPE_TABLE

public static final java.lang.String DESCRIPTORTYPE_TABLE

See Also:

Constant Field Values

DATATYPE_BOOLEAN

public static final java.lang.String DATATYPE_BOOLEAN

See Also:

Constant Field Values

DATATYPE_STRING

public static final java.lang.String DATATYPE_STRING

See Also:

Constant Field Values

DATATYPE_INTEGER

public static final java.lang.String DATATYPE_INTEGER

See Also:

Constant Field Values

DATATYPE_POSITVE_INTEGER

public static final java.lang.String DATATYPE_POSITVE_INTEGER

See Also:

Constant Field Values

DESCRIPTORTYPE_DIALOG

public static final java.lang.String DESCRIPTORTYPE_DIALOG

See Also:

Constant Field Values

DESCRIPTORTYPE_ACTION

public static final java.lang.String DESCRIPTORTYPE_ACTION

See Also:

Constant Field Values

DESCRIPTORTYPE_MODELESSDIALOG

public static final java.lang.String DESCRIPTORTYPE_MODELESSDIALOG

See Also:

Constant Field Values

DESCRIPTORTYPE_MOVABLEWINDOWDIALOG

public static final java.lang.String DESCRIPTORTYPE_MOVABLEWINDOWDIALOG

See Also:

Constant Field Values

DESCRIPTORTYPE_MESSAGEBOX

public static final java.lang.String DESCRIPTORTYPE_MESSAGEBOX

See Also:

Constant Field Values

DESCRIPTORTYPE_PAGE

public static final java.lang.String DESCRIPTORTYPE_PAGE

See Also:

Constant Field Values

DESCRIPTORTYPE_POPUP

public static final java.lang.String DESCRIPTORTYPE_POPUP

See Also:

Constant Field Values

DESCRIPTORTYPE_PRESENTATION

public static final java.lang.String DESCRIPTORTYPE_PRESENTATION

See Also:

Constant Field Values

DESCRIPTORTYPE_RECORDHOVER

public static final java.lang.String DESCRIPTORTYPE_RECORDHOVER

See Also:

Constant Field Values

INSTANCECLASS_CONTROLINSTANCE

public static final java.lang.String INSTANCECLASS_CONTROLINSTANCE

See Also:

Constant Field Values

INSTANCECLASS_COMPONENTINSTANCE

public static final java.lang.String INSTANCECLASS_COMPONENTINSTANCE

See Also:

Constant Field Values

orderedProperties

public java.util.List<Property> orderedProperties

Method Detail

getElement

public org.w3c.dom.Element getElement()

getName

public java.lang.String getName()

getShortName

public java.lang.String getShortName()

getProperties

@TraceMaskValue
public java.util.HashMap<java.lang.String,Property> getProperties()

getInstance

public BaseInstance getInstance(WebClientSession wcs)

getProperty

@TraceDisabled
public java.lang.String getProperty(java.lang.Object key)

Returns the String value of the specified property

initialize

public void initialize(org.w3c.dom.Element controlElement)

Should be extended to do any setup required by the descriptor. for example, the BoundComponentDescriptor will call initialize to add it's attribute to the bind list.

Parameters:

Element - the element from the presentation for this control. if we're initializing a component, the element is still the control's presentation element.

hasProperty

public boolean hasProperty(java.lang.String key)

Checks to see if the property with the given key exists

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

cleanup

public void cleanup()