BaseComponent (Fujion Core Libraries 2.0.0-RC1 API)

java.lang.Object
- org.fujion.component.BaseComponent

All Implemented Interfaces:

IElementIdentifier, IClientTransform

Direct Known Subclasses:

BasePickerItem, BaseSourcedComponent, BaseUIComponent, Content, Page, Popup, Snippet, Template, Timer
```
public abstract class BaseComponent
extends Object
implements IElementIdentifier
```
The abstract base class for all components.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BaseComponent.SubComponent
Reference to a subcomponent.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseComponent.SubComponent` Reference to a subcomponent.

Field Summary
- Fields inherited from interface org.fujion.ancillary.IElementIdentifier
  log

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseComponent()
Create a component.

Constructors
Modifier	Constructor and Description
`protected`	`BaseComponent()` Create a component.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_attach(Page page)` Attach this component and its children to their owning page.
`protected void`	`_initProps(Map<String,Object> props)` Initialize properties to be passed to widget factory.
`void`	`addChild(BaseComponent child)` Adds a child to the end of the child list.
`void`	`addChild(BaseComponent child, BaseComponent before)` Adds a child to the child list immediately before the reference child.
`void`	`addChild(BaseComponent child, int index)` Adds a child to the child list at the specified position.
`void`	`addChildren(Collection<? extends BaseComponent> children)` Adds a list of children.
`void`	`addEventForward(Class<? extends Event> eventClass, BaseComponent target)` Adds an event forward.
`void`	`addEventForward(Class<? extends Event> eventClass, BaseComponent target, String forwardType)` Adds an event forward.
`void`	`addEventForward(String eventType, BaseComponent target)` Adds an event forward.
`void`	`addEventForward(String eventType, BaseComponent target, String forwardType)` Adds an event forward.
`void`	`addEventListener(Class<? extends Event> eventClass, IEventListener eventListener)` Adds an event listener.
`void`	`addEventListener(Class<? extends Event> eventClass, IEventListener eventListener, boolean syncToClient)` Adds an event listener.
`void`	`addEventListener(String eventType, IEventListener eventListener)` Adds an event listener.
`void`	`addEventListener(String eventType, IEventListener eventListener, boolean syncToClient)` Adds an event listener.
`protected void`	`afterAddChild(BaseComponent child)` Called after a new child is added.
`protected void`	`afterRemoveChild(BaseComponent child)` Called after a child is removed.
`protected void`	`afterSetParent(BaseComponent oldParent)` Called after a new parent is set.
`protected boolean`	`areEqual(Object obj1, Object obj2)` Returns true if two objects are equal, allowing for null values.
`protected void`	`beforeAddChild(BaseComponent child)` Called before a new child is added.
`protected void`	`beforeRemoveChild(BaseComponent child)` Called before a child is removed.
`protected void`	`beforeSetParent(BaseComponent newParent)` Called before a new parent is set.
`void`	`bind(String propertyName, IBinding binding)` Convenience method for programmatically adding a binding.
`void`	`bringToFront()` Override to cause a UI component to be brought to the forefront of the UI.
`protected <T> T`	`defaultify(T value, T deflt)` Returns the input value if it is not null, or the default value otherwise.
`void`	`destroy()` Destroys this component.
`void`	`destroyChildren()` Destroy all children under this
`void`	`detach()` Removes, but does not destroy, this component from its parent.
`void`	`finalize()` Destroy a component and all its children upon finalization.
`Map<String,BaseComponent>`	`findAllNamed()` Returns a map of all named components in this namespace.
`Object`	`findAttribute(String name)` Finds the named attribute, returning its value.
`BaseComponent`	`findByName(String name)` Looks up a component by its name within the namespace occupied by this component.
`<T extends BaseComponent> T`	`findByName(String name, Class<T> type)` Looks up a component of the specified type by its name within the namespace occupied by this component.
`BaseComponent`	`findChildByData(Object data)` Find the first child containing the specified data object.
`BaseComponent`	`findChildByLabel(String label)` Find the first child whose label matches the specified value.
`void`	`fireEvent(Event event)` Send an event to this component's registered event listeners.
`void`	`fireEvent(String eventType)` Send an event to this component's registered event listeners.
`void`	`fireEventToClient(String eventType, IElementIdentifier target, Object data)` Send an event to the client.
`void`	`fireEventToClient(String eventType, Object data)` Send an event to the client.
`<T extends BaseComponent> T`	`getAncestor(Class<T> type)` Return first ancestor that is of the requested type.
`<T> T`	`getAncestor(Class<T> type, boolean includeSelf)` Return first ancestor that is of the requested type.
`Object`	`getAttribute(String name)` Returns the value of the named attribute.
`<T> T`	`getAttribute(String name, Class<T> type)` Returns the value of the named attribute, converted to the specified type.
`<T> T`	`getAttribute(String name, T dflt)` Returns the value of the named attribute, cast to the specified type.
`Map<String,Object>`	`getAttributes()` Returns the attribute map for this component.
`<T extends BaseComponent> T`	`getChild(Class<T> type)` Return the first child of the requested type.
`BaseComponent`	`getChildAt(int index)` Returns the child at the specified index.
`int`	`getChildCount()` Returns the number of children.
`int`	`getChildCount(Class<? extends BaseComponent> type)` Returns the count of children of a specified type.
`List<BaseComponent>`	`getChildren()` Returns an immutable list of existing children.
`<T extends BaseComponent> Iterable<T>`	`getChildren(Class<T> type)` Returns an iterable of children of the specified type.
`protected String`	`getContent()` Returns the text content associated with this component, if any.
`Object`	`getController()` Returns a reference to the last controller wired to this component.
`List<Object>`	`getControllers()` Returns an immutable list of controllers wired to this component.
`Object`	`getData()` Returns the data object associated with the component.
`<T> T`	`getData(Class<T> type)` Returns the data object associated with the component if it is of the specified type; otherwise returns null.
`ComponentDefinition`	`getDefinition()` Return the component's definition.
`BaseComponent`	`getFirstChild()` Returns the first child of this component.
`String`	`getId()` Returns the unique id of the client widget corresponding to this component.
`int`	`getIndex()` Returns the index of this child within its parent.
`BaseComponent`	`getLastChild()` Returns the last child of this component.
`String`	`getName()` Returns the name associated with this instance.
`BaseComponent`	`getNamespace()` Returns the namespace to which this component belongs.
`BaseComponent`	`getNextSibling()` Return the next sibling for this component.
`Page`	`getPage()` Returns the page to which this component belongs.
`BaseComponent`	`getParent()` Returns this component's parent, if any.
`BaseComponent`	`getPreviousSibling()` Return the previous sibling for this component.
`BaseComponent`	`getRoot()` Return the root component of this component's hierarchy.
`boolean`	`hasAttribute(String name)` Returns true if the named attribute exists.
`boolean`	`hasEventListener(Class<? extends Event> eventClass)` Returns true if this component has any listeners registered for the specified event type.
`boolean`	`hasEventListener(String eventType)` Returns true if this component has any listeners registered for the specified event type.
`void`	`invoke(IElementIdentifier id, String function, IResponseCallback<?> callback, Object... args)` Invoke a widget or sub-widget function on the client.
`void`	`invoke(IElementIdentifier id, String function, Object... args)` Invoke a widget or sub-widget function on the client.
`void`	`invoke(String function, IResponseCallback<?> callback, Object... args)` Invoke a widget function on the client.
`void`	`invoke(String function, Object... args)` Invoke a widget function on the client.
`void`	`invokeIfAttached(String function, Object... args)` Invoke a widget function on the client only if attached to a page.
`boolean`	`isAncestor(BaseComponent comp)` Returns true if this component is the same as or an ancestor of the specified component.
`boolean`	`isContainer()` Returns true if this component may contain children.
`protected boolean`	`isContentSynced()` Returns true if the content property is to be synced to the client.
`boolean`	`isDead()` Returns true if the component is dead (meaning its corresponding widget has been destroyed).
`boolean`	`isNamespace()` Returns true if this component is a namespace boundary.
`boolean`	`isRendered()` Returns true if the component has been rendered on the browser.
`void`	`notifyAncestors(Event event, boolean includeThis)` Send an event to all the ancestors of this component.
`void`	`notifyDescendants(Event event, boolean includeThis)` Send an event to all the descendants of this component using a depth-first traversal.
`protected String`	`nullify(String value)` Converts empty string to null.
`protected void`	`onAttach(Page page)` Called when this component is first attached to a page.
`protected void`	`onDestroy()` Override to perform any special cleanup operations when this component is destroyed.
`protected void`	`onDestroyTracked(BaseComponent comp)` Invoked when a tracked component is destroyed.
`protected boolean`	`propertyChange(String propertyName, Object oldValue, Object newValue, boolean syncToClient)` Handle changes to published properties.
`Object`	`removeAttribute(String name)` Removes the named attribute if it exists.
`void`	`removeChild(BaseComponent child)` Removes a child from this parent.
`void`	`removeEventForward(Class<? extends Event> eventClass, BaseComponent target)` Removes an event forward, if one exists.
`void`	`removeEventForward(Class<? extends Event> eventClass, BaseComponent target, String forwardType)` Removes an event forward, if one exists.
`void`	`removeEventForward(String eventType, BaseComponent target)` Removes an event forward, if one exists.
`void`	`removeEventForward(String eventType, BaseComponent target, String forwardType)` Removes an event forward, if one exists.
`void`	`removeEventListener(Class<? extends Event> eventClass, IEventListener eventListener)` Removes an event listener.
`void`	`removeEventListener(Class<? extends Event> eventClass, IEventListener eventListener, boolean syncToClient)` Removes an event listener.
`void`	`removeEventListener(String eventType, IEventListener eventListener)` Removes an event listener.
`void`	`removeEventListener(String eventType, IEventListener eventListener, boolean syncToClient)` Removes an event listener.
`Object`	`setAttribute(String name, Object value)` Sets the value of a named attribute.
`protected void`	`setContent(String content)` Sets the text content associated with this component.
`protected void`	`setContentSynced(boolean contentSynced)` Set to true if the content property is to be synced to the client.
`void`	`setData(Object data)` Sets the data object to be associated with the component.
`void`	`setIndex(int index)` Moves this child to the specified index within its parent.
`void`	`setName(String name)` Sets the name associated with this instance.
`void`	`setParent(BaseComponent parent)` Sets the component's parent.
`BaseComponent.SubComponent`	`sub(String subId)` Returns a subcomponent identifier.
`void`	`swapChildren(int index1, int index2)` Swap the position of two children.
`protected void`	`swapTrackedComponents(BaseComponent track, BaseComponent untrack)` Swap tracking from one component to another.
`protected void`	`sync(String state, Object value)` Synchronize a state value to the client.
`String`	`toString()` Returns basic information about this component for display purposes.
`protected void`	`trackComponent(BaseComponent comp)` Monitors a component for destroy events, invoking #onTrackedDestroy when detected.
`protected String`	`trimify(String value)` Trims whitespace from a string and nullifies it.
`protected void`	`untrackComponent(BaseComponent comp)` Removes tracking for a component.
`protected void`	`validate()` Validates that this component is not dead.
`protected static void`	`validate(BaseComponent comp)` Validates that a component still exists (i.e., is not dead).
`protected void`	`validateChild(BaseComponent child)` Validates that the specified component may be added as a child.
`protected void`	`validateIsChild(BaseComponent child)` Validates that the specified component is currently a child of this component.
`protected void`	`validatePage(Page page)` Validates that the specified page can be an owner of this component.
`protected void`	`validateParent(BaseComponent parent)` Validates that a component would a valid parent for this component.
`void`	`wireController(Object controller)` Wires a controller's annotated components and event handlers, in that order, using this component to resolve name references.

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

Methods inherited from interface org.fujion.ancillary.IElementIdentifier
transformForClient

- Constructor Detail
  - BaseComponent
```
protected BaseComponent()
```
    Create a component. Event handler annotations are processed at this time.
- Method Detail
  - validate
```
protected static void validate(BaseComponent comp)
```
    Validates that a component still exists (i.e., is not dead).
    
    Parameters:
    
    comp - Component to validate.
    
    Throws:
    
    ComponentException - Thrown upon validation failure.
  - getDefinition
```
public ComponentDefinition getDefinition()
```
    Return the component's definition.
    
    Returns:
    
    The component's definition.
  - getName
```
@Component.PropertyGetter(value="name",
                          description="The name associated with this component instance (must be unique within the enclosing namespace).")
public String getName()
```
    Returns the name associated with this instance. Names must be unique within the enclosing namespace.
    
    Returns:
    
    The component's name.
  - setName
```
@Component.PropertySetter(value="name",
                          description="The name associated with this component instance (must be unique within the enclosing namespace).")
public void setName(String name)
```
    Sets the name associated with this instance. Names must be unique within the enclosing namespace.
    
    Parameters:
    
    name - The component's name.
  - getId
```
@Component.PropertyGetter(value="id",
                          description="The unique id of the client widget corresponding to this component.")
public String getId()
```
    Returns the unique id of the client widget corresponding to this component.
    
    Specified by:
    
    getId in interface IElementIdentifier
    
    Returns:
    
    HTML element unique identifier.
    
    See Also:
    
    IElementIdentifier.getId()
  - detach
```
public void detach()
```
    Removes, but does not destroy, this component from its parent.
  - destroy
```
public void destroy()
```
    Destroys this component.
  - finalize
```
public void finalize()
              throws Throwable
```
    Destroy a component and all its children upon finalization.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
    
    See Also:
    
    Object.finalize()
  - destroyChildren
```
public void destroyChildren()
```
    Destroy all children under this
  - onDestroy
```
protected void onDestroy()
```
    Override to perform any special cleanup operations when this component is destroyed.
  - isDead
```
public boolean isDead()
```
    Returns true if the component is dead (meaning its corresponding widget has been destroyed). Any operation on a dead component that would cause a client invocation will fail.
    
    Returns:
    
    True if the component is dead.
  - isRendered
```
public boolean isRendered()
```
    Returns true if the component has been rendered on the browser. A component is considered rendered if it belongs to a rendered page.
    
    Returns:
    
    True if the component has been rendered on the browser.
  - validate
```
protected void validate()
```
    Validates that this component is not dead.
    
    Throws:
    
    ComponentException - Thrown if validation fails.
  - getParent
```
public BaseComponent getParent()
```
    Returns this component's parent, if any.
    
    Returns:
    
    The parent, or null if there is no parent.
  - validateParent
```
protected void validateParent(BaseComponent parent)
```
    Validates that a component would a valid parent for this component.
    
    Parameters:
    
    parent - Component to validate.
    
    Throws:
    
    ComponentException - Thrown if the new parent is not a valid parent for this component.
  - setParent
```
public void setParent(BaseComponent parent)
```
    Sets the component's parent.
    
    Parameters:
    
    parent - The new parent.
    
    Throws:
    
    ComponentException - Thrown if the new parent is not a valid parent for this component.
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    Returns the attribute map for this component.
    
    Returns:
    
    The attribute map.
  - getAttribute
```
public Object getAttribute(String name)
```
    Returns the value of the named attribute.
    
    Parameters:
    
    name - The attribute name.
    
    Returns:
    
    The named attribute's value (or null if not found).
  - getAttribute
```
public <T> T getAttribute(String name,
                          T dflt)
```
    Returns the value of the named attribute, cast to the specified type.
    Type Parameters:
    
    T - The attribute value's expected type.
    
    Parameters:
    
    name - The attribute name.
    dflt - The default attribute value. This will be returned under one of the following conditions:
    
    The named attribute does not exist
    
    The named attribute value is null
    
    The named attribute value cannot be cast to the specified type
    Returns:
    
    The value of the named attribute, or the default value.
  - getAttribute
```
public <T> T getAttribute(String name,
                          Class<T> type)
```
    Returns the value of the named attribute, converted to the specified type.
    
    Type Parameters:
    
    T - The return type.
    
    Parameters:
    
    name - The attribute name.
    
    type - The return type for the attribute value.
    
    Returns:
    
    The value of the named attribute, or null if the existing value cannot be converted to the specified type.
  - findAttribute
```
public Object findAttribute(String name)
```
    Finds the named attribute, returning its value. If the named attribute does not exist or has a null value, the parent chain will be searched until a match is found.
    
    Parameters:
    
    name - The attribute name.
    
    Returns:
    
    The attribute value, or null if not found.
  - setAttribute
```
@Component.PropertySetter(value="attr:")
public Object setAttribute(String name,
                                                                    Object value)
```
    Sets the value of a named attribute.
    
    Parameters:
    
    name - The attribute name.
    
    value - The new value.
    
    Returns:
    
    The previous value of the named attribute, if any.
  - removeAttribute
```
public Object removeAttribute(String name)
```
    Removes the named attribute if it exists.
    
    Parameters:
    
    name - The attribute name.
    
    Returns:
    
    The value of the removed attribute.
  - hasAttribute
```
public boolean hasAttribute(String name)
```
    Returns true if the named attribute exists.
    
    Parameters:
    
    name - The attribute name.
    
    Returns:
    
    True if the named attribute exists.
  - validateIsChild
```
protected void validateIsChild(BaseComponent child)
```
    Validates that the specified component is currently a child of this component.
    
    Parameters:
    
    child - The component to check.
    
    Throws:
    
    ComponentException - Thrown if the component fails validation.
  - validateChild
```
protected void validateChild(BaseComponent child)
```
    Validates that the specified component may be added as a child.
    
    Parameters:
    
    child - The component to check.
    
    Throws:
    
    ComponentException - Thrown if the component fails validation.
  - addChild
```
public void addChild(BaseComponent child)
```
    Adds a child to the end of the child list.
    
    Parameters:
    
    child - Child to add.
  - addChild
```
public void addChild(BaseComponent child,
                     int index)
```
    Adds a child to the child list at the specified position.
    
    Parameters:
    
    child - Child to add.
    
    index - The position in the child list where the new child will be inserted.
  - addChild
```
public void addChild(BaseComponent child,
                     BaseComponent before)
```
    Adds a child to the child list immediately before the reference child.
    
    Parameters:
    
    child - Child to add.
    
    before - The reference child.
  - addChildren
```
public void addChildren(Collection<? extends BaseComponent> children)
```
    Adds a list of children.
    
    Parameters:
    
    children - List of children to add.
  - removeChild
```
public void removeChild(BaseComponent child)
```
    Removes a child from this parent.
    
    Parameters:
    
    child - Child to remove.
  - swapChildren
```
public void swapChildren(int index1,
                         int index2)
```
    Swap the position of two children.
    
    Parameters:
    
    index1 - Index of the first child.
    
    index2 - Index of the second child.
  - beforeSetParent
```
protected void beforeSetParent(BaseComponent newParent)
```
    Called before a new parent is set.
    
    Parameters:
    
    newParent - The new parent.
  - afterSetParent
```
protected void afterSetParent(BaseComponent oldParent)
```
    Called after a new parent is set.
    
    Parameters:
    
    oldParent - The old parent.
  - beforeAddChild
```
protected void beforeAddChild(BaseComponent child)
```
    Called before a new child is added.
    
    Parameters:
    
    child - The new child.
  - afterAddChild
```
protected void afterAddChild(BaseComponent child)
```
    Called after a new child is added.
    
    Parameters:
    
    child - The new child.
  - beforeRemoveChild
```
protected void beforeRemoveChild(BaseComponent child)
```
    Called before a child is removed.
    
    Parameters:
    
    child - The child to be removed.
  - afterRemoveChild
```
protected void afterRemoveChild(BaseComponent child)
```
    Called after a child is removed.
    
    Parameters:
    
    child - The removed child.
  - getChildren
```
public List<BaseComponent> getChildren()
```
    Returns an immutable list of existing children.
    
    Returns:
    
    List of existing children.
  - getChildren
```
public <T extends BaseComponent> Iterable<T> getChildren(Class<T> type)
```
    Returns an iterable of children of the specified type.
    
    Type Parameters:
    
    T - The desired type.
    
    Parameters:
    
    type - The desired type.
    
    Returns:
    
    An iterable of children of the specified type. Never null.
  - getChildCount
```
public int getChildCount()
```
    Returns the number of children.
    
    Returns:
    
    The number of children.
  - getChildCount
```
public int getChildCount(Class<? extends BaseComponent> type)
```
    Returns the count of children of a specified type.
    
    Parameters:
    
    type - The desired type.
    
    Returns:
    
    Count of children of the specified type.
  - isContainer
```
public boolean isContainer()
```
    Returns true if this component may contain children.
    
    Returns:
    
    True if this component may contain children.
  - getChild
```
public <T extends BaseComponent> T getChild(Class<T> type)
```
    Return the first child of the requested type.
    
    Type Parameters:
    
    T - The type of child sought.
    
    Parameters:
    
    type - The type of child sought.
    
    Returns:
    
    The requested child, or null if none exist of the requested type.
  - getChildAt
```
public BaseComponent getChildAt(int index)
```
    Returns the child at the specified index. If the index is out of bounds, returns null.
    
    Parameters:
    
    index - The index of the child sought.
    
    Returns:
    
    Child at the specified index or null if the index is out of bounds.
  - getFirstChild
```
public BaseComponent getFirstChild()
```
    Returns the first child of this component.
    
    Returns:
    
    The first child, or null if no children.
  - getLastChild
```
public BaseComponent getLastChild()
```
    Returns the last child of this component.
    
    Returns:
    
    The last child, or null if no children.
  - getRoot
```
public BaseComponent getRoot()
```
    Return the root component of this component's hierarchy.
    
    Returns:
    
    The root component of the hierarchy to which this component belongs.
  - getAncestor
```
public <T extends BaseComponent> T getAncestor(Class<T> type)
```
    Return first ancestor that is of the requested type.
    
    Type Parameters:
    
    T - The type of ancestor sought.
    
    Parameters:
    
    type - The type of ancestor sought.
    
    Returns:
    
    The ancestor component of the requested type, or null if none found.
  - getAncestor
```
public <T> T getAncestor(Class<T> type,
                         boolean includeSelf)
```
    Return first ancestor that is of the requested type.
    
    Type Parameters:
    
    T - Expected return type.
    
    Parameters:
    
    type - The type of ancestor sought.
    
    includeSelf - If true, include this component in the search.
    
    Returns:
    
    The ancestor component of the requested type, or null if none found.
  - isAncestor
```
public boolean isAncestor(BaseComponent comp)
```
    Returns true if this component is the same as or an ancestor of the specified component.
    
    Parameters:
    
    comp - Component to test.
    
    Returns:
    
    True if this component is the same as or an ancestor of the specified component.
  - getIndex
```
public int getIndex()
```
    Returns the index of this child within its parent.
    
    Returns:
    
    Index of this child within its parent. If the component has not parent, returns -1.
  - setIndex
```
public void setIndex(int index)
```
    Moves this child to the specified index within its parent.
    
    Parameters:
    
    index - New index for this child.
  - getNextSibling
```
public BaseComponent getNextSibling()
```
    Return the next sibling for this component.
    
    Returns:
    
    The requested sibling, or null if not found.
  - getPreviousSibling
```
public BaseComponent getPreviousSibling()
```
    Return the previous sibling for this component.
    
    Returns:
    
    The requested sibling, or null if not found.
  - getNamespace
```
public BaseComponent getNamespace()
```
    Returns the namespace to which this component belongs. May be null.
    
    Returns:
    
    The namespace to which this component belongs.
  - isNamespace
```
@Component.PropertyGetter(value="namespace",
                          bindable=false,
                          description="When true, this component acts as a namespace boundary.")
public boolean isNamespace()
```
    Returns true if this component is a namespace boundary.
    
    Returns:
    
    True if this component is a namespace boundary.
  - getPage
```
public Page getPage()
```
    Returns the page to which this component belongs.
    
    Returns:
    
    The owning page (may be null).
  - onAttach
```
protected void onAttach(Page page)
```
    Called when this component is first attached to a page.
    
    Parameters:
    
    page - The attached page.
  - validatePage
```
protected void validatePage(Page page)
```
    Validates that the specified page can be an owner of this component.
    
    Parameters:
    
    page - The page to be tested.
    
    Throws:
    
    ComponentException - If fails validation.
  - _attach
```
protected void _attach(Page page)
```
    Attach this component and its children to their owning page.
    
    Parameters:
    
    page - Page to receive this component.
  - _initProps
```
protected void _initProps(Map<String,Object> props)
```
    Initialize properties to be passed to widget factory. Override to add additional properties.
    
    Parameters:
    
    props - Properties for widget factory.
  - sync
```
protected void sync(String state,
                    Object value)
```
    Synchronize a state value to the client.
    
    Parameters:
    
    state - The state name.
    
    value - The state value.
  - invoke
```
public void invoke(String function,
                   Object... args)
```
    Invoke a widget function on the client.
    
    Parameters:
    
    function - The name of the function.
    
    args - Arguments for the function.
  - invoke
```
public void invoke(String function,
                   IResponseCallback<?> callback,
                   Object... args)
```
    Invoke a widget function on the client.
    
    Parameters:
    
    function - The name of the function.
    
    callback - Optional callback for invocation result.
    
    args - Arguments for the function.
  - invokeIfAttached
```
public void invokeIfAttached(String function,
                             Object... args)
```
    Invoke a widget function on the client only if attached to a page.
    
    Parameters:
    
    function - The name of the function.
    
    args - Arguments for the function.
  - invoke
```
public void invoke(IElementIdentifier id,
                   String function,
                   IResponseCallback<?> callback,
                   Object... args)
```
    Invoke a widget or sub-widget function on the client.
    
    Parameters:
    
    id - The id of the widget or sub-widget.
    
    function - The name of the function.
    
    callback - Optional callback for invocation result.
    
    args - Arguments for the function.
  - invoke
```
public void invoke(IElementIdentifier id,
                   String function,
                   Object... args)
```
    Invoke a widget or sub-widget function on the client.
    
    Parameters:
    
    id - The id of the widget or sub-widget.
    
    function - The name of the function.
    
    args - Arguments for the function.
  - findByName
```
public BaseComponent findByName(String name)
```
    Looks up a component by its name within the namespace occupied by this component.
    
    Parameters:
    
    name - Component name or "/"-delimited path. "^" in path means parent namespace.
    
    Returns:
    
    The component sought, or null if not found.
  - findAllNamed
```
public Map<String,BaseComponent> findAllNamed()
```
    Returns a map of all named components in this namespace.
    
    Returns:
    
    A map of all named components in this namespace.
  - findByName
```
public <T extends BaseComponent> T findByName(String name,
                                              Class<T> type)
```
    Looks up a component of the specified type by its name within the namespace occupied by this component.
    
    Type Parameters:
    
    T - The expected return type.
    
    Parameters:
    
    name - Component name or path.
    
    type - Expected return type.
    
    Returns:
    
    The component sought, or null if not found.
  - findChildByData
```
public BaseComponent findChildByData(Object data)
```
    Find the first child containing the specified data object.
    
    Parameters:
    
    data - The data object to find.
    
    Returns:
    
    The child with the data object, or null if not found.
  - findChildByLabel
```
public BaseComponent findChildByLabel(String label)
```
    Find the first child whose label matches the specified value. This will only examine children that implement the ILabeled interface.
    
    Parameters:
    
    label - The label to find.
    
    Returns:
    
    The first child whose label matches, or null if none found.
  - sub
```
public BaseComponent.SubComponent sub(String subId)
```
    Returns a subcomponent identifier.
    
    Parameters:
    
    subId - The sub identifier.
    
    Returns:
    
    A subcomponent object.
  - addEventForward
```
public void addEventForward(String eventType,
                            BaseComponent target)
```
    Adds an event forward. An event forward forwards an event of the specified type received by this component to another component.
    
    Parameters:
    
    eventType - The event type to forward.
    
    target - The target for the forwarded event.
  - addEventForward
```
public void addEventForward(String eventType,
                            BaseComponent target,
                            String forwardType)
```
    Adds an event forward. An event forward forwards an event of the specified type received by this component to another component, optionally with a different event type.
    
    Parameters:
    
    eventType - The event type to forward.
    
    target - The target for the forwarded event.
    
    forwardType - The type of the forwarded event. If null, the original event type is used.
  - addEventForward
```
public void addEventForward(Class<? extends Event> eventClass,
                            BaseComponent target)
```
    Adds an event forward. An event forward forwards an event of the specified type received by this component to another component.
    
    Parameters:
    
    eventClass - The event type to forward.
    
    target - The target for the forwarded event.
  - addEventForward
```
public void addEventForward(Class<? extends Event> eventClass,
                            BaseComponent target,
                            String forwardType)
```
    Adds an event forward. An event forward forwards an event of the specified type received by this component to another component, optionally with a different event type.
    
    Parameters:
    
    eventClass - The event type to forward.
    
    target - The target for the forwarded event.
    
    forwardType - The type of the forwarded event. If null, the original event type is used.
  - removeEventForward
```
public void removeEventForward(String eventType,
                               BaseComponent target)
```
    Removes an event forward, if one exists.
    
    Parameters:
    
    eventType - The source event type.
    
    target - The forwarded event target.
  - removeEventForward
```
public void removeEventForward(String eventType,
                               BaseComponent target,
                               String forwardType)
```
    Removes an event forward, if one exists.
    
    Parameters:
    
    eventType - The source event type.
    
    target - The forwarded event target.
    
    forwardType - The forwarded event type. If null, the source event type is used.
  - removeEventForward
```
public void removeEventForward(Class<? extends Event> eventClass,
                               BaseComponent target)
```
    Removes an event forward, if one exists.
    
    Parameters:
    
    eventClass - The source event type.
    
    target - The forwarded event target.
  - removeEventForward
```
public void removeEventForward(Class<? extends Event> eventClass,
                               BaseComponent target,
                               String forwardType)
```
    Removes an event forward, if one exists.
    
    Parameters:
    
    eventClass - The source event type.
    
    target - The forwarded event target.
    
    forwardType - The forwarded event type. If null, the source event type is used.
  - hasEventListener
```
public boolean hasEventListener(String eventType)
```
    Returns true if this component has any listeners registered for the specified event type.
    
    Parameters:
    
    eventType - The event type.
    
    Returns:
    
    True if any registered listeners exist.
  - hasEventListener
```
public boolean hasEventListener(Class<? extends Event> eventClass)
```
    Returns true if this component has any listeners registered for the specified event type.
    
    Parameters:
    
    eventClass - The event type.
    
    Returns:
    
    True if any registered listeners exist.
  - addEventListener
```
public void addEventListener(String eventType,
                             IEventListener eventListener)
```
    Adds an event listener.
    
    Parameters:
    
    eventType - The type of event to listen for.
    
    eventListener - The listener for the event.
  - addEventListener
```
public void addEventListener(Class<? extends Event> eventClass,
                             IEventListener eventListener)
```
    Adds an event listener.
    
    Parameters:
    
    eventClass - The type of event to listen for.
    
    eventListener - The listener for the event.
  - addEventListener
```
public void addEventListener(String eventType,
                             IEventListener eventListener,
                             boolean syncToClient)
```
    Adds an event listener.
    
    Parameters:
    
    eventType - The type of event to listen for.
    
    eventListener - The listener for the event.
    
    syncToClient - If true, notify the client that a listener has been added. The client will normally not send events to the server unless it knows that a listener exists.
  - addEventListener
```
public void addEventListener(Class<? extends Event> eventClass,
                             IEventListener eventListener,
                             boolean syncToClient)
```
    Adds an event listener.
    
    Parameters:
    
    eventClass - The type of event to listen for.
    
    eventListener - The listener for the event.
    
    syncToClient - If true, notify the client that a listener has been added. The client will normally not send events to the server unless it knows that a listener exists.
  - removeEventListener
```
public void removeEventListener(String eventType,
                                IEventListener eventListener)
```
    Removes an event listener.
    
    Parameters:
    
    eventType - The type of event listened for.
    
    eventListener - The listener for the event.
  - removeEventListener
```
public void removeEventListener(Class<? extends Event> eventClass,
                                IEventListener eventListener)
```
    Removes an event listener.
    
    Parameters:
    
    eventClass - The type of event listened for.
    
    eventListener - The listener for the event.
  - removeEventListener
```
public void removeEventListener(String eventType,
                                IEventListener eventListener,
                                boolean syncToClient)
```
    Removes an event listener.
    
    Parameters:
    
    eventType - The type of event listened for.
    
    eventListener - The listener for the event.
    
    syncToClient - If true, notify the client that a listener has been added. The client will normally not send events to the server unless it knows that a listener exists.
  - removeEventListener
```
public void removeEventListener(Class<? extends Event> eventClass,
                                IEventListener eventListener,
                                boolean syncToClient)
```
    Removes an event listener.
    
    Parameters:
    
    eventClass - The type of event listened for.
    
    eventListener - The listener for the event.
    
    syncToClient - If true, notify the client that a listener has been added. The client will normally not send events to the server unless it knows that a listener exists.
  - fireEvent
```
public void fireEvent(String eventType)
```
    Send an event to this component's registered event listeners.
    
    Parameters:
    
    eventType - Type of event to send.
  - fireEvent
```
public void fireEvent(Event event)
```
    Send an event to this component's registered event listeners.
    
    Parameters:
    
    event - Event to send.
  - fireEventToClient
```
public void fireEventToClient(String eventType,
                              Object data)
```
    Send an event to the client.
    
    Parameters:
    
    eventType - The event type.
    
    data - The event payload.
  - fireEventToClient
```
public void fireEventToClient(String eventType,
                              IElementIdentifier target,
                              Object data)
```
    Send an event to the client.
    
    Parameters:
    
    eventType - The event type.
    
    target - The event target.
    
    data - The event payload.
  - notifyAncestors
```
public void notifyAncestors(Event event,
                            boolean includeThis)
```
    Send an event to all the ancestors of this component. Event propagation stops if any recipient invokes the stopPropagation method on the event.
    
    Parameters:
    
    event - Event to send.
    
    includeThis - If true, include this component in the recipient chain.
  - notifyDescendants
```
public void notifyDescendants(Event event,
                              boolean includeThis)
```
    Send an event to all the descendants of this component using a depth-first traversal. Event propagation stops if any recipient invokes the stopPropagation method on the event.
    
    Parameters:
    
    event - Event to send.
    
    includeThis - If true, include this component in the recipient chain.
  - wireController
```
@Component.PropertySetter(value="controller",
                          bindable=false,
                          defer=true,
                          description="Controller to be wired to this component.")
public void wireController(Object controller)
```
    Wires a controller's annotated components and event handlers, in that order, using this component to resolve name references.
    Parameters:
    controller - The controller to wire. The following values are recognized:
    
    self - Controller is the component itself.
    
    <String> - Name of the class from which a controller instance will be created.
    
    <Class> - The class from which a controller instance will be created.
    
    All other - The controller instance to be wired.
  - getControllers
```
public List<Object> getControllers()
```
    Returns an immutable list of controllers wired to this component.
    
    Returns:
    
    List of controllers wired to this component (never null).
  - getController
```
public Object getController()
```
    Returns a reference to the last controller wired to this component.
    
    Returns:
    
    The last controller wired to this component, or null if none.
  - bringToFront
```
public void bringToFront()
```
    Override to cause a UI component to be brought to the forefront of the UI.
  - nullify
```
protected String nullify(String value)
```
    Converts empty string to null.
    
    Parameters:
    
    value - String value.
    
    Returns:
    
    Original value or null if empty string.
  - trimify
```
protected String trimify(String value)
```
    Trims whitespace from a string and nullifies it.
    
    Parameters:
    
    value - String value.
    
    Returns:
    
    Trimmed and nullified value.
  - defaultify
```
protected <T> T defaultify(T value,
                           T deflt)
```
    Returns the input value if it is not null, or the default value otherwise.
    
    Type Parameters:
    
    T - The argument class.
    
    Parameters:
    
    value - The input value.
    
    deflt - The default value.
    
    Returns:
    
    Original value or the default if the input value was null.
  - areEqual
```
protected boolean areEqual(Object obj1,
                           Object obj2)
```
    Returns true if two objects are equal, allowing for null values.
    
    Parameters:
    
    obj1 - First object to compare.
    
    obj2 - Second object to compare.
    
    Returns:
    
    True if the objects are equal.
  - getData
```
@Component.PropertyGetter(value="data",
                          description="Data object to associate with this component.")
public Object getData()
```
    Returns the data object associated with the component.
    
    Returns:
    
    The data object; may be null.
  - getData
```
public <T> T getData(Class<T> type)
```
    Returns the data object associated with the component if it is of the specified type; otherwise returns null.
    
    Type Parameters:
    
    T - Expected return type.
    
    Parameters:
    
    type - The expected type.
    
    Returns:
    
    The data object if it is of the expected type; null otherwise.
  - setData
```
@Component.PropertySetter(value="data",
                          description="Data object to associate with this component.")
public void setData(Object data)
```
    Sets the data object to be associated with the component.
    
    Parameters:
    
    data - The data object.
  - getContent
```
@Component.PropertyGetter(value="#text")
protected String getContent()
```
    Returns the text content associated with this component, if any.
    
    Returns:
    
    The text content.
  - setContent
```
@Component.PropertySetter(value="#text")
protected void setContent(String content)
```
    Sets the text content associated with this component.
    
    Parameters:
    
    content - The text content.
  - isContentSynced
```
protected boolean isContentSynced()
```
    Returns true if the content property is to be synced to the client.
    
    Returns:
    
    True if the content property is to be synced to the client.
  - setContentSynced
```
protected void setContentSynced(boolean contentSynced)
```
    Set to true if the content property is to be synced to the client.
    
    Parameters:
    
    contentSynced - If true, the content property is synced to the client.
  - propertyChange
```
protected boolean propertyChange(String propertyName,
                                 Object oldValue,
                                 Object newValue,
                                 boolean syncToClient)
```
    Handle changes to published properties. If the old and new values are the same, no action is taken. Otherwise, the client is notified of the new value (if syncToClient is true) and a PropertychangeEvent is fired.
    
    Parameters:
    
    propertyName - The property name.
    
    oldValue - The old value.
    
    newValue - The new value.
    
    syncToClient - If true, notify client of change.
    
    Returns:
    
    True if property value changed.
  - bind
```
public void bind(String propertyName,
                 IBinding binding)
```
    Convenience method for programmatically adding a binding.
    
    Parameters:
    
    propertyName - Name of property in this component to be bound.
    
    binding - The binding to apply.
  - trackComponent
```
protected void trackComponent(BaseComponent comp)
```
    Monitors a component for destroy events, invoking #onTrackedDestroy when detected.
    
    Parameters:
    
    comp - Component to track.
  - untrackComponent
```
protected void untrackComponent(BaseComponent comp)
```
    Removes tracking for a component.
    
    Parameters:
    
    comp - Component to untrack.
  - swapTrackedComponents
```
protected void swapTrackedComponents(BaseComponent track,
                                     BaseComponent untrack)
```
    Swap tracking from one component to another. This is a convenience method for calling trackComponent(org.fujion.component.BaseComponent) and untrackComponent(org.fujion.component.BaseComponent) in succession.
    
    Parameters:
    
    track - Component to track.
    
    untrack - Component to untrack.
  - onDestroyTracked
```
protected void onDestroyTracked(BaseComponent comp)
```
    Invoked when a tracked component is destroyed. Override to provide special handling.
    
    Parameters:
    
    comp - The tracked component.
  - toString
```
public String toString()
```
    Returns basic information about this component for display purposes.
    
    Overrides:
    
    toString in class Object

Class BaseComponent

Nested Class Summary

Field Summary

Fields inherited from interface org.fujion.ancillary.IElementIdentifier

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.fujion.ancillary.IElementIdentifier

Constructor Detail

BaseComponent

Method Detail

validate

getDefinition

getName

setName

getId

detach

destroy

finalize

destroyChildren

onDestroy

isDead

isRendered

validate

getParent

validateParent

setParent

getAttributes

getAttribute

getAttribute

getAttribute

findAttribute

setAttribute

removeAttribute

hasAttribute

validateIsChild

validateChild

addChild

addChild

addChild

addChildren

removeChild

swapChildren

beforeSetParent

afterSetParent

beforeAddChild

afterAddChild

beforeRemoveChild

afterRemoveChild

getChildren

getChildren

getChildCount

getChildCount

isContainer

getChild

getChildAt

getFirstChild

getLastChild

getRoot

getAncestor

getAncestor

isAncestor

getIndex

setIndex

getNextSibling

getPreviousSibling

getNamespace

isNamespace

getPage

onAttach

validatePage

_attach

_initProps

sync

invoke

invoke

invokeIfAttached

invoke

invoke

findByName