Alloy UI

aui-component  1.0.1

 
Filters

Class Component - extends Widget

Known Subclasses:
Toolbar ButtonItem Editable OverlayBase AutoComplete Rating Panel
A base class for Component, providing:
  • Widget Lifecycle (initializer, renderUI, bindUI, syncUI, destructor)
Check the list of Configuration Attributes available for Component.

Constructor

Component ( config )
Parameters:
config <Object> Object literal specifying widget configuration properties.

Properties

Component.ATTRS - static Object

Static property used to define the default attribute configuration for the Component.

Component.NAME - static String

Static property provides a string to identify the class.

Properties inherited from Attribute:

Properties inherited from Base:

Configuration Attributes

cssClass - String

CSS class to be automatically added to the boundingBox.
Default Value: null

hideClass - String

css class added to hide the boundingBox when visible is set to false.
Default Value: 'aui-helper-hidden'

render - boolean

If true the render phase will be autimatically invoked preventing the .render() manual call.
Default Value: false

Configuration attributes inherited from Widget:

Configuration attributes inherited from Base:

Methods

_afterComponentVisibleChange

protected void _afterComponentVisibleChange ( event )
Fires after the value of the visible attribute change.
Parameters:
event <EventFacade>

_afterCssClassChange

protected void _afterCssClassChange ( event )
Fires after the value of the cssClass attribute change.
Parameters:
event <EventFacade>

_setComponentClassNames

protected void _setComponentClassNames ( )
Set the class names on the Component contentBox.

_uiSetCssClass

protected void _uiSetCssClass ( newVal , prevVal )
Applies the CSS classes to the boundingBox and contentBox.
Parameters:
newVal <String>
prevVal <String>

clone

Widget clone ( config )
Clone the current Component.
Parameters:
config <Object>
Returns: Widget
Cloned instance.

initializer

protected void initializer ( )
Construction logic executed during Component instantiation. Lifecycle.

toggle

void toggle ( )
Toggle the visibility of the Panel toggling the value of the visible attribute.

Methods inherited from Plugin.Host:

Events

cssClassChange

cssClassChange ( event )
Fires when the value for the configuration attribute 'cssClass' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

hideClassChange

hideClassChange ( event )
Fires when the value for the configuration attribute 'hideClass' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

renderChange

renderChange ( event )
Fires when the value for the configuration attribute 'render' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set