public class ControlDescriptor extends BaseDescriptor
DATATYPE_BOOLEAN, DATATYPE_INTEGER, DATATYPE_POSITVE_INTEGER, DATATYPE_STRING, DESCRIPTORATTRIBUTE_CLASS, DESCRIPTORATTRIBUTE_DEFAULT, DESCRIPTORATTRIBUTE_DESCRIPTORCLASS, DESCRIPTORATTRIBUTE_HANDLER, DESCRIPTORATTRIBUTE_NAME, DESCRIPTORATTRIBUTE_SHORTNAME, DESCRIPTORATTRIBUTE_TYPE, DESCRIPTORCLASS_COMPONENTDESCRIPTOR, DESCRIPTORCLASS_CONTROLDESCRIPTOR, DESCRIPTORTAG_ATTRIBUTE, DESCRIPTORTAG_BINDLIST, DESCRIPTORTAG_CHILDCONTROLS, DESCRIPTORTAG_COMPONENTDESCRIPTOR, DESCRIPTORTAG_COMPONENTLIST, DESCRIPTORTAG_COMPONENTS, DESCRIPTORTAG_CONTAINER, DESCRIPTORTAG_CONTROLDESCRIPTOR, DESCRIPTORTAG_DEFAULTVALUE, DESCRIPTORTAG_DESCRIPTION, DESCRIPTORTAG_FLAG, DESCRIPTORTAG_INPUTMODE, DESCRIPTORTAG_LABEL, DESCRIPTORTAG_PROPERTY, DESCRIPTORTAG_PROPERTYLIST, DESCRIPTORTAG_RENDERCONTROLS, DESCRIPTORTAG_TEMPLATE, DESCRIPTORTAG_USERAGENT, DESCRIPTORTAG_VALUE, DESCRIPTORTAG_VALUELIST, DESCRIPTORTYPE_ACTION, DESCRIPTORTYPE_DIALOG, DESCRIPTORTYPE_MENU, DESCRIPTORTYPE_MESSAGEBOX, DESCRIPTORTYPE_MODELESSDIALOG, DESCRIPTORTYPE_MOVABLEWINDOWDIALOG, DESCRIPTORTYPE_PAGE, DESCRIPTORTYPE_POPUP, DESCRIPTORTYPE_PRESENTATION, DESCRIPTORTYPE_RECORDHOVER, DESCRIPTORTYPE_TABLE, INSTANCECLASS_COMPONENTINSTANCE, INSTANCECLASS_CONTROLINSTANCE, orderedProperties
Constructor and Description |
---|
ControlDescriptor() |
Modifier and Type | Method and Description |
---|---|
void |
addComponent(ComponentDescriptor component) |
boolean |
canCreateControl(PageInstance page,
ControlInstance parentControl,
org.w3c.dom.Element element)
Can be overridden to allow a control to setup rules for creation
|
void |
cleanup() |
java.util.List<BindingDefinition> |
getBindList() |
java.util.List<ComponentDescriptor> |
getComponents() |
ControlInstance |
getInstance(WebClientSession wcs,
org.w3c.dom.Element presentationElement)
instantiates an instance object based on the class read from the descriptor, and merges
in the properties from the presentation xml's element that represents the control
|
org.w3c.dom.Element |
getTemplate()
returns the topmost child element from the element in the control descriptor
this is the template for what gets added to the presentation when a control is dragged off the tool palette
|
boolean |
indicatesChildError()
Returns true if the control will indicate (show the error icon) if a child control has an error.
|
getElement, getInstance, getName, getProperties, getProperty, getShortName, hasProperty, initialize, toString
public ControlInstance getInstance(WebClientSession wcs, org.w3c.dom.Element presentationElement)
presentationElement
- public java.util.List<BindingDefinition> getBindList()
public java.util.List<ComponentDescriptor> getComponents()
public void addComponent(ComponentDescriptor component)
topComponent
- The topComponent to set.public boolean indicatesChildError()
public org.w3c.dom.Element getTemplate()
public boolean canCreateControl(PageInstance page, ControlInstance parentControl, org.w3c.dom.Element element)
public void cleanup()
cleanup
in class BaseDescriptor