UIElementBase (CareWeb Framework Shell 4.0.5 API)

java.lang.Object
- org.carewebframework.shell.layout.UIElementBase

Direct Known Subclasses:

UIElementProxy, UIElementZKBase
```
public abstract class UIElementBase
extends Object
```
This is the base class for all UI elements supported by the CareWeb framework.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`autoEnable`
`protected boolean`	`autoHide`
`protected static org.apache.commons.logging.Log`	`log`
`protected int`	`maxChildren`

Constructor Summary

Constructors
Constructor and Description

UIElementBase()

Constructors
Constructor and Description
`UIElementBase()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`about()` Displays an about dialog for the UI element.
`void`	`activate(boolean activate)` Activates or inactivates a UI element.
`protected void`	`activateChildren(boolean activate)` Default behavior is to pass activation/inactivation event to children.
`void`	`addChild(UIElementBase child)` Adds the specified child element.
`protected void`	`addChild(UIElementBase child, boolean doEvent)` Adds the specified child element.
`protected void`	`afterAddChild(UIElementBase 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`	`afterMoveTo(int index)` Element has been moved to a different position under its parent.
`protected void`	`afterParentChanged(UIElementBase oldParent)` Called after the parent has been changed.
`protected void`	`afterRemoveChild(UIElementBase child)` Called after a child is logically removed from the parent.
`protected void`	`applyColor()` Provides a default implementation for setting the color of a UI element.
`protected void`	`applyColor(Object cmpt)` Applies the current color setting to the wrapped component.
`protected void`	`applyHint()` Provides a default implementation for setting the hint text of a UI element.
`protected void`	`applyHint(Object cmpt)` Applies the current hint text to the wrapped component.
`protected void`	`beforeAddChild(UIElementBase 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(UIElementBase newParent)` Called before the parent has been changed.
`protected void`	`beforeRemoveChild(UIElementBase child)` Called before a child is logically removed from the parent.
`protected void`	`bind()` Override to bind wrapped components to the UI.
`void`	`bringToFront()` Brings this element to the front of the user interface.
`boolean`	`canAcceptChild()` Returns true if this element may accept a child.
`boolean`	`canAcceptChild(Class<? extends UIElementBase> clazz)` Returns true if this element may accept a child of the specified class.
`static boolean`	`canAcceptChild(Class<? extends UIElementBase> parentClass, Class<? extends UIElementBase> childClass)` Returns true if childClass can be a child of the parentClass.
`boolean`	`canAcceptChild(UIElementBase 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 UIElementBase> clazz)` Returns true if this element may accept a parent of the specified class.
`static boolean`	`canAcceptParent(Class<? extends UIElementBase> childClass, Class<? extends UIElementBase> parentClass)` Returns true if parentClass can be a parent of childClass.
`boolean`	`canAcceptParent(UIElementBase 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()` Displays a property editor for the component.
`<T extends UIElementBase> T`	`findChildElement(Class<T> clazz)` Recurses the component subtree for a child belonging to the specified class.
`<T extends UIElementBase> T`	`getAncestor(Class<T> clazz)` Returns the first ancestor corresponding to the specified class.
`<T extends UIElementBase> T`	`getChild(Class<T> clazz, UIElementBase last)` Locates and returns a child that is an instance of the specified class.
`UIElementBase`	`getChild(int index)` Gets the UI element child at the specified index.
`int`	`getChildCount()` Returns the number of children.
`Iterable<UIElementBase>`	`getChildren()` Returns an iterable of this component's children.
`String`	`getColor()` Returns the color (as an HTML-formatted RGB string) for this element.
`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.
`UIElementBase`	`getFirstChild()` Returns the first child, or null if there are no children.
`UIElementBase`	`getFirstVisibleChild()` Returns the first visible child.
`String`	`getHint()` Returns the tool tip text.
`int`	`getIndex()` Returns this element's index in its parent's list of children.
`Object`	`getInnerComponent()` Returns the innermost wrapped UI component.
`String`	`getInstanceName()` Returns the instance name of this element.
`UIElementBase`	`getLastChild()` Returns the last child, or null if there are no children.
`UIElementBase`	`getLastVisibleChild()` Returns the last visible child.
`UIElementBase`	`getNextSibling(boolean visibleOnly)` Returns this element's next sibling.
`Object`	`getOuterComponent()` Returns the outermost wrapped UI component.
`UIElementBase`	`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.
`UIElementBase`	`getRoot()` Returns the UI element at the root of the component tree.
`Iterable<UIElementBase>`	`getSerializableChildren()` Returns an iterable of this component's serializable children.
`boolean`	`hasAncestor(UIElementBase element)` Returns true if specified element is an ancestor of this element.
`boolean`	`hasChild(UIElementBase element)` Returns true if the specified element is a child of this element.
`int`	`indexOfChild(UIElementBase child)` Returns the index of the specified child.
`boolean`	`isActivated()` Returns the activation status of the element.
`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.
`boolean`	`isVisible()` Returns the visible state of the UI element.
`static void`	`raise(String text)`
`static void`	`raise(String text, Throwable t)`
`protected static void`	`registerAllowedChildClass(Class<? extends UIElementBase> clazz, Class<? extends UIElementBase> childClass)` A UIElementBase subclass should call this in its static initializer block to register any subclasses that may be a child.
`protected static void`	`registerAllowedParentClass(Class<? extends UIElementBase> clazz, Class<? extends UIElementBase> parentClass)` A UIElementBase 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(UIElementBase child, boolean destroy)` Removes the specified element as a child of this parent.
`void`	`removeChildren()` Remove all children associated with this element.
`void`	`setColor(String value)` Provides a default implementation for setting the color of a ZK-based UI element.
`void`	`setDefinition(Class<? extends UIElementBase> 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`	`setHint(String value)` Sets the tool tip text.
`void`	`setIndex(int index)` Sets this element's index to the specified value.
`protected void`	`setInnerComponent(Object value)` Sets the innermost wrapped UI component.
`void`	`setLocked(boolean locked)` Sets the locked status of the element.
`protected void`	`setOuterComponent(Object value)` Sets the outermost wrapped UI component.
`void`	`setParent(UIElementBase 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.
`void`	`setVisible(boolean visible)` Sets the visibility state of the component.
`protected void`	`unbind()` Override to unbind wrapped components from the UI.
`protected void`	`updateParentState()` Calls updateState on the parent if one exists.
`protected void`	`updateState()` Update a UI element based on the state of its children.
`protected void`	`updateVisibility()` Calls updateVisibility with current settings.
`protected void`	`updateVisibility(boolean visible, boolean activated)` Override to set the visibility of wrapped components.

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
```
  - maxChildren
```
protected int maxChildren
```
  - autoHide
```
protected boolean autoHide
```
  - autoEnable
```
protected boolean autoEnable
```
- Constructor Detail
  - UIElementBase
```
public UIElementBase()
```
- Method Detail
  - registerAllowedParentClass
```
protected static void registerAllowedParentClass(Class<? extends UIElementBase> clazz,
                              Class<? extends UIElementBase> parentClass)
```
    A UIElementBase 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 UIElementBase> clazz,
                             Class<? extends UIElementBase> childClass)
```
    A UIElementBase 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.
  - canAcceptChild
```
public static boolean canAcceptChild(Class<? extends UIElementBase> parentClass,
                     Class<? extends UIElementBase> 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 UIElementBase> childClass,
                      Class<? extends UIElementBase> 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.
  - raise
```
public static void raise(String text,
         Throwable t)
                  throws UIException
```
    Throws:
    
    UIException
  - raise
```
public static void raise(String text)
                  throws UIException
```
    Throws:
    
    UIException
  - 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.
  - addChild
```
public void addChild(UIElementBase 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(UIElementBase 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(UIElementBase child)
```
    Called after a child is logically added to the parent.
    
    Parameters:
    child - The child element added.
  - beforeAddChild
```
protected void beforeAddChild(UIElementBase child)
```
    Called before a child is logically added to the parent.
    
    Parameters:
    child - The new child element.
  - removeChild
```
public void removeChild(UIElementBase 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(UIElementBase child)
```
    Called after a child is logically removed from the parent.
    
    Parameters:
    child - The child UI element.
  - beforeRemoveChild
```
protected void beforeRemoveChild(UIElementBase child)
```
    Called before a child is logically removed from the parent.
    
    Parameters:
    child - The child UI element.
  - afterParentChanged
```
protected void afterParentChanged(UIElementBase oldParent)
```
    Called after the parent has been changed.
    
    Parameters:
    oldParent - The value of the parent property prior to the change.
  - beforeParentChanged
```
protected void beforeParentChanged(UIElementBase 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 all children associated with this element.
  - destroy
```
public void destroy()
```
    Override to implement special cleanup when an object is destroyed.
  - bind
```
protected void bind()
```
    Override to bind wrapped components to the UI.
  - unbind
```
protected void unbind()
```
    Override to unbind wrapped components from the UI.
  - getInnerComponent
```
public Object getInnerComponent()
```
    Returns the innermost wrapped UI component. For UI elements that may host child elements, this would be the wrapped UI component that can host the child components. For UI elements that wrap a single UI component, getInnerComponent and getOuterComponent should return the same value.
    
    Returns:
    The inner component.
  - setInnerComponent
```
protected void setInnerComponent(Object value)
```
    Sets the innermost wrapped UI component.
    
    Parameters:
    value - The innermost wrapped UI component.
  - getOuterComponent
```
public Object getOuterComponent()
```
    Returns the outermost wrapped UI component. This represents the wrapped UI component that will be the direct child of the UI component wrapped by the parent element. For UI elements that wrap a single UI component, getInnerComponent and getOuterComponent should return the same value.
    
    Returns:
    The outer component.
  - setOuterComponent
```
protected void setOuterComponent(Object value)
```
    Sets the outermost wrapped UI component.
    
    Parameters:
    value - The outermost wrapped UI component.
  - afterMoveTo
```
protected void afterMoveTo(int index)
```
    Element has been moved to a different position under its parent. Descendant classes should make any necessary adjustments to wrapped components.
    
    Parameters:
    index - New position for element.
  - 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 UIElementBase> 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 UIElementProxy class) it is not.
    
    Parameters:
    clazz - The UI element class.
  - about
```
public void about()
```
    Displays an about dialog for the UI element.
  - editProperties
```
public void editProperties()
```
    Displays a property editor for the component. The default behavior is to display a message that no property editor is defined. Subclasses must override this to implement a property editor appropriate for the component.
  - activate
```
public void activate(boolean activate)
```
    Activates or inactivates a UI element. In general, this method should not be overridden to introduce new behavior. Rather, if a UI element must change its visual state in response to a change in activation state, it should override the updateVisibility method. If a UI element requires special activation logic for its children (e.g., if it allows only one child to be active at a time), it should override the activateChildren method.
    
    Parameters:
    activate - The activate status.
  - activateChildren
```
protected void activateChildren(boolean activate)
```
    Default behavior is to pass activation/inactivation event to children. Override to restrict propagation of the event.
    
    Parameters:
    activate - The activate status.
  - isActivated
```
public final boolean isActivated()
```
    Returns the activation status of the element.
    
    Returns:
    The activation status.
  - getEventManager
```
protected org.carewebframework.api.event.IEventManager getEventManager()
```
    Returns instance of the event manager.
    
    Returns:
    Event manager instance.
  - getChild
```
public UIElementBase 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 UIElementBase> T getChild(Class<T> clazz,
                                   UIElementBase last)
```
    Locates and returns a child that is an instance of the specified class. If none is found, returns null.
    
    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<UIElementBase> getChildren()
```
    Returns an iterable of this component's children.
    
    Returns:
    Iterable of this component's children.
  - getSerializableChildren
```
public Iterable<UIElementBase> 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.
  - getFirstChild
```
public UIElementBase getFirstChild()
```
    Returns the first child, or null if there are no children.
    
    Returns:
    First child, or null if none.
  - getFirstVisibleChild
```
public UIElementBase getFirstVisibleChild()
```
    Returns the first visible child.
    
    Returns:
    First visible child, or null if none;
  - getLastChild
```
public UIElementBase getLastChild()
```
    Returns the last child, or null if there are no children.
    
    Returns:
    Last child, or null if none.
  - getLastVisibleChild
```
public UIElementBase getLastVisibleChild()
```
    Returns the last visible child.
    
    Returns:
    Last visible child, or null if none;
  - getNextSibling
```
public UIElementBase getNextSibling(boolean visibleOnly)
```
    Returns this element's next sibling.
    
    Parameters:
    visibleOnly - If true, skip any non-visible siblings.
    
    Returns:
    The next sibling, or null if none.
  - indexOfChild
```
public int indexOfChild(UIElementBase 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(UIElementBase 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 UIElementBase> T findChildElement(Class<T> clazz)
```
    Recurses the component subtree for a child belonging to the specified class.
    
    Parameters:
    clazz - Class of child being sought.
    
    Returns:
    A child of the specified class, or null if not found.
  - hasAncestor
```
public boolean hasAncestor(UIElementBase 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.
  - 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.
  - bringToFront
```
public void bringToFront()
```
    Brings this element to the front of the user interface.
  - 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 UIElementBase getParent()
```
    Returns the parent of this element. May be null.
    
    Returns:
    This element's parent.
  - setParent
```
public final void setParent(UIElementBase 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.
  - setVisible
```
public final void setVisible(boolean visible)
```
    Sets the visibility 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 visibility state in their wrapped UI components.
    
    Parameters:
    visible - The visibility state.
  - updateVisibility
```
protected final void updateVisibility()
```
    Calls updateVisibility with current settings.
  - updateVisibility
```
protected void updateVisibility(boolean visible,
                    boolean activated)
```
    Override to set the visibility of wrapped components. Invoked when visibility or activation states change.
    
    Parameters:
    visible - The current visibility state.
    activated - The current activation state.
  - isVisible
```
public final boolean isVisible()
```
    Returns the visible state of the UI element.
    
    Returns:
    True if the UI element is visible.
  - getColor
```
public final String getColor()
```
    Returns the color (as an HTML-formatted RGB string) for this element.
    
    Returns:
    An HTML-formatted color specification (e.g., #0F134E). May be null.
  - setColor
```
public final void setColor(String value)
```
    Provides a default implementation for setting the color of a ZK-based UI element. This is provided to allow components to easily expose a color property in the property editor. It may not be appropriate for all subclasses. To change which ZK elements are affected, override the applyColor() method.
    
    Parameters:
    value - A correctly formatted HTML color specification.
  - applyColor
```
protected void applyColor()
```
    Provides a default implementation for setting the color of a UI element. Sets the color of the inner and outer components. Override to modify this default behavior.
  - applyColor
```
protected void applyColor(Object cmpt)
```
    Applies the current color setting to the wrapped component. Subclasses that support this capability should override this to supply the proper implementation.
    
    Parameters:
    cmpt - Component to receive the color setting.
  - getHint
```
public final String getHint()
```
    Returns the tool tip text.
    
    Returns:
    The tool tip text.
  - setHint
```
public final void setHint(String value)
```
    Sets the tool tip text.
    
    Parameters:
    value - The tool tip text.
  - applyHint
```
protected void applyHint()
```
    Provides a default implementation for setting the hint text of a UI element. Sets the hint text of the inner and outer components. Override to modify this default behavior.
  - applyHint
```
protected void applyHint(Object cmpt)
```
    Applies the current hint text to the wrapped component. Subclasses that support this capability should override this to supply the proper implementation.
    
    Parameters:
    cmpt - Component to receive the hint text.
  - updateParentState
```
protected final void updateParentState()
```
    Calls updateState on the parent if one exists.
  - updateState
```
protected void updateState()
```
    Update a UI element based on the state of its children. The default implementation acts on container elements only and has the following behavior:
    - If all children are disabled, the parent is also disabled (set autoEnable to false to turn off).
    - If all children are hidden or there are no children and design mode is not active, the parent is also hidden (set autoHide to false to turn off).
  - 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 UIElementBase> clazz)
```
    Returns true if this element may accept a child of the specified class. Updates the reject reason with the result.
    
    Parameters:
    clazz - Child class to test.
    
    Returns:
    True if this element may accept a child of the specified class.
  - canAcceptChild
```
public boolean canAcceptChild(UIElementBase 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 UIElementBase> 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(UIElementBase 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 UIElementBase getRoot()
```
    Returns the UI element at the root of the component tree.
    
    Returns:
    Root UI element.
  - getAncestor
```
public <T extends UIElementBase> T getAncestor(Class<T> clazz)
```
    Returns the first ancestor corresponding to the specified class.
    
    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.

Class UIElementBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

maxChildren

autoHide

autoEnable

Constructor Detail

UIElementBase

Method Detail

registerAllowedParentClass

registerAllowedChildClass

canAcceptChild

canAcceptParent

raise

raise

isDesignMode

setDesignMode

addChild

addChild

afterAddChild

beforeAddChild

removeChild

afterRemoveChild

beforeRemoveChild

afterParentChanged

beforeParentChanged

remove

removeChildren

destroy

bind

unbind

getInnerComponent

setInnerComponent

getOuterComponent

setOuterComponent

afterMoveTo

getDefinition

setDefinition

setDefinition

about

editProperties

activate

activateChildren

isActivated

getEventManager

getChild

getChild

getChildren

getSerializableChildren

getChildCount

getFirstChild

getFirstVisibleChild

getLastChild

getLastVisibleChild

getNextSibling

indexOfChild

hasChild

findChildElement

hasAncestor

getIndex

setIndex

bringToFront

getDisplayName

getInstanceName

getPropEditClass

isLocked

setLocked

getParent

setParent

setEnabled

isEnabled

setVisible

updateVisibility

updateVisibility

isVisible

getColor