org.rcfaces.core.component
Class ButtonComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by org.rcfaces.core.internal.component.CameliaCommandComponent
                  extended by org.rcfaces.core.component.AbstractCommandComponent
                      extended by org.rcfaces.core.component.ButtonComponent
All Implemented Interfaces:
ActionSource, ActionSource2, StateHolder, IAccessKeyCapability, IAlternateTextCapability, IClientDataCapability, IDisabledCapability, IErrorEventCapability, IFocusBlurEventCapability, IFocusStyleClassCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IReadOnlyCapability, ISelectionEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, ITabIndexCapability, ITextAlignmentCapability, ITextCapability, ITextDirectionCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValidationEventCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager
Direct Known Subclasses:
HyperLinkComponent, ImageButtonComponent, ResetButtonComponent, SubmitButtonComponent

public class ButtonComponent
extends AbstractCommandComponent
implements ITextCapability, ITextDirectionCapability, ISelectionEventCapability, IReadOnlyCapability, IAlternateTextCapability, IFocusStyleClassCapability

The button Component is equivalent to the standard HTML tag <BUTTON>.

The button Component has the following capabilities :

The default button renderer is linked to the f_button javascript class. f_box extends f_component, fa_asyncRender, fa_subMenu

Table of component style classes:

Style Name Description
f_button Defines styles for the wrapper Input element


Field Summary
protected static Set CAMELIA_ATTRIBUTES
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.rcfaces.core.internal.component.CameliaCommandComponent
engine
 
Fields inherited from class javax.faces.component.UICommand
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface org.rcfaces.core.component.capability.ITextDirectionCapability
DEFAULT_TEXT_DIRECTION, LEFT_TO_RIGHT_TEXT_DIRECTION, RIGHT_LEFT_TEXT_DIRECTION
 
Fields inherited from interface org.rcfaces.core.component.capability.IHiddenModeCapability
CLIENT_HIDDEN_MODE, DEFAULT_HIDDEN_MODE, IGNORE_HIDDEN_MODE, PHANTOM_HIDDEN_MODE, SERVER_HIDDEN_MODE
 
Constructor Summary
ButtonComponent()
           
ButtonComponent(String componentId)
           
 
Method Summary
 void addSelectionListener(ISelectionListener listener)
          Adds a listener to the component for the selection event
 String getAlternateText()
           
 String getAlternateText(FacesContext facesContext)
          See getAlternateText() for more details
protected  Set getCameliaFields()
           
 String getFocusStyleClass()
          Returns the style class of the component.
 String getFocusStyleClass(FacesContext facesContext)
          See getFocusStyleClass() for more details
 String getText()
          Returns a string value specifying the text shown.
 String getText(FacesContext facesContext)
          See getText() for more details
 int getTextDirection()
           
 int getTextDirection(FacesContext facesContext)
          See getTextDirection() for more details
 boolean isAlternateTextSetted()
          Returns true if the attribute "alternateText" is set.
 boolean isFocusStyleClassSetted()
          Returns true if the attribute "focusStyleClass" is set.
 boolean isReadOnly()
          Returns a boolean value indicating that this component will prohibit changes by the user.
 boolean isReadOnly(FacesContext facesContext)
          See isReadOnly() for more details
 boolean isReadOnlySetted()
          Returns true if the attribute "readOnly" is set.
 boolean isTextDirectionSetted()
          Returns true if the attribute "textDirection" is set.
 boolean isTextSetted()
          Returns true if the attribute "text" is set.
 FacesListener[] listSelectionListeners()
          Returns a list of selection listener for the component
 void removeSelectionListener(ISelectionListener listener)
          Removes a listener from the component for the selection event
 void setAlternateText(String alternateText)
           
 void setFocusStyleClass(String focusStyleClass)
          Specify the style class of the component.
 void setReadOnly(boolean readOnly)
          Sets a boolean value indicating that this component will prohibit changes by the user.
 void setText(String text)
          Sets a string value specifying the text to be shown.
 void setTextDirection(int textDirection)
           
 
Methods inherited from class org.rcfaces.core.component.AbstractCommandComponent
addBlurListener, addErrorListener, addFocusListener, addInitListener, addMouseOutListener, addMouseOverListener, addPropertyChangeListener, addUserEventListener, addValidationListener, getAccessKey, getAccessKey, getAriaLabel, getAriaLabel, getAriaLevel, getAriaLevel, getBackgroundColor, getBackgroundColor, getBottom, getBottom, getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, getFontBold, getFontBold, getFontItalic, getFontItalic, getFontName, getFontName, getFontSize, getFontSize, getFontUnderline, getFontUnderline, getForegroundColor, getForegroundColor, getHeight, getHeight, getHelpMessage, getHelpMessage, getHelpURL, getHelpURL, getHiddenMode, getHiddenMode, getLeft, getLeft, getLookId, getLookId, getMarginBottom, getMarginBottom, getMarginLeft, getMarginLeft, getMarginRight, getMarginRight, getMarginTop, getMarginTop, getRight, getRight, getServerData, getServerData, getServerDataCount, getServerDataMap, getServerDataMap, getStyleClass, getStyleClass, getTabIndex, getTabIndex, getTextAlignment, getTextAlignment, getToolTipText, getToolTipText, getTop, getTop, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isAccessKeySetted, isAriaLabelSetted, isAriaLevelSetted, isBackgroundColorSetted, isBottomSetted, isDisabled, isDisabled, isDisabledSetted, isFontBoldSetted, isFontItalicSetted, isFontNameSetted, isFontSizeSetted, isFontUnderlineSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isLeftSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isPartialRendering, isPartialRendering, isPartialRenderingSetted, isRightSetted, isStyleClassSetted, isTabIndexSetted, isTextAlignmentSetted, isToolTipTextSetted, isTopSetted, isUnlockedClientAttributeNamesSetted, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWidthSetted, isXSetted, isYSetted, listBlurListeners, listClientDataKeys, listClientDataKeys, listErrorListeners, listFocusListeners, listInitListeners, listMouseOutListeners, listMouseOverListeners, listPropertyChangeListeners, listServerDataKeys, listServerDataKeys, listUserEventListeners, listValidationListeners, removeBlurListener, removeClientData, removeErrorListener, removeFocusListener, removeInitListener, removeMouseOutListener, removeMouseOverListener, removePropertyChangeListener, removeServerData, removeUserEventListener, removeValidationListener, setAccessKey, setAriaLabel, setAriaLevel, setBackgroundColor, setBottom, setClientData, setClientData, setDisabled, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setLeft, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPartialRendering, setRight, setServerData, setServerData, setStyleClass, setTabIndex, setTextAlignment, setToolTipText, setTop, setUnlockedClientAttributeNames, setVisible, setWaiRole, setWidth, setX, setY
 
Methods inherited from class org.rcfaces.core.internal.component.CameliaCommandComponent
broadcast, clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, getFamily, getRendererType, getTransientAttribute, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setDefaultProperties, setRendered, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, findComponent, getAttributes, getChildCount, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.rcfaces.core.component.capability.IImmediateCapability
isImmediate, setImmediate
 
Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager
getChildCount
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES
Constructor Detail

ButtonComponent

public ButtonComponent()

ButtonComponent

public ButtonComponent(String componentId)
Method Detail

getText

public String getText()
Description copied from interface: ITextCapability
Returns a string value specifying the text shown.

Specified by:
getText in interface ITextCapability
Returns:
text

getText

public String getText(FacesContext facesContext)
See getText() for more details


isTextSetted

public final boolean isTextSetted()
Returns true if the attribute "text" is set.

Returns:
true if the attribute is set.

setText

public void setText(String text)
Description copied from interface: ITextCapability
Sets a string value specifying the text to be shown.

Specified by:
setText in interface ITextCapability
Parameters:
text - text

getTextDirection

public int getTextDirection()
Specified by:
getTextDirection in interface ITextDirectionCapability

getTextDirection

public int getTextDirection(FacesContext facesContext)
See getTextDirection() for more details


isTextDirectionSetted

public final boolean isTextDirectionSetted()
Returns true if the attribute "textDirection" is set.

Returns:
true if the attribute is set.

setTextDirection

public void setTextDirection(int textDirection)
Specified by:
setTextDirection in interface ITextDirectionCapability

addSelectionListener

public final void addSelectionListener(ISelectionListener listener)
Description copied from interface: ISelectionEventCapability
Adds a listener to the component for the selection event

Specified by:
addSelectionListener in interface ISelectionEventCapability
Parameters:
listener - the selection listener to add

removeSelectionListener

public final void removeSelectionListener(ISelectionListener listener)
Description copied from interface: ISelectionEventCapability
Removes a listener from the component for the selection event

Specified by:
removeSelectionListener in interface ISelectionEventCapability
Parameters:
listener - the selection listener to remove

listSelectionListeners

public final FacesListener[] listSelectionListeners()
Description copied from interface: ISelectionEventCapability
Returns a list of selection listener for the component

Specified by:
listSelectionListeners in interface ISelectionEventCapability
Returns:
selection listeners' list

isReadOnly

public boolean isReadOnly()
Description copied from interface: IReadOnlyCapability
Returns a boolean value indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled.

Specified by:
isReadOnly in interface IReadOnlyCapability
Returns:
readOnly boolean property

isReadOnly

public boolean isReadOnly(FacesContext facesContext)
See isReadOnly() for more details


isReadOnlySetted

public final boolean isReadOnlySetted()
Returns true if the attribute "readOnly" is set.

Returns:
true if the attribute is set.

setReadOnly

public void setReadOnly(boolean readOnly)
Description copied from interface: IReadOnlyCapability
Sets a boolean value indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled.

Specified by:
setReadOnly in interface IReadOnlyCapability
Parameters:
readOnly - readOnly boolean property

getAlternateText

public String getAlternateText()
Specified by:
getAlternateText in interface IAlternateTextCapability

getAlternateText

public String getAlternateText(FacesContext facesContext)
See getAlternateText() for more details


isAlternateTextSetted

public final boolean isAlternateTextSetted()
Returns true if the attribute "alternateText" is set.

Returns:
true if the attribute is set.

setAlternateText

public void setAlternateText(String alternateText)
Specified by:
setAlternateText in interface IAlternateTextCapability

getFocusStyleClass

public String getFocusStyleClass()
Description copied from interface: IFocusStyleClassCapability
Returns the style class of the component.

Specified by:
getFocusStyleClass in interface IFocusStyleClassCapability
Returns:
style class

getFocusStyleClass

public String getFocusStyleClass(FacesContext facesContext)
See getFocusStyleClass() for more details


isFocusStyleClassSetted

public final boolean isFocusStyleClassSetted()
Returns true if the attribute "focusStyleClass" is set.

Returns:
true if the attribute is set.

setFocusStyleClass

public void setFocusStyleClass(String focusStyleClass)
Description copied from interface: IFocusStyleClassCapability
Specify the style class of the component.

Specified by:
setFocusStyleClass in interface IFocusStyleClassCapability
Parameters:
focusStyleClass - style class

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class AbstractCommandComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.