PushButton

Overview

Since 2.0

The ace:pushButton component allows submission of a form in it's entirety or also the submission of itself only. This component supports an action attribute as well as an actionListener attribute similar to a h:commandButton.

See the ICEfaces Showcase Live Demo of this component, complete with source code.

Getting Started

<html ... xmlns:ace="http://www.icefaces.org/icefaces/components">

<h:body>
    <h:form >
        <h:panelGroup id="push1">
	    <ace:pushButton
                id="pushId"
                value="submit"
                label="this button submits the entire form"
	        actionListener="#{button.actionListenerMethod}"  />
	</h:panelGroup>
    </h:form>
</h:body>

Attributes

TagLib Documentation
This section covers attributes involved in the typical use-cases for this component. For reference, the complete taglib documentation for this component is available here.

value refers to the text written on the button, similar to that of jsf commandButton.

label If no value present, the label will be used for the pushButton. Otherwise if both are used, the label will be used to define the aria-role, described-by.

style: a pass through to the root element of the component.

styleClass a pass through to the root element of the component.

tabindex a pass through to the root element of the component, default=0.

disabled a pass through to the root element of the component.

The following attributes are supported as pass-thru attributes: accesskey, alt, dir, label, lang, style, tabindex, title, onchange, onselect, onclick, ondblclick, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onblur, onfocus

Event Listeners

As a descendant of UICommand, this component supports an action listener.

actionListener

Method that will be notified when the component is activated by the user

Client Behavior Events

action

Fired when the button is clicked or pressed by any other means (default event).

Prior to 4.0 this event was named "activate". The "activate" event name is now deprecated but treated as an alias for "action" for backwards compatibility with existing applications.

JavaScript API

ICEfaces 3.x

The client side component object is exposed through the global variable name specified in the widgetVar attribute.

ICEfaces 4+

The "widgetVar" attribute on the ACE components has been removed in ICEfaces 4 and in its place a new "ice.ace.instance()" client JavaScript object lookup API has been introduced. The reason for this change is to enable lazy-initialization of the ACE component JavaScript objects to improve runtime performance and reduce browser memory use.

var widget = ice.ace.instance('frm:componentId);

The ice.ace.instance function requires the full client id of the component to be specified, such as "j_idt77:componentId" instead of just "componentId". To reduce the complexity of working with complete IDs with this function it may be preferable in some cases to use prependId="false" in the enclosing form (e.g. <h:form prependId="false">).

This component doesn't have a client-side API made specifically to be used by application developers. However, the component's internal methods and variables can be accessed in this way, including the underlying jQuery object and objects from underlying Javascript libraries (if applicable), and can be used for whatever purpose a developer might have in mind.

Keyboard and ARIA Support

The following ARIA roles are supported: button.

CSS Classes

The following markup represents the basic HTML structure of the component and the CSS classes it uses.

<div class="yui-content ui-tabs-panel ui-widget-content ui-corner-bottom">
	<div>
		<div class="ui-tabs-panel ui-widget-content ui-corner-bottom">
			<div class="[user defined classes]" style="[user defined styles]">
				<span class="first-child">
					<button class="ui-button ui-widget ui-state-default ui-corner-all">
						<span>Label</span>
					</button>
				</span>
			</div>
		</div>
	</div>
</div>

Known Issues

None.

Additional Resources