BaseComponent (Fujion Core Libraries 1.0.1 API)

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

All Implemented Interfaces:

IElementIdentifier

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.

Constructor Summary

Constructors
Constructor and Description

BaseComponent()

Constructors
Constructor and Description
`BaseComponent()`

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)`
`void`	`addChild(BaseComponent child, BaseComponent before)`
`void`	`addChild(BaseComponent child, int index)`
`void`	`addChildren(Collection<? extends BaseComponent> children)`
`void`	`addEventForward(Class<? extends Event> eventClass, BaseComponent target, String forwardType)`
`void`	`addEventForward(String eventType, BaseComponent target, String forwardType)`
`void`	`addEventListener(Class<? extends Event> eventClass, IEventListener eventListener)`
`void`	`addEventListener(Class<? extends Event> eventClass, IEventListener eventListener, boolean syncToClient)`
`void`	`addEventListener(String eventType, IEventListener eventListener)`
`void`	`addEventListener(String eventType, IEventListener eventListener, boolean syncToClient)`
`protected void`	`afterAddChild(BaseComponent child)`
`protected void`	`afterRemoveChild(BaseComponent child)`
`protected void`	`afterSetParent(BaseComponent oldParent)`
`protected boolean`	`areEqual(Object obj1, Object obj2)` Returns true if two objects are equal, allowing for null values.
`protected void`	`beforeAddChild(BaseComponent child)`
`protected void`	`beforeRemoveChild(BaseComponent child)`
`protected void`	`beforeSetParent(BaseComponent newParent)`
`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()`
`void`	`destroyChildren()`
`void`	`detach()`
`void`	`finalize()`
`Object`	`findAttribute(String name)`
`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)`
`<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)`
`<T> T`	`getAttribute(String name, Class<T> clazz)`
`<T> T`	`getAttribute(String name, T dflt)`
`Map<String,Object>`	`getAttributes()`
`<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)`
`List<BaseComponent>`	`getChildren()`
`<T extends BaseComponent> Iterable<T>`	`getChildren(Class<T> type)`
`protected String`	`getContent()`
`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()`
`BaseComponent`	`getFirstChild()` Returns the first child of this component.
`String`	`getId()`
`int`	`getIndex()` Returns the index of this child within its parent.
`BaseComponent`	`getLastChild()` Returns the last child of this component.
`String`	`getName()`
`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()`
`BaseComponent`	`getPreviousSibling()` Return the previous sibling for this component.
`BaseComponent`	`getRoot()` Return the root component of this component's hierarchy.
`boolean`	`hasAttribute(String name)`
`boolean`	`hasEventListener(Class<? extends Event> eventClass)`
`boolean`	`hasEventListener(String eventType)`
`void`	`invoke(IElementIdentifier id, String function, Object... args)` Invoke a widget or sub-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()`
`boolean`	`isNamespace()` Returns true if this component is a namespace boundary.
`void`	`notifyAncestors(Event event, boolean includeThis)` Send an event to all the ancestors of this component.
`protected String`	`nullify(String value)` Converts empty string to null.
`protected void`	`onAttach(Page page)`
`protected void`	`onDestroy()`
`Object`	`removeAttribute(String name)`
`void`	`removeChild(BaseComponent child)`
`void`	`removeEventForward(Class<? extends Event> eventClass, BaseComponent target, String forwardType)`
`void`	`removeEventForward(String eventType, BaseComponent target, String forwardType)`
`void`	`removeEventListener(Class<? extends Event> eventClass, IEventListener eventListener)`
`void`	`removeEventListener(Class<? extends Event> eventClass, IEventListener eventListener, boolean syncToClient)`
`void`	`removeEventListener(String eventType, IEventListener eventListener)`
`void`	`removeEventListener(String eventType, IEventListener eventListener, boolean syncToClient)`
`Object`	`setAttribute(String name, Object value)`
`protected void`	`setContent(String content)`
`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)`
`void`	`setParent(BaseComponent parent)`
`BaseComponent.SubComponent`	`sub(String subId)` Returns a subcomponent identifier.
`void`	`swapChildren(int index1, int index2)`
`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 String`	`trimify(String value)` Trims whitespace from a string and nullifies it.
`protected void`	`validate()`
`protected static void`	`validate(BaseComponent comp)`
`protected void`	`validateChild(BaseComponent child)`
`void`	`validateIsChild(BaseComponent child)`
`protected boolean`	`validatePage(Page page)` Validates that the specified page can be an owner of this component.
`protected boolean`	`validateParent(BaseComponent parent)`
`void`	`wireController(Object controller)` Wires a controller's annotated components and event handlers, using this component to resolve name references.

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

- Constructor Detail
  - BaseComponent
```
public BaseComponent()
```
- Method Detail
  - validate
```
protected static void validate(BaseComponent comp)
```
  - getDefinition
```
public ComponentDefinition getDefinition()
```
  - getName
```
@Component.PropertyGetter(value="name")
public String getName()
```
  - setName
```
@Component.PropertySetter(value="name")
public void setName(String name)
```
  - getId
```
@Component.PropertyGetter(value="id")
public String getId()
```
    Specified by:
    
    getId in interface IElementIdentifier
    
    Returns:
    
    The unique identifier of the HTML element.
  - detach
```
public void detach()
```
  - destroy
```
public void destroy()
```
  - finalize
```
public void finalize()
              throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - destroyChildren
```
public void destroyChildren()
```
  - onDestroy
```
protected void onDestroy()
```
  - isDead
```
public boolean isDead()
```
  - validate
```
protected void validate()
```
  - getParent
```
public BaseComponent getParent()
```
  - validateParent
```
protected boolean validateParent(BaseComponent parent)
```
  - setParent
```
public void setParent(BaseComponent parent)
```
  - getAttributes
```
public Map<String,Object> getAttributes()
```
  - getAttribute
```
public Object getAttribute(String name)
```
  - getAttribute
```
public <T> T getAttribute(String name,
                          T dflt)
```
  - getAttribute
```
public <T> T getAttribute(String name,
                          Class<T> clazz)
```
  - findAttribute
```
public Object findAttribute(String name)
```
  - setAttribute
```
public Object setAttribute(String name,
                           Object value)
```
  - removeAttribute
```
public Object removeAttribute(String name)
```
  - hasAttribute
```
public boolean hasAttribute(String name)
```
  - validateIsChild
```
public void validateIsChild(BaseComponent child)
```
  - validateChild
```
protected void validateChild(BaseComponent child)
```
  - addChild
```
public void addChild(BaseComponent child)
```
  - addChild
```
public void addChild(BaseComponent child,
                     int index)
```
  - addChild
```
public void addChild(BaseComponent child,
                     BaseComponent before)
```
  - addChildren
```
public void addChildren(Collection<? extends BaseComponent> children)
```
  - removeChild
```
public void removeChild(BaseComponent child)
```
  - swapChildren
```
public void swapChildren(int index1,
                         int index2)
```
  - beforeSetParent
```
protected void beforeSetParent(BaseComponent newParent)
```
  - afterSetParent
```
protected void afterSetParent(BaseComponent oldParent)
```
  - beforeAddChild
```
protected void beforeAddChild(BaseComponent child)
```
  - afterAddChild
```
protected void afterAddChild(BaseComponent child)
```
  - beforeRemoveChild
```
protected void beforeRemoveChild(BaseComponent child)
```
  - afterRemoveChild
```
protected void afterRemoveChild(BaseComponent child)
```
  - getChildren
```
public List<BaseComponent> getChildren()
```
  - getChildren
```
public <T extends BaseComponent> Iterable<T> getChildren(Class<T> type)
```
  - getChildCount
```
public int getChildCount()
```
    Returns the number of children.
    
    Returns:
    
    The number of children.
  - getChildCount
```
public int getChildCount(Class<? extends BaseComponent> 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")
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)
```
  - validatePage
```
protected boolean validatePage(Page page)
```
    Validates that the specified page can be an owner of this component.
    
    Parameters:
    
    page - The page to be tested.
    
    Returns:
    
    True if the page can be an owner of this component.
  - _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
```
public 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.
  - 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,
                   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 path. "^" in path means parent namespace.
    
    Returns:
    
    The component sought, or null if not found.
  - 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,
                            String forwardType)
```
  - addEventForward
```
public void addEventForward(Class<? extends Event> eventClass,
                            BaseComponent target,
                            String forwardType)
```
  - removeEventForward
```
public void removeEventForward(String eventType,
                               BaseComponent target,
                               String forwardType)
```
  - removeEventForward
```
public void removeEventForward(Class<? extends Event> eventClass,
                               BaseComponent target,
                               String forwardType)
```
  - hasEventListener
```
public boolean hasEventListener(String eventType)
```
  - hasEventListener
```
public boolean hasEventListener(Class<? extends Event> eventClass)
```
  - addEventListener
```
public void addEventListener(String eventType,
                             IEventListener eventListener)
```
  - addEventListener
```
public void addEventListener(Class<? extends Event> eventClass,
                             IEventListener eventListener)
```
  - addEventListener
```
public void addEventListener(String eventType,
                             IEventListener eventListener,
                             boolean syncToClient)
```
  - addEventListener
```
public void addEventListener(Class<? extends Event> eventClass,
                             IEventListener eventListener,
                             boolean syncToClient)
```
  - removeEventListener
```
public void removeEventListener(String eventType,
                                IEventListener eventListener)
```
  - removeEventListener
```
public void removeEventListener(Class<? extends Event> eventClass,
                                IEventListener eventListener)
```
  - removeEventListener
```
public void removeEventListener(String eventType,
                                IEventListener eventListener,
                                boolean syncToClient)
```
  - removeEventListener
```
public void removeEventListener(Class<? extends Event> eventClass,
                                IEventListener eventListener,
                                boolean syncToClient)
```
  - fireEvent
```
public void fireEvent(String eventType)
```
  - fireEvent
```
public void fireEvent(Event event)
```
    Send an event to this component's registered event listeners.
    
    Parameters:
    
    event - Event to send.
  - 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.
  - wireController
```
@Component.PropertySetter(value="controller",
                          defer=true)
public void wireController(Object controller)
```
    Wires a controller's annotated components and event handlers, using this component to resolve name references.
    
    Parameters:
    
    controller - The controller to wire. If a string, is assumed to be the name of the controller's implementation class in which case an instance of that class is created.
  - 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")
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")
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()
```
  - setContent
```
@Component.PropertySetter(value="#text")
protected void setContent(String 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.
  - toString
```
public String toString()
```
    Returns basic information about this component for display purposes.
    
    Overrides:
    
    toString in class Object

Class BaseComponent

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseComponent

Method Detail

validate

getDefinition

getName

setName

getId

detach

destroy

finalize

destroyChildren

onDestroy

isDead

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

invokeIfAttached

invoke

findByName

findByName

findChildByData

findChildByLabel

sub

addEventForward

addEventForward