org.rcfaces.core.component
Class ToolFolderComponent

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.ToolFolderComponent
All Implemented Interfaces:
StateHolder, IBorderTypeCapability, IClientDataCapability, IDoubleClickEventCapability, IErrorEventCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IInitEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMenuCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IVerticalAlignmentCapability, 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:
TextEditorToolFolderComponent

public class ToolFolderComponent
extends AbstractBasicComponent
implements IInitEventCapability, IMenuCapability, IMouseEventCapability, IDoubleClickEventCapability, IVerticalAlignmentCapability, IBorderTypeCapability

EXPERIMENTAL


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
ToolFolderComponent()
           
ToolFolderComponent(String componentId)
           
 
Method Summary
 void addDoubleClickListener(IDoubleClickListener listener)
          Adds a listener to the component for the doubleClick event
 void addInitListener(IInitListener listener)
          Adds a listener to the component for the init event
 void addMouseOutListener(IMouseOutListener listener)
          Adds a listener to the component for the mouseOut event
 void addMouseOverListener(IMouseOverListener listener)
          Adds a listener to the component for the mouseOver 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()
           
 IMenuComponent getMenu()
          Returns the top-most menu associated to the component.
 IMenuComponent getMenu(String menuId)
          Returns the menu identified by its id from the menus associated to the component.
 ToolBarComponent getToolBar()
           
 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 isVerticalAlignmentSetted()
          Returns true if the attribute "verticalAlignment" is set.
 FacesListener[] listDoubleClickListeners()
          Returns a list of doubleClick listener for the component
 FacesListener[] listInitListeners()
          Returns a list of init listener for the component
 IMenuIterator listMenus()
          Returns a list of all the menus associated to the component.
 FacesListener[] listMouseOutListeners()
          Returns a list of mouseOut listener for the component
 FacesListener[] listMouseOverListeners()
          Returns a list of mouseOver listener for the component
 void removeDoubleClickListener(IDoubleClickListener listener)
          Removes a listener from the component for the doubleClick event
 void removeInitListener(IInitListener listener)
          Removes a listener from the component for the init event
 void removeMouseOutListener(IMouseOutListener listener)
          Removes a listener from the component for the mouseOut event
 void removeMouseOverListener(IMouseOverListener listener)
          Removes a listener from the component for the mouseOver event
 void setBorderType(String borderType)
          Sets a string that indicates the type of border the component should show.
 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

ToolFolderComponent

public ToolFolderComponent()

ToolFolderComponent

public ToolFolderComponent(String componentId)
Method Detail

getToolBar

public ToolBarComponent getToolBar()

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

getMenu

public IMenuComponent getMenu()
Description copied from interface: IMenuCapability
Returns the top-most menu associated to the component.

Specified by:
getMenu in interface IMenuCapability
Returns:
top-most menu component

getMenu

public IMenuComponent getMenu(String menuId)
Description copied from interface: IMenuCapability
Returns the menu identified by its id from the menus associated to the component.

Specified by:
getMenu in interface IMenuCapability
Parameters:
menuId - Id for a particular menu
Returns:
menu component

listMenus

public IMenuIterator listMenus()
Description copied from interface: IMenuCapability
Returns a list of all the menus associated to the component.

Specified by:
listMenus in interface IMenuCapability
Returns:
Menu iterator

addMouseOutListener

public final void addMouseOutListener(IMouseOutListener listener)
Description copied from interface: IMouseEventCapability
Adds a listener to the component for the mouseOut event

Specified by:
addMouseOutListener in interface IMouseEventCapability
Parameters:
listener - the mouseOut listener to add

removeMouseOutListener

public final void removeMouseOutListener(IMouseOutListener listener)
Description copied from interface: IMouseEventCapability
Removes a listener from the component for the mouseOut event

Specified by:
removeMouseOutListener in interface IMouseEventCapability
Parameters:
listener - the mouseOut listener to remove

listMouseOutListeners

public final FacesListener[] listMouseOutListeners()
Description copied from interface: IMouseEventCapability
Returns a list of mouseOut listener for the component

Specified by:
listMouseOutListeners in interface IMouseEventCapability
Returns:
mouseOut listeners' list

addMouseOverListener

public final void addMouseOverListener(IMouseOverListener listener)
Description copied from interface: IMouseEventCapability
Adds a listener to the component for the mouseOver event

Specified by:
addMouseOverListener in interface IMouseEventCapability
Parameters:
listener - the mouseOver listener to add

removeMouseOverListener

public final void removeMouseOverListener(IMouseOverListener listener)
Description copied from interface: IMouseEventCapability
Removes a listener from the component for the mouseOver event

Specified by:
removeMouseOverListener in interface IMouseEventCapability
Parameters:
listener - the mouseOver listener to remove

listMouseOverListeners

public final FacesListener[] listMouseOverListeners()
Description copied from interface: IMouseEventCapability
Returns a list of mouseOver listener for the component

Specified by:
listMouseOverListeners in interface IMouseEventCapability
Returns:
mouseOver 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

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

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class AbstractBasicComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.