org.rcfaces.core.component
Class HelpButtonComponent

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
                          extended by org.rcfaces.core.component.ImageButtonComponent
                              extended by org.rcfaces.core.component.HelpButtonComponent
All Implemented Interfaces:
ActionSource, ActionSource2, StateHolder, IAccessKeyCapability, IAlternateTextCapability, IBorderCapability, IBorderTypeCapability, IClientDataCapability, IDisabledCapability, IErrorEventCapability, IFocusBlurEventCapability, IFocusStyleClassCapability, IFontCapability, IForCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IHorizontalTextPositionCapability, IImageCapability, IImageSizeCapability, IImmediateCapability, IInitEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IReadOnlyCapability, ISelectionEventCapability, IServerDataCapability, ISizeCapability, IStatesImageCapability, IStyleClassCapability, ITabIndexCapability, ITextAlignmentCapability, ITextCapability, ITextDirectionCapability, ITextPositionCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValidationEventCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, IImageButtonFamilly, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IImageAccessorsCapability, 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 HelpButtonComponent
extends ImageButtonComponent
implements IForCapability

The helpButton Component is an ImageButton. It opens a new page showing the url specified in the "helpUrl" property of a component linked by the "for" property.

The helpButton Component has the following capabilities :

The default helpButton renderer is link to the f_helpButton javascript class. f_helpButton extends f_imageButton

Table of component style classes :

The server reported an error while performing the "cvs commit" command. org.rcfaces.core: cvs commit: sticky tag `1.3' for file `metadatas/camelia-doc.xml' is not a branch org.rcfaces.core: cvs [commit aborted]: correct above errors first!
Style Name Description
f_helpButton Defines styles for the wrapper DIV element
f_helpButton_ctext Defines styles for the button Text
f_helpButton_cimage Defines styles for the button Image


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.ITextPositionCapability
BOTTOM_POSITION, TOP_POSITION
 
Fields inherited from interface org.rcfaces.core.component.capability.IHorizontalTextPositionCapability
CENTER_POSITION, DEFAULT_POSITION, LEFT_POSITION, RIGHT_POSITION, UNKNOWN_POSITION
 
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
HelpButtonComponent()
           
HelpButtonComponent(String componentId)
           
 
Method Summary
protected  Set getCameliaFields()
           
 String getFor()
          Returns a component's id that express the link between the two components.
 String getFor(FacesContext facesContext)
          See getFor() for more details
 boolean isForSetted()
          Returns true if the attribute "for" is set.
 void setFor(String forValue)
          Sets a component's id that express the link between the two components.
 
Methods inherited from class org.rcfaces.core.component.ImageButtonComponent
getBorderType, getBorderType, getDisabledImageURL, getDisabledImageURL, getHoverImageURL, getHoverImageURL, getImageAccessors, getImageAccessors, getImageHeight, getImageHeight, getImageURL, getImageURL, getImageWidth, getImageWidth, getSelectedImageURL, getSelectedImageURL, getTextPosition, getTextPosition, getTextPositionConverter, isBorder, isBorder, isBorderSetted, isBorderTypeSetted, isDisabledImageURLSetted, isHoverImageURLSetted, isImageHeightSetted, isImageURLSetted, isImageWidthSetted, isSelectedImageURLSetted, isTextPositionSetted, setBorder, setBorderType, setDisabledImageURL, setHoverImageURL, setImageHeight, setImageURL, setImageWidth, setSelectedImageURL, setTextPosition, setTextPosition
 
Methods inherited from class org.rcfaces.core.component.ButtonComponent
addSelectionListener, getAlternateText, getAlternateText, getFocusStyleClass, getFocusStyleClass, getText, getText, getTextDirection, getTextDirection, isAlternateTextSetted, isFocusStyleClassSetted, isReadOnly, isReadOnly, isReadOnlySetted, isTextDirectionSetted, isTextSetted, listSelectionListeners, removeSelectionListener, setAlternateText, setFocusStyleClass, setReadOnly, setText, setTextDirection
 
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.familly.IImageButtonFamilly
getTabIndex, getText, isDisabled, isReadOnly
 
Methods inherited from interface org.rcfaces.core.component.capability.ITextCapability
getText, setText
 
Methods inherited from interface org.rcfaces.core.component.capability.ISelectionEventCapability
addSelectionListener, listSelectionListeners, removeSelectionListener
 
Methods inherited from interface org.rcfaces.core.component.capability.IReadOnlyCapability
isReadOnly, setReadOnly
 
Methods inherited from interface org.rcfaces.core.component.capability.IDisabledCapability
isDisabled, setDisabled
 
Methods inherited from interface org.rcfaces.core.component.capability.ITabIndexCapability
getTabIndex, setTabIndex
 
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

HelpButtonComponent

public HelpButtonComponent()

HelpButtonComponent

public HelpButtonComponent(String componentId)
Method Detail

getFor

public String getFor()
Description copied from interface: IForCapability
Returns a component's id that express the link between the two components.

Specified by:
getFor in interface IForCapability
Returns:
id for a linked component

getFor

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


isForSetted

public final boolean isForSetted()
Returns true if the attribute "for" is set.

Returns:
true if the attribute is set.

setFor

public void setFor(String forValue)
Description copied from interface: IForCapability
Sets a component's id that express the link between the two components.

Specified by:
setFor in interface IForCapability
Parameters:
forValue - id for a linked component

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class ImageButtonComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.