com.icesoft.faces.component.ext

Class HtmlCommandButton

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UICommand

javax.faces.component.html.HtmlCommandButton

com.icesoft.faces.component.ext.HtmlCommandButton

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

Direct Known Subclasses:

OutputChart

public class HtmlCommandButton
extends javax.faces.component.html.HtmlCommandButton

This is an extension of javax.faces.component.html.HtmlCommandButton, which provides some additional behavior to this component such as:

• default classes for enabled and disabled state
• provides full and partial submit mechanism
• changes the component's enabled and rendered state based on the authentication
• adds effects to the component

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlCommandButton

javax.faces.component.html.HtmlCommandButton.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE String constant component type
static java.lang.String	RENDERER_TYPE String constant 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
HtmlCommandButton() default no args constructor

Method Summary

Modifier and Type	Method and Description
com.icesoft.faces.context.effects.CurrentStyle	getCurrentStyle() Return the value of the currentStyle property.
com.icesoft.faces.context.effects.Effect	getEffect() Return the value of the effect property.
java.lang.String	getEnabledOnUserRole() Return the value of the enabledOnUserRole property.
com.icesoft.faces.context.effects.Effect	getOnclickeffect() Return the value of the onclickeffect property.
com.icesoft.faces.context.effects.Effect	getOndblclickeffect() Return the value of the ondblclickeffect property.
com.icesoft.faces.context.effects.Effect	getOnkeydowneffect() Return the value of the onkeydowneffect property.
com.icesoft.faces.context.effects.Effect	getOnkeypresseffect() Return the value of the onkeypresseffect property.
com.icesoft.faces.context.effects.Effect	getOnkeyupeffect() Return the value of the onkeyupeffect property.
com.icesoft.faces.context.effects.Effect	getOnmousedowneffect() Return the value of the onmousedowneffect property.
com.icesoft.faces.context.effects.Effect	getOnmousemoveeffect() Return the value of the onmousemoveeffect property.
com.icesoft.faces.context.effects.Effect	getOnmouseouteffect() Return the value of the onmouseouteffect property.
com.icesoft.faces.context.effects.Effect	getOnmouseovereffect() Return the value of the onmouseovereffect property.
com.icesoft.faces.context.effects.Effect	getOnmouseupeffect() Return the value of the onmouseupeffect property.
java.lang.String	getPanelConfirmation() Return the value of the panelConfirmation property.
boolean	getPartialSubmit() Return the value of the partialSubmit property.
java.lang.String	getRenderedOnUserRole() Return the value of the renderedOnUserRole property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
boolean	getVisible() Return the value of the visible property.
boolean	isDisabled() Return the value of the disabled property.
boolean	isRendered() Return the value of the rendered property.
boolean	isVisible() Return the value of the visible property.
void	requestFocus() This method is used to communicate a focus request from the application to the client browser.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state) Perform any processing required to restore the state from the entries in the state Object.
java.lang.Object	saveState(javax.faces.context.FacesContext context) Gets the state of the instance as a Serializable Object.
void	setCurrentStyle(com.icesoft.faces.context.effects.CurrentStyle currentStyle) Set the value of the currentStyle property.
void	setDisabled(boolean disabled) Set the value of the disabled property.
void	setEffect(com.icesoft.faces.context.effects.Effect effect) Set the value of the effect property.
void	setEnabledOnUserRole(java.lang.String enabledOnUserRole) Set the value of the enabledOnUserRole property.
void	setOnclickeffect(com.icesoft.faces.context.effects.Effect onclickeffect) Set the value of the onclickeffect property.
void	setOndblclickeffect(com.icesoft.faces.context.effects.Effect ondblclickeffect) Set the value of the ondblclickeffect property.
void	setOnkeydowneffect(com.icesoft.faces.context.effects.Effect onkeydowneffect) Set the value of the onkeydowneffect property.
void	setOnkeypresseffect(com.icesoft.faces.context.effects.Effect onkeypresseffect) Set the value of the onkeypresseffect property.
void	setOnkeyupeffect(com.icesoft.faces.context.effects.Effect onkeyupeffect) Set the value of the onkeyupeffect property.
void	setOnmousedowneffect(com.icesoft.faces.context.effects.Effect onmousedowneffect) Set the value of the onmousedowneffect property.
void	setOnmousemoveeffect(com.icesoft.faces.context.effects.Effect onmousemoveeffect) Set the value of the onmousemoveeffect property.
void	setOnmouseouteffect(com.icesoft.faces.context.effects.Effect onmouseouteffect) Set the value of the onmouseouteffect property.
void	setOnmouseovereffect(com.icesoft.faces.context.effects.Effect onmouseovereffect) Set the value of the onmouseovereffect property.
void	setOnmouseupeffect(com.icesoft.faces.context.effects.Effect onmouseupeffect) Set the value of the onmouseupeffect property.
void	setPanelConfirmation(java.lang.String panelConfirmation) Set the value of the panelConfirmation property.
void	setPartialSubmit(boolean partialSubmit) Set the value of the dir property.
void	setRenderedOnUserRole(java.lang.String renderedOnUserRole) Set the value of the renderedOnUserRole property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setValueBinding(java.lang.String s, javax.faces.el.ValueBinding vb)
void	setVisible(boolean visible) Set the value of the visible property.

Methods inherited from class javax.faces.component.html.HtmlCommandButton

getAccesskey, getAlt, getDefaultEventName, getDir, getEventNames, getImage, getLabel, getLang, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getStyle, getTabindex, getTitle, getType, isReadonly, setAccesskey, setAlt, setDir, setImage, setLabel, setLang, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setStyle, setTabindex, setTitle, setType

Methods inherited from class javax.faces.component.UICommand

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

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, 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

addClientBehavior, getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

String constant component type

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

String constant renderer type

See Also:

Constant Field Values

Constructor Detail

HtmlCommandButton

public HtmlCommandButton()

default no args constructor

Method Detail

setValueBinding

public void setValueBinding(java.lang.String s,
                            javax.faces.el.ValueBinding vb)

Overrides:

setValueBinding in class javax.faces.component.UIComponentBase

setPartialSubmit

public void setPartialSubmit(boolean partialSubmit)

Set the value of the dir property.

Parameters:

partialSubmit -

getPartialSubmit

public boolean getPartialSubmit()

Return the value of the partialSubmit property.

Returns:

boolean partialSubmit

setEffect

public void setEffect(com.icesoft.faces.context.effects.Effect effect)

Set the value of the effect property.

Parameters:

effect -

getEffect

public com.icesoft.faces.context.effects.Effect getEffect()

Return the value of the effect property.

Returns:

Effect effect

setVisible

public void setVisible(boolean visible)

Set the value of the visible property.

Parameters:

visible -

isVisible

public boolean isVisible()

Return the value of the visible property.

Returns:

boolean visible

getVisible

public boolean getVisible()

Return the value of the visible property.

Returns:

boolean visible

isDisabled

public boolean isDisabled()

Return the value of the disabled property.

Overrides:

isDisabled in class javax.faces.component.html.HtmlCommandButton

Returns:

boolean disabled

setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.

Overrides:

setDisabled in class javax.faces.component.html.HtmlCommandButton

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)

Set the value of the enabledOnUserRole property.

Parameters:

enabledOnUserRole -

getEnabledOnUserRole

public java.lang.String getEnabledOnUserRole()

Return the value of the enabledOnUserRole property.

Returns:

String enabledOnUserRole

setRenderedOnUserRole

public void setRenderedOnUserRole(java.lang.String renderedOnUserRole)

Set the value of the renderedOnUserRole property.

Parameters:

renderedOnUserRole -

getRenderedOnUserRole

public java.lang.String getRenderedOnUserRole()

Return the value of the renderedOnUserRole property.

Returns:

String renderedOnUserRole

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Overrides:

setStyleClass in class javax.faces.component.html.HtmlCommandButton

Parameters:

styleClass -

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Overrides:

getStyleClass in class javax.faces.component.html.HtmlCommandButton

Returns:

String styleClass

isRendered

public boolean isRendered()

Return the value of the rendered property.

Overrides:

isRendered in class javax.faces.component.UIComponentBase

Returns:

boolean rendered

getOnclickeffect

public com.icesoft.faces.context.effects.Effect getOnclickeffect()

Return the value of the onclickeffect property.

Returns:

Effect onclickEffect

setOnclickeffect

public void setOnclickeffect(com.icesoft.faces.context.effects.Effect onclickeffect)

Set the value of the onclickeffect property.

Parameters:

onclickeffect -

getOndblclickeffect

public com.icesoft.faces.context.effects.Effect getOndblclickeffect()

Return the value of the ondblclickeffect property.

Returns:

Effect

setOndblclickeffect

public void setOndblclickeffect(com.icesoft.faces.context.effects.Effect ondblclickeffect)

Set the value of the ondblclickeffect property.

Parameters:

ondblclickeffect -

getOnmousedowneffect

public com.icesoft.faces.context.effects.Effect getOnmousedowneffect()

Return the value of the onmousedowneffect property.

Returns:

Effect

setOnmousedowneffect

public void setOnmousedowneffect(com.icesoft.faces.context.effects.Effect onmousedowneffect)

Set the value of the onmousedowneffect property.

Parameters:

onmousedowneffect -

getOnmouseupeffect

public com.icesoft.faces.context.effects.Effect getOnmouseupeffect()

Return the value of the onmouseupeffect property.

Returns:

Effect

setOnmouseupeffect

public void setOnmouseupeffect(com.icesoft.faces.context.effects.Effect onmouseupeffect)

Set the value of the onmouseupeffect property.

Parameters:

onmouseupeffect -

getOnmousemoveeffect

public com.icesoft.faces.context.effects.Effect getOnmousemoveeffect()

Return the value of the onmousemoveeffect property.

Returns:

Effect

setOnmousemoveeffect

public void setOnmousemoveeffect(com.icesoft.faces.context.effects.Effect onmousemoveeffect)

Set the value of the onmousemoveeffect property.

Parameters:

onmousemoveeffect -

getOnmouseovereffect

public com.icesoft.faces.context.effects.Effect getOnmouseovereffect()

Return the value of the onmouseovereffect property.

Returns:

Effect

setOnmouseovereffect

public void setOnmouseovereffect(com.icesoft.faces.context.effects.Effect onmouseovereffect)

Set the value of the onmouseovereffect property.

Parameters:

onmouseovereffect -

getOnmouseouteffect

public com.icesoft.faces.context.effects.Effect getOnmouseouteffect()

Return the value of the onmouseouteffect property.

Returns:

Effect

setOnmouseouteffect

public void setOnmouseouteffect(com.icesoft.faces.context.effects.Effect onmouseouteffect)

Set the value of the onmouseouteffect property.

Parameters:

onmouseouteffect -

getOnkeypresseffect

public com.icesoft.faces.context.effects.Effect getOnkeypresseffect()

Return the value of the onkeypresseffect property.

Returns:

Effect

setOnkeypresseffect

public void setOnkeypresseffect(com.icesoft.faces.context.effects.Effect onkeypresseffect)

Set the value of the onkeypresseffect property.

Parameters:

onkeypresseffect -

getOnkeydowneffect

public com.icesoft.faces.context.effects.Effect getOnkeydowneffect()

Return the value of the onkeydowneffect property.

Returns:

Effect

setOnkeydowneffect

public void setOnkeydowneffect(com.icesoft.faces.context.effects.Effect onkeydowneffect)

Set the value of the onkeydowneffect property.

Parameters:

onkeydowneffect -

getOnkeyupeffect

public com.icesoft.faces.context.effects.Effect getOnkeyupeffect()

Return the value of the onkeyupeffect property.

Returns:

Effect

setOnkeyupeffect

public void setOnkeyupeffect(com.icesoft.faces.context.effects.Effect onkeyupeffect)

Set the value of the onkeyupeffect property.

Parameters:

onkeyupeffect -

getCurrentStyle

public com.icesoft.faces.context.effects.CurrentStyle getCurrentStyle()

Return the value of the currentStyle property.

Returns:

CurrentStyle

setCurrentStyle

public void setCurrentStyle(com.icesoft.faces.context.effects.CurrentStyle currentStyle)

Set the value of the currentStyle property.

Parameters:

currentStyle -

setPanelConfirmation

public void setPanelConfirmation(java.lang.String panelConfirmation)

Set the value of the panelConfirmation property.

Parameters:

panelConfirmation -

getPanelConfirmation

public java.lang.String getPanelConfirmation()

Return the value of the panelConfirmation property.

Returns:

String panelConfirmation

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Gets the state of the instance as a Serializable Object.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

Parameters:

context -

Returns:

Object values[]

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

Perform any processing required to restore the state from the entries in the state Object.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase

Parameters:

context -

state -

requestFocus

public void requestFocus()

This method is used to communicate a focus request from the application to the client browser.