org.rcfaces.core.component
Class CustomButtonComponent

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.CustomButtonComponent
All Implemented Interfaces:
ActionSource, ActionSource2, StateHolder, IAccessKeyCapability, IBorderCapability, IBorderTypeCapability, IClientDataCapability, IDisabledCapability, IDoubleClickEventCapability, IErrorEventCapability, IFocusBlurEventCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IReadOnlyCapability, ISelectionEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, ITabIndexCapability, ITextAlignmentCapability, 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

public class CustomButtonComponent
extends AbstractCommandComponent
implements IBorderTypeCapability, IBorderCapability, ISelectionEventCapability, IDoubleClickEventCapability, IReadOnlyCapability

A button Component highly customizable through its API.


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.IBorderTypeCapability
NONE_BORDER_TYPE_NAME
 
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
CustomButtonComponent()
           
CustomButtonComponent(String componentId)
           
 
Method Summary
 void addDoubleClickListener(IDoubleClickListener listener)
          Adds a listener to the component for the doubleClick event
 void addSelectionListener(ISelectionListener listener)
          Adds a listener to the component for the selection event
 String getBorderType()
          Returns a string that indicates the type of border the component should show.
 String getBorderType(FacesContext facesContext)
          See getBorderType() for more details
protected  Set getCameliaFields()
           
 boolean isBorder()
          Returns a boolean value that indicates if the component should show a border or not.
 boolean isBorder(FacesContext facesContext)
          See isBorder() for more details
 boolean isBorderSetted()
          Returns true if the attribute "border" is set.
 boolean isBorderTypeSetted()
          Returns true if the attribute "borderType" 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.
 FacesListener[] listDoubleClickListeners()
          Returns a list of doubleClick listener for the component
 FacesListener[] listSelectionListeners()
          Returns a list of selection listener for the component
 void removeDoubleClickListener(IDoubleClickListener listener)
          Removes a listener from the component for the doubleClick event
 void removeSelectionListener(ISelectionListener listener)
          Removes a listener from the component for the selection event
 void setBorder(boolean border)
          Sets a boolean value that indicates if the component should show a border or not.
 void setBorderType(String borderType)
          Sets a string that indicates the type of border the component should show.
 void setReadOnly(boolean readOnly)
          Sets a boolean value indicating that this component will prohibit changes by the user.
 
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

CustomButtonComponent

public CustomButtonComponent()

CustomButtonComponent

public CustomButtonComponent(String componentId)
Method Detail

getBorderType

public String getBorderType()
Description copied from interface: IBorderTypeCapability
Returns a string that indicates the type of border the component should show.

Specified by:
getBorderType in interface IBorderTypeCapability
Returns:
none|solid|relief|flat|rounded

getBorderType

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


isBorderTypeSetted

public final boolean isBorderTypeSetted()
Returns true if the attribute "borderType" is set.

Returns:
true if the attribute is set.

setBorderType

public void setBorderType(String borderType)
Description copied from interface: IBorderTypeCapability
Sets a string that indicates the type of border the component should show.

Specified by:
setBorderType in interface IBorderTypeCapability
Parameters:
borderType - none|solid|relief|flat|rounded

isBorder

public boolean isBorder()
Description copied from interface: IBorderCapability
Returns a boolean value that indicates if the component should show a border or not.

Specified by:
isBorder in interface IBorderCapability
Returns:
border

isBorder

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


isBorderSetted

public final boolean isBorderSetted()
Returns true if the attribute "border" is set.

Returns:
true if the attribute is set.

setBorder

public void setBorder(boolean border)
Description copied from interface: IBorderCapability
Sets a boolean value that indicates if the component should show a border or not.

Specified by:
setBorder in interface IBorderCapability
Parameters:
border - boolean

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

addDoubleClickListener

public final void addDoubleClickListener(IDoubleClickListener listener)
Description copied from interface: IDoubleClickEventCapability
Adds a listener to the component for the doubleClick event

Specified by:
addDoubleClickListener in interface IDoubleClickEventCapability
Parameters:
listener - the doubleClick listener to add

removeDoubleClickListener

public final void removeDoubleClickListener(IDoubleClickListener listener)
Description copied from interface: IDoubleClickEventCapability
Removes a listener from the component for the doubleClick event

Specified by:
removeDoubleClickListener in interface IDoubleClickEventCapability
Parameters:
listener - the doubleClick listener to remove

listDoubleClickListeners

public final FacesListener[] listDoubleClickListeners()
Description copied from interface: IDoubleClickEventCapability
Returns a list of doubleClick listener for the component

Specified by:
listDoubleClickListeners in interface IDoubleClickEventCapability
Returns:
doubleClick 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

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class AbstractCommandComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.