org.rcfaces.core.component
Class BoxComponent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.rcfaces.core.internal.component.CameliaBaseComponent
              org.rcfaces.core.component.AbstractBasicComponent
                  org.rcfaces.core.component.BoxComponent

All Implemented Interfaces:

StateHolder, IAsyncDecodeModeCapability, IAsyncRenderModeCapability, IBackgroundImageCapability, IBorderCapability, IClientDataCapability, IErrorEventCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IInitEventCapability, ILayoutManagerCapability, ILayoutPositionCapability, ILoadEventCapability, ILookAndFeelCapability, IMarginCapability, IMenuCapability, IMouseEventCapability, IOverStyleClassCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, IToolTipCapability, ITypedComponentCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, org.rcfaces.core.internal.capability.IAsyncRenderComponent, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.capability.IVariableScopeCapability, 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 BoxComponent
extends AbstractBasicComponent
implements IBackgroundImageCapability, IBorderCapability, IMouseEventCapability, IInitEventCapability, ILoadEventCapability, ILayoutManagerCapability, IMenuCapability, IAsyncRenderModeCapability, IAsyncDecodeModeCapability, org.rcfaces.core.internal.capability.IVariableScopeCapability, ITypedComponentCapability, IOverStyleClassCapability, org.rcfaces.core.internal.capability.IAsyncRenderComponent

The Box Component is a container.

It can have a graphical representation or not; But it is mainly used to apply a collective treatment to a set of component, for example show or hide a group of component.

The Box Component has the following capabilities :

• IBackgroundImageCapability
• IBorderCapability
• IMouseEventCapability
• IInitEventCapability
• ILoadEventCapability
• IMenuCapability
• IAsyncRenderModeCapability
• IAsyncDecodeModeCapability
• ITypedComponentCapability
• IOverStyleClassCapability
• IScrollableCapability

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

Table of component style classes :

Style Name	Description
f_box	Defines styles for the wrapper element of the component

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.ILayoutManagerCapability

ABSOLUTE_LAYOUT_TYPE, INHERITED_LAYOUT_TYPE, NONE_LAYOUT_TYPE

Fields inherited from interface org.rcfaces.core.component.capability.IAsyncRenderModeCapability

BUFFER_ASYNC_RENDER_MODE, DEFAULT_ASYNC_RENDER_MODE, NONE_ASYNC_RENDER_MODE, TREE_ASYNC_RENDER_MODE

Fields inherited from interface org.rcfaces.core.component.capability.IAsyncDecodeModeCapability

COMPLETE_ASYNC_DECODE_MODE, DEFAULT_ASYNC_DECODE_MODE, PARTIAL_ASYNC_DECODE_MODE

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

BoxComponent()

BoxComponent(String componentId)

Method Summary

void	addInitListener(IInitListener listener) Adds a listener to the component for the init event
void	addLoadListener(ILoadListener listener) Adds a listener to the component for the load 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
int	getAsyncDecodeMode() Returns a int value that indicates the decoding mode for asynchronous capable component.
int	getAsyncDecodeMode(FacesContext facesContext) See getAsyncDecodeMode() for more details
int	getAsyncRenderMode() Returns a int value that indicates the rendering mode for asynchronous capable component.
int	getAsyncRenderMode(FacesContext facesContext) See getAsyncRenderMode() for more details
String	getBackgroundImageHorizontalPosition() Returns a string indicating the horizontal positionning for the background image.
String	getBackgroundImageHorizontalPosition(FacesContext facesContext) See getBackgroundImageHorizontalPosition() for more details
String	getBackgroundImageURL() Returns an url string pointing to the background image.
String	getBackgroundImageURL(FacesContext facesContext) See getBackgroundImageURL() for more details
String	getBackgroundImageVerticalPosition() Returns a string indicating the vertical positionning for the background image.
String	getBackgroundImageVerticalPosition(FacesContext facesContext) See getBackgroundImageVerticalPosition() for more details
protected Set	getCameliaFields()
int	getLayoutType()
int	getLayoutType(FacesContext facesContext) See getLayoutType() for more details
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.
String	getOverStyleClass()
String	getOverStyleClass(FacesContext facesContext) See getOverStyleClass() for more details
Object	getScopeValue()
Object	getScopeValue(FacesContext facesContext) See getScopeValue() for more details
String	getScopeVar()
String	getScopeVar(FacesContext facesContext) See getScopeVar() for more details
String	getType()
String	getType(FacesContext facesContext) See getType() for more details
boolean	isAsyncDecodeModeSetted() Returns true if the attribute "asyncDecodeMode" is set.
boolean	isAsyncRenderModeSetted() Returns true if the attribute "asyncRenderMode" is set.
boolean	isBackgroundImageHorizontalPositionSetted() Returns true if the attribute "backgroundImageHorizontalPosition" is set.
boolean	isBackgroundImageHorizontalRepeat() Returns a boolean value indicating wether the background image should be repeated horizontally or not.
boolean	isBackgroundImageHorizontalRepeat(FacesContext facesContext) See isBackgroundImageHorizontalRepeat() for more details
boolean	isBackgroundImageHorizontalRepeatSetted() Returns true if the attribute "backgroundImageHorizontalRepeat" is set.
boolean	isBackgroundImageURLSetted() Returns true if the attribute "backgroundImageURL" is set.
boolean	isBackgroundImageVerticalPositionSetted() Returns true if the attribute "backgroundImageVerticalPosition" is set.
boolean	isBackgroundImageVerticalRepeat() Returns a boolean value indicating wether the background image should be repeated vertically or not.
boolean	isBackgroundImageVerticalRepeat(FacesContext facesContext) See isBackgroundImageVerticalRepeat() for more details
boolean	isBackgroundImageVerticalRepeatSetted() Returns true if the attribute "backgroundImageVerticalRepeat" is set.
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	isHorizontalScroll() Returns a boolean value indicating wether the horizontal scroll is shown.
boolean	isHorizontalScroll(FacesContext facesContext) Returns a boolean value indicating wether the horizontal scroll is shown.
boolean	isHorizontalScrollSetted() Returns true if the attribute "horizontalScroll" is set.
boolean	isLayoutTypeSetted() Returns true if the attribute "layoutType" is set.
boolean	isOverStyleClassSetted() Returns true if the attribute "overStyleClass" is set.
boolean	isScopeSaveValue()
boolean	isScopeSaveValue(FacesContext facesContext) See isScopeSaveValue() for more details
boolean	isScopeSaveValueSetted() Returns true if the attribute "scopeSaveValue" is set.
boolean	isScopeValueSetted() Returns true if the attribute "scopeValue" is set.
boolean	isScopeVarSetted() Returns true if the attribute "scopeVar" is set.
boolean	isTypeSetted() Returns true if the attribute "type" is set.
boolean	isVerticalScroll() Returns a boolean value indicating wether the vertical scroll is shown.
boolean	isVerticalScroll(FacesContext facesContext) Returns a boolean value indicating wether the vertical scroll is shown.
boolean	isVerticalScrollSetted() Returns true if the attribute "verticalScroll" is set.
FacesListener[]	listInitListeners() Returns a list of init listener for the component
FacesListener[]	listLoadListeners() Returns a list of load 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	removeInitListener(IInitListener listener) Removes a listener from the component for the init event
void	removeLoadListener(ILoadListener listener) Removes a listener from the component for the load 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	setAsyncDecodeMode(int asyncDecodeMode) Sets a int value that indicates the decoding mode for asynchronous capable component.
void	setAsyncDecodeMode(String asyncDecodeMode)
void	setAsyncRenderMode(int asyncRenderMode) Sets a int value that indicates the rendering mode for asynchronous capable component.
void	setAsyncRenderMode(String asyncRenderMode)
void	setBackgroundImageHorizontalPosition(String backgroundImageHorizontalPosition) Sets a string indicating the horizontal positionning for the background image.
void	setBackgroundImageHorizontalRepeat(boolean backgroundImageHorizontalRepeat) Sets a boolean value indicating wether the background image should be repeated horizontally or not.
void	setBackgroundImageURL(String backgroundImageURL) Sets an url string pointing to the background image.
void	setBackgroundImageVerticalPosition(String backgroundImageVerticalPosition) Sets a string indicating the vertical positionning for the background image.
void	setBackgroundImageVerticalRepeat(boolean backgroundImageVerticalRepeat) Sets a boolean value indicating wether the background image should be repeated vertically or not.
void	setBorder(boolean border) Sets a boolean value that indicates if the component should show a border or not.
void	setHorizontalScroll(boolean horizontalScroll) Sets a boolean value indicating wether the horizontal scroll is shown.
void	setLayoutType(int layoutType)
void	setLayoutType(String type)
void	setOverStyleClass(String overStyleClass)
void	setScopeSaveValue(boolean scopeSaveValue)
void	setScopeValue(Object scopeValue)
void	setScopeVar(String scopeVar)
void	setType(String type)
void	setVerticalScroll(boolean verticalScroll) Sets a boolean value indicating wether the vertical scroll is shown.

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.capability.IAsyncRenderComponent

getAsyncRenderer

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

BoxComponent

public BoxComponent()

BoxComponent

public BoxComponent(String componentId)

Method Detail

setAsyncRenderMode

public void setAsyncRenderMode(String asyncRenderMode)

setAsyncDecodeMode

public void setAsyncDecodeMode(String asyncDecodeMode)

setLayoutType

public void setLayoutType(String type)

getBackgroundImageHorizontalPosition

public String getBackgroundImageHorizontalPosition()

Description copied from interface: IBackgroundImageCapability

Returns a string indicating the horizontal positionning for the background image.

Specified by:

getBackgroundImageHorizontalPosition in interface IBackgroundImageCapability

Returns:

horizontal position

getBackgroundImageHorizontalPosition

public String getBackgroundImageHorizontalPosition(FacesContext facesContext)

See getBackgroundImageHorizontalPosition() for more details

isBackgroundImageHorizontalPositionSetted

public final boolean isBackgroundImageHorizontalPositionSetted()

Returns true if the attribute "backgroundImageHorizontalPosition" is set.

Returns:

true if the attribute is set.

setBackgroundImageHorizontalPosition

public void setBackgroundImageHorizontalPosition(String backgroundImageHorizontalPosition)

Description copied from interface: IBackgroundImageCapability

Sets a string indicating the horizontal positionning for the background image.

Specified by:

setBackgroundImageHorizontalPosition in interface IBackgroundImageCapability

Parameters:

backgroundImageHorizontalPosition - horizontal position

isBackgroundImageHorizontalRepeat

public boolean isBackgroundImageHorizontalRepeat()

Description copied from interface: IBackgroundImageCapability

Returns a boolean value indicating wether the background image should be repeated horizontally or not.

Specified by:

isBackgroundImageHorizontalRepeat in interface IBackgroundImageCapability

Returns:

repeat

isBackgroundImageHorizontalRepeat

public boolean isBackgroundImageHorizontalRepeat(FacesContext facesContext)

See isBackgroundImageHorizontalRepeat() for more details

isBackgroundImageHorizontalRepeatSetted

public final boolean isBackgroundImageHorizontalRepeatSetted()

Returns true if the attribute "backgroundImageHorizontalRepeat" is set.

Returns:

true if the attribute is set.

setBackgroundImageHorizontalRepeat

public void setBackgroundImageHorizontalRepeat(boolean backgroundImageHorizontalRepeat)

Description copied from interface: IBackgroundImageCapability

Sets a boolean value indicating wether the background image should be repeated horizontally or not.

Specified by:

setBackgroundImageHorizontalRepeat in interface IBackgroundImageCapability

Parameters:

backgroundImageHorizontalRepeat - boolean

getBackgroundImageURL

public String getBackgroundImageURL()

Description copied from interface: IBackgroundImageCapability

Returns an url string pointing to the background image.

Specified by:

getBackgroundImageURL in interface IBackgroundImageCapability

Returns:

image url

getBackgroundImageURL

public String getBackgroundImageURL(FacesContext facesContext)

See getBackgroundImageURL() for more details

isBackgroundImageURLSetted

public final boolean isBackgroundImageURLSetted()

Returns true if the attribute "backgroundImageURL" is set.

Returns:

true if the attribute is set.

setBackgroundImageURL

public void setBackgroundImageURL(String backgroundImageURL)

Description copied from interface: IBackgroundImageCapability

Sets an url string pointing to the background image.

Specified by:

setBackgroundImageURL in interface IBackgroundImageCapability

Parameters:

backgroundImageURL - image url

getBackgroundImageVerticalPosition

public String getBackgroundImageVerticalPosition()

Description copied from interface: IBackgroundImageCapability

Returns a string indicating the vertical positionning for the background image.

Specified by:

getBackgroundImageVerticalPosition in interface IBackgroundImageCapability

Returns:

vertical position

getBackgroundImageVerticalPosition

public String getBackgroundImageVerticalPosition(FacesContext facesContext)

See getBackgroundImageVerticalPosition() for more details

isBackgroundImageVerticalPositionSetted

public final boolean isBackgroundImageVerticalPositionSetted()

Returns true if the attribute "backgroundImageVerticalPosition" is set.

Returns:

true if the attribute is set.

setBackgroundImageVerticalPosition

public void setBackgroundImageVerticalPosition(String backgroundImageVerticalPosition)

Description copied from interface: IBackgroundImageCapability

Sets a string indicating the vertical positionning for the background image.

Specified by:

setBackgroundImageVerticalPosition in interface IBackgroundImageCapability

Parameters:

backgroundImageVerticalPosition - position

isBackgroundImageVerticalRepeat

public boolean isBackgroundImageVerticalRepeat()

Description copied from interface: IBackgroundImageCapability

Returns a boolean value indicating wether the background image should be repeated vertically or not.

Specified by:

isBackgroundImageVerticalRepeat in interface IBackgroundImageCapability

Returns:

repeat

isBackgroundImageVerticalRepeat

public boolean isBackgroundImageVerticalRepeat(FacesContext facesContext)

See isBackgroundImageVerticalRepeat() for more details

isBackgroundImageVerticalRepeatSetted

public final boolean isBackgroundImageVerticalRepeatSetted()

Returns true if the attribute "backgroundImageVerticalRepeat" is set.

Returns:

true if the attribute is set.

setBackgroundImageVerticalRepeat

public void setBackgroundImageVerticalRepeat(boolean backgroundImageVerticalRepeat)

Description copied from interface: IBackgroundImageCapability

Sets a boolean value indicating wether the background image should be repeated vertically or not.

Specified by:

setBackgroundImageVerticalRepeat in interface IBackgroundImageCapability

Parameters:

backgroundImageVerticalRepeat - boolean

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

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

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

addLoadListener

public final void addLoadListener(ILoadListener listener)

Description copied from interface: ILoadEventCapability

Adds a listener to the component for the load event

Specified by:

addLoadListener in interface ILoadEventCapability

Parameters:

listener - the load listener to add

removeLoadListener

public final void removeLoadListener(ILoadListener listener)

Description copied from interface: ILoadEventCapability

Removes a listener from the component for the load event

Specified by:

removeLoadListener in interface ILoadEventCapability

Parameters:

listener - the load listener to remove

listLoadListeners

public final FacesListener[] listLoadListeners()

Description copied from interface: ILoadEventCapability

Returns a list of load listener for the component

Specified by:

listLoadListeners in interface ILoadEventCapability

Returns:

load listeners' list

getLayoutType

public int getLayoutType()

Specified by:

getLayoutType in interface ILayoutManagerCapability

getLayoutType

public int getLayoutType(FacesContext facesContext)

See getLayoutType() for more details

isLayoutTypeSetted

public final boolean isLayoutTypeSetted()

Returns true if the attribute "layoutType" is set.

Returns:

true if the attribute is set.

setLayoutType

public void setLayoutType(int layoutType)

Specified by:

setLayoutType in interface ILayoutManagerCapability

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

getAsyncRenderMode

public int getAsyncRenderMode()

Description copied from interface: IAsyncRenderModeCapability

Returns a int value that indicates the rendering mode for asynchronous capable component.

Specified by:

getAsyncRenderMode in interface IAsyncRenderModeCapability

Returns:

0:none|1:buffer|2:tree

getAsyncRenderMode

public int getAsyncRenderMode(FacesContext facesContext)

See getAsyncRenderMode() for more details

isAsyncRenderModeSetted

public final boolean isAsyncRenderModeSetted()

Returns true if the attribute "asyncRenderMode" is set.

Returns:

true if the attribute is set.

setAsyncRenderMode

public void setAsyncRenderMode(int asyncRenderMode)

Description copied from interface: IAsyncRenderModeCapability

Sets a int value that indicates the rendering mode for asynchronous capable component.

Specified by:

setAsyncRenderMode in interface IAsyncRenderModeCapability

Parameters:

asyncRenderMode - 0:none|1:buffer|2:tree

getAsyncDecodeMode

public int getAsyncDecodeMode()

Description copied from interface: IAsyncDecodeModeCapability

Returns a int value that indicates the decoding mode for asynchronous capable component.

Specified by:

getAsyncDecodeMode in interface IAsyncDecodeModeCapability

Returns:

0:complete|1:partial

getAsyncDecodeMode

public int getAsyncDecodeMode(FacesContext facesContext)

See getAsyncDecodeMode() for more details

isAsyncDecodeModeSetted

public final boolean isAsyncDecodeModeSetted()

Returns true if the attribute "asyncDecodeMode" is set.

Returns:

true if the attribute is set.

setAsyncDecodeMode

public void setAsyncDecodeMode(int asyncDecodeMode)

Description copied from interface: IAsyncDecodeModeCapability

Sets a int value that indicates the decoding mode for asynchronous capable component.

Specified by:

setAsyncDecodeMode in interface IAsyncDecodeModeCapability

Parameters:

asyncDecodeMode - 0:complete|1:partial

isScopeSaveValue

public boolean isScopeSaveValue()

Specified by:

isScopeSaveValue in interface org.rcfaces.core.internal.capability.IVariableScopeCapability

isScopeSaveValue

public boolean isScopeSaveValue(FacesContext facesContext)

See isScopeSaveValue() for more details

isScopeSaveValueSetted

public final boolean isScopeSaveValueSetted()

Returns true if the attribute "scopeSaveValue" is set.

Returns:

true if the attribute is set.

setScopeSaveValue

public void setScopeSaveValue(boolean scopeSaveValue)

Specified by:

setScopeSaveValue in interface org.rcfaces.core.internal.capability.IVariableScopeCapability

getScopeValue

public Object getScopeValue()

Specified by:

getScopeValue in interface org.rcfaces.core.internal.capability.IVariableScopeCapability

getScopeValue

public Object getScopeValue(FacesContext facesContext)

See getScopeValue() for more details

isScopeValueSetted

public final boolean isScopeValueSetted()

Returns true if the attribute "scopeValue" is set.

Returns:

true if the attribute is set.

setScopeValue

public void setScopeValue(Object scopeValue)

Specified by:

setScopeValue in interface org.rcfaces.core.internal.capability.IVariableScopeCapability

getScopeVar

public String getScopeVar()

Specified by:

getScopeVar in interface org.rcfaces.core.internal.capability.IVariableScopeCapability

getScopeVar

public String getScopeVar(FacesContext facesContext)

See getScopeVar() for more details

isScopeVarSetted

public final boolean isScopeVarSetted()

Returns true if the attribute "scopeVar" is set.

Returns:

true if the attribute is set.

setScopeVar

public void setScopeVar(String scopeVar)

Specified by:

setScopeVar in interface org.rcfaces.core.internal.capability.IVariableScopeCapability

getType

public String getType()

Specified by:

getType in interface ITypedComponentCapability

getType

public String getType(FacesContext facesContext)

See getType() for more details

isTypeSetted

public final boolean isTypeSetted()

Returns true if the attribute "type" is set.

Returns:

true if the attribute is set.

setType

public void setType(String type)

Specified by:

setType in interface ITypedComponentCapability

getOverStyleClass

public String getOverStyleClass()

Specified by:

getOverStyleClass in interface IOverStyleClassCapability

getOverStyleClass

public String getOverStyleClass(FacesContext facesContext)

See getOverStyleClass() for more details

isOverStyleClassSetted

public final boolean isOverStyleClassSetted()

Returns true if the attribute "overStyleClass" is set.

Returns:

true if the attribute is set.

setOverStyleClass

public void setOverStyleClass(String overStyleClass)

Specified by:

setOverStyleClass in interface IOverStyleClassCapability

isHorizontalScroll

public boolean isHorizontalScroll()

Returns a boolean value indicating wether the horizontal scroll is shown.

Returns:

true if the horizontal scrollbar is shown

isHorizontalScroll

public boolean isHorizontalScroll(FacesContext facesContext)

Returns a boolean value indicating wether the horizontal scroll is shown.

Returns:

true if the horizontal scrollbar is shown

setHorizontalScroll

public void setHorizontalScroll(boolean horizontalScroll)

Sets a boolean value indicating wether the horizontal scroll is shown.

Parameters:

horizontalScroll - true if the horizontal scrollbar is to be shown

isHorizontalScrollSetted

public boolean isHorizontalScrollSetted()

Returns true if the attribute "horizontalScroll" is set.

Returns:

true if the attribute is set.

isVerticalScroll

public boolean isVerticalScroll()

Returns a boolean value indicating wether the vertical scroll is shown.

Returns:

true if vertical scrollbar is shown

isVerticalScroll

public boolean isVerticalScroll(FacesContext facesContext)

Returns a boolean value indicating wether the vertical scroll is shown.

Returns:

true if vertical scrollbar is shown

setVerticalScroll

public void setVerticalScroll(boolean verticalScroll)

Sets a boolean value indicating wether the vertical scroll is shown.

Parameters:

verticalScroll - true if vertical scrollbar is to be shown

isVerticalScrollSetted

public boolean isVerticalScrollSetted()

Returns true if the attribute "verticalScroll" is set.

Returns:

true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class AbstractBasicComponent