ElementBase (CWF Shell 6.0.0-RC3 API)

java.lang.Object
- org.carewebframework.shell.elements.ElementBase

Direct Known Subclasses:

ElementProxy, ElementTrigger, ElementTriggerAction, ElementTriggerCondition, ElementUI
```
public abstract class ElementBase
extends Object
```
This is the base class for all layout elements supported by the CareWeb framework.

Field Summary

Fields
Modifier and Type Field and Description

protected static org.apache.commons.logging.Log log

Fields
Modifier and Type	Field and Description
`protected static org.apache.commons.logging.Log`	`log`

Constructor Summary

Constructors
Constructor and Description

ElementBase()

Constructors
Constructor and Description
`ElementBase()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`about()` Displays an about dialog for the UI element.
`void`	`addChild(ElementBase child)` Adds the specified child element.
`protected void`	`addChild(ElementBase child, boolean doEvent)` Adds the specified child element.
`protected void`	`afterAddChild(ElementBase child)` Called after a child is logically added to the parent.
`void`	`afterInitialize(boolean deserializing)` Subclasses may override this to implement any additional operations that are necessary after this element is initialized (i.e., after property values and parent element are set).
`protected void`	`afterMoveChild(ElementBase child, ElementBase before)` Called after an element has been moved to a different position under this parent.
`protected void`	`afterParentChanged(ElementBase oldParent)` Called after the parent has been changed.
`protected void`	`afterRemoveChild(ElementBase child)` Called after a child is logically removed from the parent.
`protected void`	`beforeAddChild(ElementBase child)` Called before a child is logically added to the parent.
`void`	`beforeInitialize(boolean deserializing)` Subclasses may override this to implement any additional operations that are necessary before this element is initialized (i.e., before property values and parent element are set).
`protected void`	`beforeParentChanged(ElementBase newParent)` Called before the parent has been changed.
`protected void`	`beforeRemoveChild(ElementBase child)` Called before a child is logically removed from the parent.
`boolean`	`canAcceptChild()` Returns true if this element may accept a child.
`boolean`	`canAcceptChild(Class<? extends ElementBase> childClass)` Returns true if this element may accept a child of the specified class.
`static boolean`	`canAcceptChild(Class<? extends ElementBase> parentClass, Class<? extends ElementBase> childClass)` Returns true if childClass can be a child of the parentClass.
`boolean`	`canAcceptChild(ElementBase child)` Returns true if this element may accept the specified child.
`boolean`	`canAcceptParent()` Returns true if this element may accept a parent.
`boolean`	`canAcceptParent(Class<? extends ElementBase> clazz)` Returns true if this element may accept a parent of the specified class.
`static boolean`	`canAcceptParent(Class<? extends ElementBase> childClass, Class<? extends ElementBase> parentClass)` Returns true if parentClass can be a parent of childClass.
`boolean`	`canAcceptParent(ElementBase parent)` Returns true if this element may accept the specified element as a parent.
`void`	`destroy()` Override to implement special cleanup when an object is destroyed.
`void`	`editProperties()` Invokes the property grid with this element as its target.
`<T extends ElementBase> T`	`findChildElement(Class<T> clazz)` Recurses the component subtree for a child belonging to the specified class.
`<T extends ElementBase> T`	`getAncestor(Class<T> clazz)` Returns the first ancestor corresponding to the specified class.
`<T extends ElementBase> T`	`getChild(Class<T> clazz, ElementBase last)` Locates and returns a child that is an instance of the specified class.
`ElementBase`	`getChild(int index)` Gets the UI element child at the specified index.
`int`	`getChildCount()` Returns the number of children.
`int`	`getChildCount(Class<? extends ElementBase> clazz)` Returns the number of children.
`Iterable<ElementBase>`	`getChildren()` Returns an iterable of this component's children.
`<T extends ElementBase> Iterable<T>`	`getChildren(Class<T> clazz)` Returns an iterable of this component's children restricted to the specified type.
`PluginDefinition`	`getDefinition()` Return the definition used to create this instance.
`String`	`getDisplayName()` Returns the display name of this element.
`protected org.carewebframework.api.event.IEventManager`	`getEventManager()` Returns instance of the event manager.
`ElementBase`	`getFirstChild()` Returns the first child, or null if there are no children.
`int`	`getIndex()` Returns this element's index in its parent's list of children.
`String`	`getInstanceName()` Returns the instance name of this element.
`ElementBase`	`getLastChild()` Returns the last child, or null if there are no children.
`ElementBase`	`getParent()` Returns the parent of this element.
`Class<? extends Object>`	`getPropEditClass()` Returns the class of the property editor associated with this UI element.
`String`	`getRejectReason()` Returns the reject reason.
`ElementBase`	`getRoot()` Returns the UI element at the root of the component tree.
`Iterable<ElementBase>`	`getSerializableChildren()` Returns an iterable of this component's serializable children.
`boolean`	`hasAncestor(ElementBase element)` Returns true if specified element is an ancestor of this element.
`boolean`	`hasChild(ElementBase element)` Returns true if the specified element is a child of this element.
`int`	`indexOfChild(ElementBase child)` Returns the index of the specified child.
`boolean`	`isContainer()` Returns true if this UI element can contain other UI elements.
`boolean`	`isDesignMode()` Returns design mode status.
`boolean`	`isEnabled()` Returns the enabled state of the UI element.
`boolean`	`isLocked()` Returns true if the element is locked.
`protected void`	`listenToChild(String eventName, INotificationListener listener)` Register/unregister a child notification listener.
`protected void`	`listenToParent(String eventName, INotificationListener listener)` Register/unregister a parent notification listener.
`protected void`	`moveChild(org.fujion.component.BaseUIComponent child, org.fujion.component.BaseUIComponent before)` Moves a child to before another component.
`void`	`moveChild(int from, int to)` Moves a child from one position to another under the same parent.
`void`	`notifyChildren(String eventName, Object eventData, boolean recurse)` Allows a parent element to notify its children of an event of interest.
`void`	`notifyParent(String eventName, Object eventData, boolean recurse)` Allows a child element to notify its parent of an event of interest.
`protected static void`	`registerAllowedChildClass(Class<? extends ElementBase> clazz, Class<? extends ElementBase> childClass, int maxOccurrences)` A ElementBase subclass should call this in its static initializer block to register any subclasses that may be a child.
`protected static void`	`registerAllowedParentClass(Class<? extends ElementBase> clazz, Class<? extends ElementBase> parentClass)` A ElementBase subclass should call this in its static initializer block to register any subclasses that may act as a parent.
`void`	`remove(boolean destroy)` Removes this element from its parent and optionally destroys it.
`void`	`removeChild(ElementBase child, boolean destroy)` Removes the specified element as a child of this parent.
`void`	`removeChildren()` Remove and destroy all children associated with this element.
`void`	`setDefinition(Class<? extends ElementBase> clazz)` Sets the plugin definition based on the specified class.
`void`	`setDefinition(PluginDefinition definition)` Sets the plugin definition for this element.
`void`	`setDesignMode(boolean designMode)` Sets design mode status for this component and all its children.
`void`	`setEnabled(boolean enabled)` Sets the enabled state of the component.
`void`	`setIndex(int index)` Sets this element's index to the specified value.
`void`	`setLocked(boolean locked)` Sets the locked status of the element.
`void`	`setParent(ElementBase parent)` Sets the parent of this element, subject to the parent/child constraints applicable to each.
`void`	`setRejectReason(String rejectReason)` Sets the reject reason to the specified value.
`protected void`	`updateParentState()` Calls updateState on the parent if one exists.
`protected void`	`updateState()` Update an element based on the state of its children.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log
```
protected static final org.apache.commons.logging.Log log
```
- Constructor Detail
  - ElementBase
```
public ElementBase()
```
- Method Detail
  - registerAllowedParentClass
```
protected static void registerAllowedParentClass(Class<? extends ElementBase> clazz,
                                                 Class<? extends ElementBase> parentClass)
```
    A ElementBase subclass should call this in its static initializer block to register any subclasses that may act as a parent.
    
    Parameters:
    
    clazz - Class whose valid parent classes are to be registered.
    
    parentClass - Class that may act as a parent to clazz.
  - registerAllowedChildClass
```
protected static void registerAllowedChildClass(Class<? extends ElementBase> clazz,
                                                Class<? extends ElementBase> childClass,
                                                int maxOccurrences)
```
    A ElementBase subclass should call this in its static initializer block to register any subclasses that may be a child.
    
    Parameters:
    
    clazz - Class whose valid child classes are to be registered.
    
    childClass - Class that may be a child of clazz.
    
    maxOccurrences - Maximum occurrences for the child class.
  - canAcceptChild
```
public static boolean canAcceptChild(Class<? extends ElementBase> parentClass,
                                     Class<? extends ElementBase> childClass)
```
    Returns true if childClass can be a child of the parentClass.
    
    Parameters:
    
    parentClass - Parent class
    
    childClass - Child class
    
    Returns:
    
    True if childClass can be a child of the parentClass.
  - canAcceptParent
```
public static boolean canAcceptParent(Class<? extends ElementBase> childClass,
                                      Class<? extends ElementBase> parentClass)
```
    Returns true if parentClass can be a parent of childClass.
    
    Parameters:
    
    childClass - The child class.
    
    parentClass - The parent class.
    
    Returns:
    
    True if parentClass can be a parent of childClass.
  - addChild
```
public void addChild(ElementBase child)
```
    Adds the specified child element. The validity of the operation is first tested and an exception thrown if the element is not a valid child for this parent.
    
    Parameters:
    
    child - Element to add as a child.
  - addChild
```
protected void addChild(ElementBase child,
                        boolean doEvent)
```
    Adds the specified child element. The validity of the operation is first tested and an exception thrown if the element is not a valid child for this parent.
    
    Parameters:
    
    child - Element to add as a child.
    
    doEvent - Fires the add child events if true.
  - afterAddChild
```
protected void afterAddChild(ElementBase child)
```
    Called after a child is logically added to the parent.
    
    Parameters:
    
    child - The child element added.
  - beforeAddChild
```
protected void beforeAddChild(ElementBase child)
```
    Called before a child is logically added to the parent.
    
    Parameters:
    
    child - The new child element.
  - removeChild
```
public void removeChild(ElementBase child,
                        boolean destroy)
```
    Removes the specified element as a child of this parent.
    
    Parameters:
    
    child - Child element to remove.
    
    destroy - If true the child is explicitly destroyed.
  - afterRemoveChild
```
protected void afterRemoveChild(ElementBase child)
```
    Called after a child is logically removed from the parent.
    
    Parameters:
    
    child - The child UI element.
  - beforeRemoveChild
```
protected void beforeRemoveChild(ElementBase child)
```
    Called before a child is logically removed from the parent.
    
    Parameters:
    
    child - The child UI element.
  - afterParentChanged
```
protected void afterParentChanged(ElementBase oldParent)
```
    Called after the parent has been changed.
    
    Parameters:
    
    oldParent - The value of the parent property prior to the change.
  - beforeParentChanged
```
protected void beforeParentChanged(ElementBase newParent)
```
    Called before the parent has been changed.
    
    Parameters:
    
    newParent - The value of the parent property prior to the change.
  - remove
```
public void remove(boolean destroy)
```
    Removes this element from its parent and optionally destroys it.
    
    Parameters:
    
    destroy - If true, the element is also destroyed.
  - removeChildren
```
public void removeChildren()
```
    Remove and destroy all children associated with this element.
  - destroy
```
public void destroy()
```
    Override to implement special cleanup when an object is destroyed.
  - getDefinition
```
public final PluginDefinition getDefinition()
```
    Return the definition used to create this instance.
    
    Returns:
    
    The plugin definition.
  - setDefinition
```
public void setDefinition(PluginDefinition definition)
```
    Sets the plugin definition for this element.
    
    Parameters:
    
    definition - The plugin definition.
  - setDefinition
```
public void setDefinition(Class<? extends ElementBase> clazz)
```
    Sets the plugin definition based on the specified class. Typically this would be the same class as the element itself, but in certain cases (as in the ElementProxy class) it is not.
    
    Parameters:
    
    clazz - The UI element class.
  - isDesignMode
```
public boolean isDesignMode()
```
    Returns design mode status.
    
    Returns:
    
    True if design mode is active.
  - setDesignMode
```
public void setDesignMode(boolean designMode)
```
    Sets design mode status for this component and all its children.
    
    Parameters:
    
    designMode - The design mode flag.
  - about
```
public void about()
```
    Displays an about dialog for the UI element.
  - editProperties
```
public void editProperties()
```
    Invokes the property grid with this element as its target.
  - getEventManager
```
protected org.carewebframework.api.event.IEventManager getEventManager()
```
    Returns instance of the event manager.
    
    Returns:
    
    Event manager instance.
  - getChild
```
public ElementBase getChild(int index)
```
    Gets the UI element child at the specified index.
    
    Parameters:
    
    index - Index of the child to retrieve.
    
    Returns:
    
    The child at the specified index.
  - getChild
```
public <T extends ElementBase> T getChild(Class<T> clazz,
                                          ElementBase last)
```
    Locates and returns a child that is an instance of the specified class. If none is found, returns null.
    
    Type Parameters:
    
    T - The type of child being sought.
    
    Parameters:
    
    clazz - Class of the child being sought.
    
    last - If specified, the search begins after this child. If null, the search begins with the first child.
    
    Returns:
    
    The requested child or null if none found.
  - getChildren
```
public Iterable<ElementBase> getChildren()
```
    Returns an iterable of this component's children.
    
    Returns:
    
    Iterable of this component's children.
  - getChildren
```
public <T extends ElementBase> Iterable<T> getChildren(Class<T> clazz)
```
    Returns an iterable of this component's children restricted to the specified type.
    
    Type Parameters:
    
    T - Type of children returned by iterable.
    
    Parameters:
    
    clazz - Restrict to children of this type.
    
    Returns:
    
    Iterable of this component's children.
  - getSerializableChildren
```
public Iterable<ElementBase> getSerializableChildren()
```
    Returns an iterable of this component's serializable children. By default, this calls getChildren() but may be overridden to accommodate specialized serialization needs.
    
    Returns:
    
    Iterable of this component's serializable children.
  - getChildCount
```
public int getChildCount()
```
    Returns the number of children.
    
    Returns:
    
    Number of children.
  - getChildCount
```
public int getChildCount(Class<? extends ElementBase> clazz)
```
    Returns the number of children.
    
    Parameters:
    
    clazz - Restrict to children of this type.
    
    Returns:
    
    Number of children.
  - getFirstChild
```
public ElementBase getFirstChild()
```
    Returns the first child, or null if there are no children.
    
    Returns:
    
    First child, or null if none.
  - getLastChild
```
public ElementBase getLastChild()
```
    Returns the last child, or null if there are no children.
    
    Returns:
    
    Last child, or null if none.
  - indexOfChild
```
public int indexOfChild(ElementBase child)
```
    Returns the index of the specified child. If the specified component is not a child, -1 is returned.
    
    Parameters:
    
    child - The child component whose index is sought.
    
    Returns:
    
    The child's index or -1 if not found.
  - hasChild
```
public boolean hasChild(ElementBase element)
```
    Returns true if the specified element is a child of this element.
    
    Parameters:
    
    element - The UI element to test.
    
    Returns:
    
    True if the element is a child.
  - findChildElement
```
public <T extends ElementBase> T findChildElement(Class<T> clazz)
```
    Recurses the component subtree for a child belonging to the specified class.
    
    Type Parameters:
    
    T - The type of child being sought.
    
    Parameters:
    
    clazz - Class of child being sought.
    
    Returns:
    
    A child of the specified class, or null if not found.
  - hasAncestor
```
public boolean hasAncestor(ElementBase element)
```
    Returns true if specified element is an ancestor of this element.
    
    Parameters:
    
    element - A UI element.
    
    Returns:
    
    True if the specified element is an ancestor of this element.
  - getIndex
```
public int getIndex()
```
    Returns this element's index in its parent's list of children. If this element has no parent, returns -1.
    
    Returns:
    
    This element's index.
  - moveChild
```
public void moveChild(int from,
                      int to)
```
    Moves a child from one position to another under the same parent.
    
    Parameters:
    
    from - Current position of child.
    
    to - New position of child.
  - afterMoveChild
```
protected void afterMoveChild(ElementBase child,
                              ElementBase before)
```
    Called after an element has been moved to a different position under this parent.
    
    Parameters:
    
    child - Child element that was moved.
    
    before - Child element was moved before this one.
  - setIndex
```
public void setIndex(int index)
```
    Sets this element's index to the specified value. This effectively changes the position of the element relative to its siblings.
    
    Parameters:
    
    index - The index.
  - getDisplayName
```
public String getDisplayName()
```
    Returns the display name of this element. By default, the definition name is returned, but subclasses may override this to return some other name suitable for display in the design UI.
    
    Returns:
    
    The display name.
  - getInstanceName
```
public String getInstanceName()
```
    Returns the instance name of this element. By default, this is the same as the display name, but subclasses may override this to provide additional information that would distinguish multiple instances of the same UI element.
    
    Returns:
    
    The instance name.
  - getPropEditClass
```
public Class<? extends Object> getPropEditClass()
```
    Returns the class of the property editor associated with this UI element. Null means no property editor exists.
    
    Returns:
    
    The class of the associated property editor.
  - isLocked
```
public boolean isLocked()
```
    Returns true if the element is locked. When an element is locked, it may not be manipulated within the designer.
    
    Returns:
    
    True if the element is locked.
  - setLocked
```
public void setLocked(boolean locked)
```
    Sets the locked status of the element. When an element is locked, it may not be manipulated within the designer.
    
    Parameters:
    
    locked - The locked status.
  - getParent
```
public ElementBase getParent()
```
    Returns the parent of this element. May be null.
    
    Returns:
    
    This element's parent.
  - setParent
```
public final void setParent(ElementBase parent)
```
    Sets the parent of this element, subject to the parent/child constraints applicable to each.
    
    Parameters:
    
    parent - The new parent.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets the enabled state of the component. This base implementation only sets the internal flag and notifies the parent of the state change. Each UI element is responsible for overriding this method and reflecting the enabled state in their wrapped UI components.
    
    Parameters:
    
    enabled - The enabled state.
  - isEnabled
```
public final boolean isEnabled()
```
    Returns the enabled state of the UI element.
    
    Returns:
    
    True if the UI element is enabled.
  - moveChild
```
protected void moveChild(org.fujion.component.BaseUIComponent child,
                         org.fujion.component.BaseUIComponent before)
```
    Moves a child to before another component.
    
    Parameters:
    
    child - Child to move
    
    before - Move child to this component.
  - updateParentState
```
protected final void updateParentState()
```
    Calls updateState on the parent if one exists.
  - updateState
```
protected void updateState()
```
    Update an element based on the state of its children.
  - isContainer
```
public boolean isContainer()
```
    Returns true if this UI element can contain other UI elements.
    
    Returns:
    
    True if this UI element can contain other UI elements.
  - canAcceptChild
```
public boolean canAcceptChild()
```
    Returns true if this element may accept a child. Updates the reject reason with the result.
    
    Returns:
    
    True if this element may accept a child. Updates the reject reason with the result.
  - canAcceptChild
```
public boolean canAcceptChild(Class<? extends ElementBase> childClass)
```
    Returns true if this element may accept a child of the specified class. Updates the reject reason with the result.
    
    Parameters:
    
    childClass - Child class to test.
    
    Returns:
    
    True if this element may accept a child of the specified class.
  - canAcceptChild
```
public boolean canAcceptChild(ElementBase child)
```
    Returns true if this element may accept the specified child. Updates the reject reason with the result.
    
    Parameters:
    
    child - Child instance to test.
    
    Returns:
    
    True if this element may accept the specified child.
  - canAcceptParent
```
public boolean canAcceptParent()
```
    Returns true if this element may accept a parent. Updates the reject reason with the result.
    
    Returns:
    
    True if this element may accept a parent.
  - canAcceptParent
```
public boolean canAcceptParent(Class<? extends ElementBase> clazz)
```
    Returns true if this element may accept a parent of the specified class. Updates the reject reason with the result.
    
    Parameters:
    
    clazz - Parent class to test.
    
    Returns:
    
    True if this element may accept a parent of the specified class.
  - canAcceptParent
```
public boolean canAcceptParent(ElementBase parent)
```
    Returns true if this element may accept the specified element as a parent. Updates the reject reason with the result.
    
    Parameters:
    
    parent - Parent instance to test.
    
    Returns:
    
    True if this element may accept the specified element as a parent.
  - setRejectReason
```
public void setRejectReason(String rejectReason)
```
    Sets the reject reason to the specified value.
    
    Parameters:
    
    rejectReason - Reason for rejection.
  - getRejectReason
```
public String getRejectReason()
```
    Returns the reject reason. This is updated by the canAcceptParent and canAcceptChild calls.
    
    Returns:
    
    The reject reason.
  - getRoot
```
public ElementBase getRoot()
```
    Returns the UI element at the root of the component tree.
    
    Returns:
    
    Root UI element.
  - getAncestor
```
public <T extends ElementBase> T getAncestor(Class<T> clazz)
```
    Returns the first ancestor corresponding to the specified class.
    
    Type Parameters:
    
    T - The type of ancestor sought.
    
    Parameters:
    
    clazz - Class of ancestor sought.
    
    Returns:
    
    An ancestor of the specified class or null if not found.
  - beforeInitialize
```
public void beforeInitialize(boolean deserializing)
                      throws Exception
```
    Subclasses may override this to implement any additional operations that are necessary before this element is initialized (i.e., before property values and parent element are set).
    
    Parameters:
    
    deserializing - If true, initialization is occurring as a result of deserialization.
    
    Throws:
    
    Exception - Unspecified exception.
  - afterInitialize
```
public void afterInitialize(boolean deserializing)
                     throws Exception
```
    Subclasses may override this to implement any additional operations that are necessary after this element is initialized (i.e., after property values and parent element are set).
    
    Parameters:
    
    deserializing - If true, initialization is occurring as a result of deserialization.
    
    Throws:
    
    Exception - Unspecified exception.
  - notifyParent
```
public void notifyParent(String eventName,
                         Object eventData,
                         boolean recurse)
```
    Allows a child element to notify its parent of an event of interest.
    
    Parameters:
    
    eventName - Name of the event.
    
    eventData - Data associated with the event.
    
    recurse - If true, recurse up the parent chain.
  - listenToChild
```
protected void listenToChild(String eventName,
                             INotificationListener listener)
```
    Register/unregister a child notification listener.
    
    Parameters:
    
    eventName - The event name.
    
    listener - A notification listener. If null, any existing listener is removed. If not null and a listener is already registered, it will be replaced.
  - notifyChildren
```
public void notifyChildren(String eventName,
                           Object eventData,
                           boolean recurse)
```
    Allows a parent element to notify its children of an event of interest.
    
    Parameters:
    
    eventName - Name of the event.
    
    eventData - Data associated with the event.
    
    recurse - If true, recurse over all child levels.
  - listenToParent
```
protected void listenToParent(String eventName,
                              INotificationListener listener)
```
    Register/unregister a parent notification listener.
    
    Parameters:
    
    eventName - The event name.
    
    listener - A notification listener. If null, any existing listener is removed. If not null and a listener is already registered, it will be replaced.

Class ElementBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

Constructor Detail

ElementBase

Method Detail

registerAllowedParentClass

registerAllowedChildClass

canAcceptChild

canAcceptParent

addChild

addChild

afterAddChild

beforeAddChild

removeChild

afterRemoveChild

beforeRemoveChild

afterParentChanged

beforeParentChanged

remove

removeChildren

destroy

getDefinition

setDefinition

setDefinition

isDesignMode

setDesignMode

about

editProperties

getEventManager

getChild

getChild

getChildren

getChildren

getSerializableChildren

getChildCount

getChildCount

getFirstChild

getLastChild

indexOfChild

hasChild

findChildElement

hasAncestor

getIndex

moveChild

afterMoveChild

setIndex

getDisplayName

getInstanceName

getPropEditClass

isLocked

setLocked

getParent

setParent

setEnabled

isEnabled

moveChild

updateParentState

updateState

isContainer

canAcceptChild

canAcceptChild

canAcceptChild

canAcceptParent

canAcceptParent

canAcceptParent

setRejectReason

getRejectReason

getRoot

getAncestor

beforeInitialize

afterInitialize

notifyParent

listenToChild

notifyChildren

listenToParent