| |||||||
| FRAMES NO FRAMES | |||||||
| Tag Information | |
| Tag Class | com.liferay.taglib.aui.ButtonItemTag |
| TagExtraInfo Class | None |
| Body Content | JSP |
| Display Name | None |
| Attributes | ||||
| Name | Required | Request-time | Type | Description |
| activeState | false | true | boolean | Whether to track the active state of the button. |
| boundingBox | false | true | java.lang.String | The outermost DOM node for the Widget, used for sizing and positioning of a Widget as well as a containing element for any decorator elements used for skinning. |
| classNames | false | true | java.lang.Object | An object map of the CSS class names to use for the different interaction states. |
| contentBox | false | true | java.lang.String | A DOM node that is a direct descendant of a Widget's bounding box that houses its content. |
| cssClass | false | true | java.lang.String | CSS class to be automatically added to the boundingBox. |
| defaultState | false | true | boolean | Whether to apply the default interaction state to the button |
| depth | false | true | java.lang.Object | Number representing the depth of this Widget relative to the root Widget in the object heirarchy. |
| destroyed | false | true | boolean | Flag indicating whether or not this object has been through the destroy lifecycle phase. |
| disabled | false | true | boolean | Boolean indicating if the Widget should be disabled. The disabled implementation is left to the specific classes extending widget. |
| focused | false | true | boolean | Boolean indicating if the Widget, or one of its descendants, has focus. |
| handler | false | true | java.lang.Object | An event callback to handle when a user interacts with the button. This can either be a function that will be attached on click, or an object map that accepts the following keys: {fn: // The function to execute context: // The context to execute the function in type: // The type of event to listen for (defaults to "click") } |
| height | false | true | java.lang.Object | String with units, or number, representing the height of the Widget. If a number is provided, the default unit, defined by the Widgets DEF_UNIT, property is used. |
| hideClass | false | true | java.lang.String | css class added to hide the boundingBox when visible is set to false. |
| hoverState | false | true | boolean | Whether to track the hover interaction state of the button. |
| icon | false | true | java.lang.String | The icon to use inside of the button. Possible values are: |
| iconNode | false | true | java.lang.String | DOM Node to display the icon of the ButtonItem. If not specified try to query using HTML_PARSER an element inside boundingBox which matches aui-button-icon. |
| buttonitemId | false | true | java.lang.String | |
| index | false | true | java.lang.Object | Number representing the Widget's ordinal position in its parent Widget. |
| initialized | false | true | boolean | Flag indicating whether or not this object has been through the init lifecycle phase. |
| label | false | true | java.lang.String | Text to use inside of the button. |
| labelNode | false | true | java.lang.String | DOM Node to display the text of the ButtonItem. If not specified try to query using HTML_PARSER an element inside boundingBox which matches aui-button-label. |
| buttonitemParent | false | true | java.lang.Object | Retrieves the parent of the Widget in the object hierarchy. |
| render | false | true | java.lang.Object | If true the render phase will be autimatically invoked preventing the .render() manual call. |
| rendered | false | true | boolean | Flag indicating whether or not this Widget has been through the render lifecycle phase. |
| root | false | true | java.lang.Object | Returns the root Widget in the object hierarchy. If the ROOT_TYPE property is set, the search for the root Widget will be constrained to parent Widgets of the specified type. |
| selected | false | true | java.lang.Object | Number indicating if the Widget is selected. Possible values are:
|
| srcNode | false | true | java.lang.String | The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition |
| strings | false | true | java.lang.Object | Collection of strings used to label elements of the Widget's UI. |
| tabIndex | false | true | java.lang.Object | Number (between -32767 to 32767) indicating the widget's position in the default tab flow. The value is used to set the "tabIndex" attribute on the widget's bounding box. Negative values allow the widget to receive DOM focus programmatically (by calling the focus method), while being removed from the default tab flow. A value of null removes the "tabIndex" attribute from the widget's bounding box. |
| title | false | true | java.lang.String | Text to use as the title attribute of the button. |
| type | false | true | java.lang.String | Button type. |
| useARIA | false | true | boolean | Boolean indicating if use of the WAI-ARIA Roles and States should be enabled for the Widget. |
| visible | false | true | boolean | Boolean indicating weather or not the Widget is visible. |
| width | false | true | java.lang.Object | String with units, or number, representing the width of the Widget. If a number is provided, the default unit, defined by the Widgets DEF_UNIT, property is used. |
| afterActiveStateChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'activeState' 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. |
| afterBoundingBoxChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'boundingBox' 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. |
| afterClassNamesChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'classNames' 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. |
| afterContentBoxChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'contentBox' 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. |
| afterCssClassChange | false | true | java.lang.Object | 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. |
| afterDefaultStateChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'defaultState' 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. |
| afterDepthChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'depth' 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. |
| afterDestroy | false | true | java.lang.Object | Lifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding. Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction). |
| afterDestroyedChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'destroyed' 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. |
| afterDisabledChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'disabled' 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. |
| afterFocusedChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'focused' 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. |
| afterHandlerChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'handler' 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. |
| afterHeightChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'height' 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. |
| afterHideClassChange | false | true | java.lang.Object | 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. |
| afterHoverStateChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'hoverState' 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. |
| afterIconChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'icon' 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. |
| afterIconNodeChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'iconNode' 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. |
| afterIdChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'id' 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. |
| afterIndexChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'index' 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. |
| afterInit | false | true | java.lang.Object | Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring. Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization). |
| afterInitializedChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'initialized' 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. |
| afterLabelChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'label' 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. |
| afterLabelNodeChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'labelNode' 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. |
| afterParentChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'parent' 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. |
| afterRenderChange | false | true | java.lang.Object | 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. |
| afterRenderedChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'rendered' 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. |
| afterRootChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'root' 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. |
| afterSelectedChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'selected' 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. |
| afterSrcNodeChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'srcNode' 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. |
| afterStringsChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'strings' 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. |
| afterTabIndexChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'tabIndex' 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. |
| afterTitleChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'title' 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. |
| afterTypeChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'type' 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. |
| afterUseARIAChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'useARIA' 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. |
| afterVisibleChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'visible' 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. |
| afterContentUpdate | false | true | java.lang.Object | Notification event, which widget implementations can fire, when they change the content of the widget. This event has no default behavior and cannot be prevented, so the "on" or "after" moments are effectively equivalent (with on listeners being invoked before after listeners). |
| afterRender | false | true | java.lang.Object | Lifecycle event for the render phase, fired prior to rendering the UI for the widget (prior to invoking the widget's renderer method). Subscribers to the "on" moment of this event, will be notified before the widget is rendered. Subscribers to the "after" moment of this event, will be notified after rendering is complete. |
| afterWidthChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'width' 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. |
| onActiveStateChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'activeState' 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. |
| onBoundingBoxChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'boundingBox' 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. |
| onClassNamesChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'classNames' 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. |
| onContentBoxChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'contentBox' 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. |
| onCssClassChange | false | true | java.lang.Object | 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. |
| onDefaultStateChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'defaultState' 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. |
| onDepthChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'depth' 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. |
| onDestroy | false | true | java.lang.Object | Lifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding. Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction). |
| onDestroyedChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'destroyed' 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. |
| onDisabledChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'disabled' 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. |
| onFocusedChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'focused' 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. |
| onHandlerChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'handler' 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. |
| onHeightChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'height' 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. |
| onHideClassChange | false | true | java.lang.Object | 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. |
| onHoverStateChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'hoverState' 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. |
| onIconChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'icon' 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. |
| onIconNodeChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'iconNode' 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. |
| onIdChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'id' 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. |
| onIndexChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'index' 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. |
| onInit | false | true | java.lang.Object | Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring. Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization). |
| onInitializedChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'initialized' 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. |
| onLabelChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'label' 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. |
| onLabelNodeChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'labelNode' 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. |
| onParentChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'parent' 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. |
| onRenderChange | false | true | java.lang.Object | 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. |
| onRenderedChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'rendered' 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. |
| onRootChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'root' 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. |
| onSelectedChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'selected' 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. |
| onSrcNodeChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'srcNode' 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. |
| onStringsChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'strings' 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. |
| onTabIndexChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'tabIndex' 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. |
| onTitleChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'title' 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. |
| onTypeChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'type' 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. |
| onUseARIAChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'useARIA' 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. |
| onVisibleChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'visible' 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. |
| onContentUpdate | false | true | java.lang.Object | Notification event, which widget implementations can fire, when they change the content of the widget. This event has no default behavior and cannot be prevented, so the "on" or "after" moments are effectively equivalent (with on listeners being invoked before after listeners). |
| onRender | false | true | java.lang.Object | Lifecycle event for the render phase, fired prior to rendering the UI for the widget (prior to invoking the widget's renderer method). Subscribers to the "on" moment of this event, will be notified before the widget is rendered. Subscribers to the "after" moment of this event, will be notified after rendering is complete. |
| onWidthChange | false | true | java.lang.Object | Fires when the value for the configuration attribute 'width' 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. |
| Variables | No Variables Defined. |
| |||||||
| FRAMES NO FRAMES | |||||||