org.rcfaces.core.component
Class ToolBarComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.rcfaces.core.internal.component.CameliaBaseComponent
              extended by org.rcfaces.core.component.AbstractBasicComponent
                  extended by org.rcfaces.core.component.ToolBarComponent
All Implemented Interfaces:
StateHolder, IBorderTypeCapability, IClientDataCapability, IErrorEventCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IInitEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IVerticalAlignmentCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, 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 ToolBarComponent
extends AbstractBasicComponent
implements IInitEventCapability, IVerticalAlignmentCapability, IBorderTypeCapability, org.rcfaces.core.internal.capability.IImageAccessorsCapability

The toolBar component allows developers to easily add toolbars containing diffenrent components

The toolBar Component has the following capabilities :

The default toolBar renderer is linked to the f_toolBar javascript class. f_toolBar extends f_component

Table of component style classes:

Style Name Description
f_toolBar Defines styles for the wrapper DIV element


Field Summary
protected static Set CAMELIA_ATTRIBUTES
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.rcfaces.core.internal.component.CameliaBaseComponent
engine
 
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
ToolBarComponent()
           
ToolBarComponent(String componentId)
           
 
Method Summary
 void addInitListener(IInitListener listener)
          Adds a listener to the component for the init 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()
           
 String getControlAlternateText()
           
 String getControlAlternateText(FacesContext facesContext)
           
 int getControlImageHeight()
           
 int getControlImageHeight(FacesContext facesContext)
           
 String getControlImageURL()
           
 String getControlImageURL(FacesContext facesContext)
           
 int getControlImageWidth()
           
 int getControlImageWidth(FacesContext facesContext)
           
 IContentAccessors getImageAccessors(FacesContext facesContext)
           
 int getItemPadding()
           
 int getItemPadding(FacesContext facesContext)
           
 String getSeparatorAlternateText()
           
 String getSeparatorAlternateText(FacesContext facesContext)
           
 int getSeparatorImageHeight()
           
 int getSeparatorImageHeight(FacesContext facesContext)
           
 String getSeparatorImageURL()
           
 String getSeparatorImageURL(FacesContext facesContext)
           
 int getSeparatorImageWidth()
           
 int getSeparatorImageWidth(FacesContext facesContext)
           
 String getVerticalAlignment()
          Returns vertical alignment.
 String getVerticalAlignment(FacesContext facesContext)
          See getVerticalAlignment() for more details
 boolean isBorderTypeSetted()
          Returns true if the attribute "borderType" is set.
 boolean isControlAlternateTextSetted()
          Returns true if the attribute "controlAlternateText" is set.
 boolean isControlImageHeightSetted()
          Returns true if the attribute "controlImageHeight" is set.
 boolean isControlImageURLSetted()
          Returns true if the attribute "controlImageURL" is set.
 boolean isControlImageWidthSetted()
          Returns true if the attribute "controlImageWidth" is set.
 boolean isItemPaddingSetted()
          Returns true if the attribute "itemPadding" is set.
 boolean isLocked()
           
 boolean isLocked(FacesContext facesContext)
           
 boolean isLockedSetted()
          Returns true if the attribute "locked" is set.
 boolean isSeparatorAlternateTextSetted()
          Returns true if the attribute "separatorAlternateText" is set.
 boolean isSeparatorImageHeightSetted()
          Returns true if the attribute "separatorImageHeight" is set.
 boolean isSeparatorImageURLSetted()
          Returns true if the attribute "separatorImageURL" is set.
 boolean isSeparatorImageWidthSetted()
          Returns true if the attribute "separatorImageWidth" is set.
 boolean isVerticalAlignmentSetted()
          Returns true if the attribute "verticalAlignment" is set.
 FacesListener[] listInitListeners()
          Returns a list of init listener for the component
 IToolFolderIterator listToolFolders()
           
 void removeInitListener(IInitListener listener)
          Removes a listener from the component for the init event
 void setBorderType(String borderType)
          Sets a string that indicates the type of border the component should show.
 void setControlAlternateText(String controlAlternateText)
           
 void setControlImageHeight(int controlImageHeight)
           
 void setControlImageURL(String controlImageURL)
           
 void setControlImageWidth(int controlImageWidth)
           
 void setItemPadding(int itemPadding)
           
 void setLocked(boolean locked)
           
 void setSeparatorAlternateText(String separatorAlternateText)
           
 void setSeparatorImageHeight(int separatorImageHeight)
           
 void setSeparatorImageURL(String separatorImageURL)
           
 void setSeparatorImageWidth(int separatorImageWidth)
           
 void setVerticalAlignment(String verticalAlignment)
          Specifies vertical alignment.
 
Methods inherited from class org.rcfaces.core.component.AbstractBasicComponent
addErrorListener, addPropertyChangeListener, addUserEventListener, getAriaLabel, getAriaLabel, getAriaLevel, getAriaLevel, getBackgroundColor, getBackgroundColor, getBottom, getBottom, getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, 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, getToolTipText, getToolTipText, getTop, getTop, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isAriaLabelSetted, isAriaLevelSetted, isBackgroundColorSetted, isBottomSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isLeftSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isPartialRendering, isPartialRendering, isPartialRenderingSetted, isRightSetted, isStyleClassSetted, isToolTipTextSetted, isTopSetted, isUnlockedClientAttributeNamesSetted, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWidthSetted, isXSetted, isYSetted, listClientDataKeys, listClientDataKeys, listErrorListeners, listPropertyChangeListeners, listServerDataKeys, listServerDataKeys, listUserEventListeners, removeClientData, removeErrorListener, removePropertyChangeListener, removeServerData, removeUserEventListener, setAriaLabel, setAriaLevel, setBackgroundColor, setBottom, setClientData, setClientData, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setLeft, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPartialRendering, setRight, setServerData, setServerData, setStyleClass, setToolTipText, setTop, setUnlockedClientAttributeNames, setVisible, setWaiRole, setWidth, setX, setY
 
Methods inherited from class org.rcfaces.core.internal.component.CameliaBaseComponent
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.UIComponentBase
addFacesListener, broadcast, 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.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

ToolBarComponent

public ToolBarComponent()

ToolBarComponent

public ToolBarComponent(String componentId)
Method Detail

getImageAccessors

public IContentAccessors getImageAccessors(FacesContext facesContext)
Specified by:
getImageAccessors in interface org.rcfaces.core.internal.capability.IImageAccessorsCapability

listToolFolders

public IToolFolderIterator listToolFolders()

addInitListener

public final void addInitListener(IInitListener listener)
Description copied from interface: IInitEventCapability
Adds a listener to the component for the init event

Specified by:
addInitListener in interface IInitEventCapability
Parameters:
listener - the init listener to add

removeInitListener

public final void removeInitListener(IInitListener listener)
Description copied from interface: IInitEventCapability
Removes a listener from the component for the init event

Specified by:
removeInitListener in interface IInitEventCapability
Parameters:
listener - the init listener to remove

listInitListeners

public final FacesListener[] listInitListeners()
Description copied from interface: IInitEventCapability
Returns a list of init listener for the component

Specified by:
listInitListeners in interface IInitEventCapability
Returns:
init listeners' list

getVerticalAlignment

public String getVerticalAlignment()
Description copied from interface: IVerticalAlignmentCapability
Returns vertical alignment.

Specified by:
getVerticalAlignment in interface IVerticalAlignmentCapability
Returns:
vertical alignment

getVerticalAlignment

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


isVerticalAlignmentSetted

public final boolean isVerticalAlignmentSetted()
Returns true if the attribute "verticalAlignment" is set.

Returns:
true if the attribute is set.

setVerticalAlignment

public void setVerticalAlignment(String verticalAlignment)
Description copied from interface: IVerticalAlignmentCapability
Specifies vertical alignment.

Specified by:
setVerticalAlignment in interface IVerticalAlignmentCapability
Parameters:
verticalAlignment - vertical alignment

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

getSeparatorImageURL

public String getSeparatorImageURL()

getSeparatorImageURL

public String getSeparatorImageURL(FacesContext facesContext)

setSeparatorImageURL

public void setSeparatorImageURL(String separatorImageURL)

isSeparatorImageURLSetted

public boolean isSeparatorImageURLSetted()
Returns true if the attribute "separatorImageURL" is set.

Returns:
true if the attribute is set.

getSeparatorImageWidth

public int getSeparatorImageWidth()

getSeparatorImageWidth

public int getSeparatorImageWidth(FacesContext facesContext)

setSeparatorImageWidth

public void setSeparatorImageWidth(int separatorImageWidth)

isSeparatorImageWidthSetted

public boolean isSeparatorImageWidthSetted()
Returns true if the attribute "separatorImageWidth" is set.

Returns:
true if the attribute is set.

getSeparatorImageHeight

public int getSeparatorImageHeight()

getSeparatorImageHeight

public int getSeparatorImageHeight(FacesContext facesContext)

setSeparatorImageHeight

public void setSeparatorImageHeight(int separatorImageHeight)

isSeparatorImageHeightSetted

public boolean isSeparatorImageHeightSetted()
Returns true if the attribute "separatorImageHeight" is set.

Returns:
true if the attribute is set.

getSeparatorAlternateText

public String getSeparatorAlternateText()

getSeparatorAlternateText

public String getSeparatorAlternateText(FacesContext facesContext)

setSeparatorAlternateText

public void setSeparatorAlternateText(String separatorAlternateText)

isSeparatorAlternateTextSetted

public boolean isSeparatorAlternateTextSetted()
Returns true if the attribute "separatorAlternateText" is set.

Returns:
true if the attribute is set.

getControlImageURL

public String getControlImageURL()

getControlImageURL

public String getControlImageURL(FacesContext facesContext)

setControlImageURL

public void setControlImageURL(String controlImageURL)

isControlImageURLSetted

public boolean isControlImageURLSetted()
Returns true if the attribute "controlImageURL" is set.

Returns:
true if the attribute is set.

getControlImageWidth

public int getControlImageWidth()

getControlImageWidth

public int getControlImageWidth(FacesContext facesContext)

setControlImageWidth

public void setControlImageWidth(int controlImageWidth)

isControlImageWidthSetted

public boolean isControlImageWidthSetted()
Returns true if the attribute "controlImageWidth" is set.

Returns:
true if the attribute is set.

getControlImageHeight

public int getControlImageHeight()

getControlImageHeight

public int getControlImageHeight(FacesContext facesContext)

setControlImageHeight

public void setControlImageHeight(int controlImageHeight)

isControlImageHeightSetted

public boolean isControlImageHeightSetted()
Returns true if the attribute "controlImageHeight" is set.

Returns:
true if the attribute is set.

getControlAlternateText

public String getControlAlternateText()

getControlAlternateText

public String getControlAlternateText(FacesContext facesContext)

setControlAlternateText

public void setControlAlternateText(String controlAlternateText)

isControlAlternateTextSetted

public boolean isControlAlternateTextSetted()
Returns true if the attribute "controlAlternateText" is set.

Returns:
true if the attribute is set.

getItemPadding

public int getItemPadding()

getItemPadding

public int getItemPadding(FacesContext facesContext)

setItemPadding

public void setItemPadding(int itemPadding)

isItemPaddingSetted

public boolean isItemPaddingSetted()
Returns true if the attribute "itemPadding" is set.

Returns:
true if the attribute is set.

isLocked

public boolean isLocked()

isLocked

public boolean isLocked(FacesContext facesContext)

setLocked

public void setLocked(boolean locked)

isLockedSetted

public boolean isLockedSetted()
Returns true if the attribute "locked" is set.

Returns:
true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class AbstractBasicComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.