org.icefaces.ace.component.pushbutton

Class PushButtonBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UICommand

org.icefaces.ace.component.pushbutton.PushButtonBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IceClientBehaviorHolder, IPushButton

Direct Known Subclasses:

PushButton

public abstract class PushButtonBase
extends javax.faces.component.UICommand
implements IPushButton, IceClientBehaviorHolder

The Push Button is a component that allows entry of a complete form or just itself. It has the same functionality of a regular jsf command button but without having to add extra attributes.

For more information, see the PushButton Wiki Documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PushButtonBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
PushButtonBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
java.lang.String	getAccesskey() Return the value of the accesskey property.
java.lang.String	getDefaultEventName()
java.lang.String	getDefaultExecute(java.lang.String event)
java.lang.String	getDefaultRender(java.lang.String event)
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
java.lang.String	getLabel() Return the value of the label property.
java.lang.String	getListenerArgument(java.lang.String event)
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.Integer	getTabindex() Return the value of the tabindex property.
java.lang.String	getType() Return the value of the type property.
boolean	isDisabled() Return the value of the disabled property.
boolean	isOfflineDisabled() Return the value of the offlineDisabled property.
protected boolean	isPropertySet(java.lang.String finder)
void	setAccesskey(java.lang.String accesskey) Set the value of the accesskey property.
void	setDisabled(boolean disabled) Set the value of the disabled property.
void	setLabel(java.lang.String label) Set the value of the label property.
void	setOfflineDisabled(boolean offlineDisabled) Set the value of the offlineDisabled property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setTabindex(java.lang.Integer tabindex) Set the value of the tabindex property.
void	setType(java.lang.String type) Set the value of the type property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

PushButtonBase

public PushButtonBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UICommand

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to this component.

Specified by:

setAccesskey in interface IPushButton

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to this component.

Specified by:

getAccesskey in interface IPushButton

setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.

Contents: If true, no input may be submitted via this component.

Specified by:

setDisabled in interface IPushButton

isDisabled

public boolean isDisabled()

Return the value of the disabled property.

Contents: If true, no input may be submitted via this component. Default = 'false'.

Specified by:

isDisabled in interface IPushButton

setLabel

public void setLabel(java.lang.String label)

Set the value of the label property.

Contents: A localized user presentable name for this component.

Specified by:

setLabel in interface IPushButton

getLabel

public java.lang.String getLabel()

Return the value of the label property.

Contents: A localized user presentable name for this component.

Specified by:

getLabel in interface IPushButton

setOfflineDisabled

public void setOfflineDisabled(boolean offlineDisabled)

Set the value of the offlineDisabled property.

Contents: If true, no input may be submitted via this component when browser is offline.

Specified by:

setOfflineDisabled in interface IPushButton

isOfflineDisabled

public boolean isOfflineDisabled()

Return the value of the offlineDisabled property.

Contents: If true, no input may be submitted via this component when browser is offline. Default = 'false'.

Specified by:

isOfflineDisabled in interface IPushButton

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: The inline style of the component, rendered on the root div of the component.

Specified by:

setStyle in interface IPushButton

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: The inline style of the component, rendered on the root div of the component.

Specified by:

getStyle in interface IPushButton

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: The CSS style class of the component, rendered on the root div of the component.

Specified by:

setStyleClass in interface IPushButton

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: The CSS style class of the component, rendered on the root div of the component.

Specified by:

getStyleClass in interface IPushButton

setTabindex

public void setTabindex(java.lang.Integer tabindex)

Set the value of the tabindex property.

Contents: Tabindex of the component.

Specified by:

setTabindex in interface IPushButton

getTabindex

public java.lang.Integer getTabindex()

Return the value of the tabindex property.

Contents: Tabindex of the component.

Specified by:

getTabindex in interface IPushButton

setType

public void setType(java.lang.String type)

Set the value of the type property.

Contents: Specifies the button type. The possible values are 'button', 'submit', 'clear' and 'reset'. The 'button' type is the original and standard mode, where the button submits the form when activated. The 'submit' type lets the browser handle the request natively, without ICEfaces intervention (Note that if the component has a listener or an ajax event attached to it an additional request will be made, handled by ICEfaces). If the type is 'clear', the component acts in a special way: the button will act in a client-side mode, clearing all fields and components in the form it is contained in. If the type is 'reset', the component will reset all the input elements and components to their original values at the time they were loaded. The button will not submit the form in the 'clear' and 'reset' modes, unless the component has a listener or an ajax event attached to it.

Specified by:

setType in interface IPushButton

getType

public java.lang.String getType()

Return the value of the type property.

Contents: Specifies the button type. The possible values are 'button', 'submit', 'clear' and 'reset'. The 'button' type is the original and standard mode, where the button submits the form when activated. The 'submit' type lets the browser handle the request natively, without ICEfaces intervention (Note that if the component has a listener or an ajax event attached to it an additional request will be made, handled by ICEfaces). If the type is 'clear', the component acts in a special way: the button will act in a client-side mode, clearing all fields and components in the form it is contained in. If the type is 'reset', the component will reset all the input elements and components to their original values at the time they were loaded. The button will not submit the form in the 'clear' and 'reset' modes, unless the component has a listener or an ajax event attached to it. Default = 'button'.

Specified by:

getType in interface IPushButton

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                      javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getDefaultRender

public java.lang.String getDefaultRender(java.lang.String event)

Specified by:

getDefaultRender in interface IceClientBehaviorHolder

getDefaultExecute

public java.lang.String getDefaultExecute(java.lang.String event)

Specified by:

getDefaultExecute in interface IceClientBehaviorHolder

getListenerArgument

public java.lang.String getListenerArgument(java.lang.String event)

Specified by:

getListenerArgument in interface IceClientBehaviorHolder

addClientBehavior

public void addClientBehavior(java.lang.String eventName,
                     javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

addClientBehavior in class javax.faces.component.UIComponentBase