org.rcfaces.core.component
Class ExpandBarComponent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              org.rcfaces.core.internal.component.CameliaOutputComponent
                  org.rcfaces.core.component.AbstractOutputComponent
                      org.rcfaces.core.component.ExpandBarComponent

All Implemented Interfaces:

StateHolder, ValueHolder, IAccessKeyCapability, IAsyncRenderModeCapability, IBorderCapability, IClientDataCapability, ICollapsableCapability, IDisabledCapability, IErrorEventCapability, IExpandEventCapability, IFocusBlurEventCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IInitEventCapability, ILayoutPositionCapability, ILoadEventCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IOverStyleClassCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IRadioGroupCapability, IReadOnlyCapability, ISelectionEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, ITabIndexCapability, ITextAlignmentCapability, ITextCapability, ITextDirectionCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValueLockedCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, org.rcfaces.core.internal.capability.IAsyncRenderComponent, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IConvertValueHolder, 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 ExpandBarComponent
extends AbstractOutputComponent
implements IExpandEventCapability, IAsyncRenderModeCapability, IFontCapability, IDisabledCapability, IReadOnlyCapability, ITextCapability, ITextDirectionCapability, ITextAlignmentCapability, ICollapsableCapability, IBorderCapability, IAccessKeyCapability, ITabIndexCapability, IRadioGroupCapability, IFocusBlurEventCapability, ISelectionEventCapability, ILoadEventCapability, org.rcfaces.core.internal.capability.IVariableScopeCapability, IOverStyleClassCapability, org.rcfaces.core.internal.capability.IAsyncRenderComponent

The expandBar Component is a container that can be collapsed to show only a title bar. Expand Bars can be managed by group : only one element of the group is expanded.

The expandBar Component has the following capabilities :

• IExpandEventCapability
• IAsyncRenderModeCapability
• IFontCapability
• IDisabledCapability
• IReadOnlyCapability
• ITextCapability
• ITextDirectionCapability
• ITextAlignmentCapability
• ICollapsableCapability
• IBorderCapability
• IAccessKeyCapability
• ITabIndexCapability
• IRadioGroupCapability
• IFocusBlurEventCapability
• ISelectionEventCapability
• ILoadEventCapability
• IVariableScopeCapability
• IOverStyleClassCapability
• IAsyncRenderComponent

The default expandBar renderer is link to the f_expandBar javascript class. f_expandBar extends f_component, fa_disabled, fa_readOnly, fa_collapsed, fa_groupName, fa_overStyleClass

Table of component style classes:

Style Name	Description
f_expandBar	Defines styles for the wrapper UL element
f_expandBar_head	Defines styles for the LI element for the title.
f_expandBar_body	Defines styles for the element for the body.

Field Summary

protected static Set	CAMELIA_ATTRIBUTES
protected static String	CAMELIA_VALUE_ALIAS
static String	COMPONENT_TYPE

Fields inherited from class org.rcfaces.core.internal.component.CameliaOutputComponent

engine

Fields inherited from class javax.faces.component.UIOutput

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

bindings

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

ExpandBarComponent()

ExpandBarComponent(String componentId)

Method Summary

void	addBlurListener(IBlurListener listener) Adds a listener to the component for the blur event
void	addExpandListener(IExpandListener listener) Adds a listener to the component for the expand event
void	addFocusListener(IFocusListener listener) Adds a listener to the component for the focus event
void	addLoadListener(ILoadListener listener) Adds a listener to the component for the load event
void	addSelectionListener(ISelectionListener listener) Adds a listener to the component for the selection event
String	getAccessKey() Returns a string that indicates the alphanumeric key used to execute an action from the keyboard (in conjunction with a alteration key ex : Alt).
String	getAccessKey(FacesContext facesContext) See getAccessKey() 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
protected Set	getCameliaFields()
protected String	getCameliaValueAlias()
String	getCollapsedText() Returns a string value specifying the text to show when the component is collapsed.
String	getCollapsedText(FacesContext facesContext) Returns a string value specifying the text to show when the component is collapsed.
String	getCollapseEffect() Returns a string value indicating the effect to use when transionning from one state to the other.
String	getCollapseEffect(FacesContext facesContext) Returns a string value indicating the effect to use when transionning from one state to the other.
Boolean	getFontBold() Returns a boolean object (or null) indicating the bold property for the specified font.
Boolean	getFontBold(FacesContext facesContext) See getFontBold() for more details
Boolean	getFontItalic() Returns a boolean object (or null) indicating the italic property for the specified font.
Boolean	getFontItalic(FacesContext facesContext) See getFontItalic() for more details
String	getFontName() Returns a string value indicating the name of the font used for this component.
String	getFontName(FacesContext facesContext) See getFontName() for more details
String	getFontSize() Returns a string indicating the size to use for the selected font.
String	getFontSize(FacesContext facesContext) See getFontSize() for more details
Boolean	getFontUnderline() Returns a boolean object (or null) indicating the underline property for the specified font.
Boolean	getFontUnderline(FacesContext facesContext) See getFontUnderline() for more details
String	getGroupName() Returns a string specifying the name of the virtual entity that links different components together.
String	getGroupName(FacesContext facesContext) See getGroupName() for more details
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
Integer	getTabIndex() Returns an int value specifying the position of this element in the tabbing order for the current document.
Integer	getTabIndex(FacesContext facesContext) See getTabIndex() for more details
String	getText() Returns a string value specifying the text shown.
String	getText(FacesContext facesContext) See getText() for more details
String	getTextAlignment() Returns horizontal alignment.
String	getTextAlignment(FacesContext facesContext) See getTextAlignment() for more details
int	getTextDirection()
int	getTextDirection(FacesContext facesContext) See getTextDirection() for more details
boolean	isAccessKeySetted() Returns true if the attribute "accessKey" is set.
boolean	isAsyncRenderModeSetted() Returns true if the attribute "asyncRenderMode" 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	isCollapsed() Returns a boolean value indicating wether the component is collapsed.
boolean	isCollapsed(FacesContext facesContext) See isCollapsed() for more details
boolean	isCollapsedSetted() Returns true if the attribute "collapsed" is set.
boolean	isCollapsedTextSetted() Returns true if the attribute "collapsedText" is set.
boolean	isCollapseEffectSetted() Returns true if the attribute "collapseEffect" is set.
boolean	isDisabled() Returns false if the receiver is enabled and all ancestors up to and including the receiver's nearest ancestor shell are enabled.
boolean	isDisabled(FacesContext facesContext) See isDisabled() for more details
boolean	isDisabledSetted() Returns true if the attribute "disabled" is set.
boolean	isFontBoldSetted() Returns true if the attribute "fontBold" is set.
boolean	isFontItalicSetted() Returns true if the attribute "fontItalic" is set.
boolean	isFontNameSetted() Returns true if the attribute "fontName" is set.
boolean	isFontSizeSetted() Returns true if the attribute "fontSize" is set.
boolean	isFontUnderlineSetted() Returns true if the attribute "fontUnderline" is set.
boolean	isGroupNameSetted() Returns true if the attribute "groupName" is set.
boolean	isOverStyleClassSetted() Returns true if the attribute "overStyleClass" 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.
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	isTabIndexSetted() Returns true if the attribute "tabIndex" is set.
boolean	isTextAlignmentSetted() Returns true if the attribute "textAlignment" is set.
boolean	isTextDirectionSetted() Returns true if the attribute "textDirection" is set.
boolean	isTextSetted() Returns true if the attribute "text" is set.
boolean	isUserExpandable() Returns a boolean value indicating wether the user can expand the component.
boolean	isUserExpandable(FacesContext facesContext) Returns a boolean value indicating wether the user can expand the component.
boolean	isUserExpandableSetted() Returns true if the attribute "userExpandable" is set.
FacesListener[]	listBlurListeners() Returns a list of blur listener for the component
FacesListener[]	listExpandListeners() Returns a list of expand listener for the component
FacesListener[]	listFocusListeners() Returns a list of focus listener for the component
FacesListener[]	listLoadListeners() Returns a list of load listener for the component
FacesListener[]	listSelectionListeners() Returns a list of selection listener for the component
void	removeBlurListener(IBlurListener listener) Removes a listener from the component for the blur event
void	removeExpandListener(IExpandListener listener) Removes a listener from the component for the expand event
void	removeFocusListener(IFocusListener listener) Removes a listener from the component for the focus event
void	removeLoadListener(ILoadListener listener) Removes a listener from the component for the load event
void	removeSelectionListener(ISelectionListener listener) Removes a listener from the component for the selection event
void	setAccessKey(String accessKey) Sets a string that indicates the alphanumeric key used to execute an action from the keyboard (in conjunction with a alteration key ex : Alt).
void	setAsyncRenderMode(int asyncRenderMode) Sets a int value that indicates the rendering mode for asynchronous capable component.
void	setAsyncRenderMode(String asyncRenderMode)
void	setBorder(boolean border) Sets a boolean value that indicates if the component should show a border or not.
void	setCollapsed(boolean collapsed) Sets a boolean value indicating wether the component should be collapsed.
void	setCollapsedText(String collapsedText) Sets a string value specifying the text to show when the component is collapsed.
void	setCollapseEffect(String collapseEffect) Sets a string value indicating the effect to use when transionning from one state to the other.
void	setDisabled(boolean disabled) Disabled the receiver if the argument is true, and enables it otherwise.
void	setFontBold(Boolean fontBold) Sets a boolean object (or null) indicating the bold property for the specified font.
void	setFontItalic(Boolean fontItalic) Sets a boolean object (or null) indicating the italic property for the specified font.
void	setFontName(String fontName) Sets a string value indicating the name of the font used for this component.
void	setFontSize(String fontSize) Sets a string indicating the size to use for the selected font.
void	setFontUnderline(Boolean fontUnderline) Sets a boolean object (or null) indicating the underline property for the specified font.
void	setGroupName(String groupName) Sets a string specifying the name of the virtual entity that links different components together.
void	setOverStyleClass(String overStyleClass)
void	setReadOnly(boolean readOnly) Sets a boolean value indicating that this component will prohibit changes by the user.
void	setScopeSaveValue(boolean scopeSaveValue)
void	setScopeValue(Object scopeValue)
void	setScopeVar(String scopeVar)
void	setTabIndex(Integer tabIndex) Sets an int value specifying the position of this element in the tabbing order for the current document.
void	setText(String text) Sets a string value specifying the text to be shown.
void	setTextAlignment(String textAlignment) Specifies horizontal alignment.
void	setTextDirection(int textDirection)
void	setUserExpandable(boolean userExpandable) Sets a boolean value indicating wether the user can expand the component.

Methods inherited from class org.rcfaces.core.component.AbstractOutputComponent

addErrorListener, addInitListener, addMouseOutListener, addMouseOverListener, 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, isValueLocked, isValueLocked, isValueLockedSetted, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWidthSetted, isXSetted, isYSetted, listClientDataKeys, listClientDataKeys, listErrorListeners, listInitListeners, listMouseOutListeners, listMouseOverListeners, listPropertyChangeListeners, listServerDataKeys, listServerDataKeys, listUserEventListeners, removeClientData, removeErrorListener, removeInitListener, removeMouseOutListener, removeMouseOverListener, 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, setValueLocked, setVisible, setWaiRole, setWidth, setX, setY

Methods inherited from class org.rcfaces.core.internal.component.CameliaOutputComponent

clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getChildren, getChildrenListState, getFamily, getRendererType, getTransientAttribute, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setConverter, setConverter, setDefaultProperties, setRendered, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter, setValue

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

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter, setValue

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES

CAMELIA_VALUE_ALIAS

protected static final String CAMELIA_VALUE_ALIAS

See Also:

Constant Field Values

Constructor Detail

ExpandBarComponent

public ExpandBarComponent()

ExpandBarComponent

public ExpandBarComponent(String componentId)

Method Detail

setAsyncRenderMode

public void setAsyncRenderMode(String asyncRenderMode)

addExpandListener

public final void addExpandListener(IExpandListener listener)

Description copied from interface: IExpandEventCapability

Adds a listener to the component for the expand event

Specified by:

addExpandListener in interface IExpandEventCapability

Parameters:

listener - the expand listener to add

removeExpandListener

public final void removeExpandListener(IExpandListener listener)

Description copied from interface: IExpandEventCapability

Removes a listener from the component for the expand event

Specified by:

removeExpandListener in interface IExpandEventCapability

Parameters:

listener - the expand listener to remove

listExpandListeners

public final FacesListener[] listExpandListeners()

Description copied from interface: IExpandEventCapability

Returns a list of expand listener for the component

Specified by:

listExpandListeners in interface IExpandEventCapability

Returns:

expand listeners' list

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

getFontBold

public Boolean getFontBold()

Description copied from interface: IFontCapability

Returns a boolean object (or null) indicating the bold property for the specified font.

Specified by:

getFontBold in interface IFontCapability

Returns:

True|False|null

getFontBold

public Boolean getFontBold(FacesContext facesContext)

See getFontBold() for more details

isFontBoldSetted

public final boolean isFontBoldSetted()

Returns true if the attribute "fontBold" is set.

Returns:

true if the attribute is set.

setFontBold

public void setFontBold(Boolean fontBold)

Description copied from interface: IFontCapability

Sets a boolean object (or null) indicating the bold property for the specified font.

Specified by:

setFontBold in interface IFontCapability

Parameters:

fontBold - True|False|null

getFontItalic

public Boolean getFontItalic()

Description copied from interface: IFontCapability

Returns a boolean object (or null) indicating the italic property for the specified font.

Specified by:

getFontItalic in interface IFontCapability

Returns:

True|False|null

getFontItalic

public Boolean getFontItalic(FacesContext facesContext)

See getFontItalic() for more details

isFontItalicSetted

public final boolean isFontItalicSetted()

Returns true if the attribute "fontItalic" is set.

Returns:

true if the attribute is set.

setFontItalic

public void setFontItalic(Boolean fontItalic)

Description copied from interface: IFontCapability

Sets a boolean object (or null) indicating the italic property for the specified font.

Specified by:

setFontItalic in interface IFontCapability

Parameters:

fontItalic - True|False|null

getFontName

public String getFontName()

Description copied from interface: IFontCapability

Returns a string value indicating the name of the font used for this component.

Specified by:

getFontName in interface IFontCapability

Returns:

font name

getFontName

public String getFontName(FacesContext facesContext)

See getFontName() for more details

isFontNameSetted

public final boolean isFontNameSetted()

Returns true if the attribute "fontName" is set.

Returns:

true if the attribute is set.

setFontName

public void setFontName(String fontName)

Description copied from interface: IFontCapability

Sets a string value indicating the name of the font used for this component.

Specified by:

setFontName in interface IFontCapability

Parameters:

fontName - font name

getFontSize

public String getFontSize()

Description copied from interface: IFontCapability

Returns a string indicating the size to use for the selected font. (or any other CSS accepted value for font size).

Specified by:

getFontSize in interface IFontCapability

Returns:

xx-small|x-small|small|medium|large|x-large|xx-large|smaller|larger|length for example 10px|%

getFontSize

public String getFontSize(FacesContext facesContext)

See getFontSize() for more details

isFontSizeSetted

public final boolean isFontSizeSetted()

Returns true if the attribute "fontSize" is set.

Returns:

true if the attribute is set.

setFontSize

public void setFontSize(String fontSize)

Description copied from interface: IFontCapability

Sets a string indicating the size to use for the selected font. (or any other CSS accepted value for font size).

Specified by:

setFontSize in interface IFontCapability

Parameters:

fontSize - xx-small|x-small|small|medium|large|x-large|xx-large|smaller|larger|length for example 10px|%

getFontUnderline

public Boolean getFontUnderline()

Description copied from interface: IFontCapability

Returns a boolean object (or null) indicating the underline property for the specified font.

Specified by:

getFontUnderline in interface IFontCapability

Returns:

True|False|null

getFontUnderline

public Boolean getFontUnderline(FacesContext facesContext)

See getFontUnderline() for more details

isFontUnderlineSetted

public final boolean isFontUnderlineSetted()

Returns true if the attribute "fontUnderline" is set.

Returns:

true if the attribute is set.

setFontUnderline

public void setFontUnderline(Boolean fontUnderline)

Description copied from interface: IFontCapability

Sets a boolean object (or null) indicating the underline property for the specified font.

Specified by:

setFontUnderline in interface IFontCapability

Parameters:

fontUnderline - True|False|null

isDisabled

public boolean isDisabled()

Description copied from interface: IDisabledCapability

Returns false if the receiver is enabled and all ancestors up to and including the receiver's nearest ancestor shell are enabled.
Otherwise, false is returned. A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.

Specified by:

isDisabled in interface IDisabledCapability

Returns:

the receiver's enabled state

isDisabled

public boolean isDisabled(FacesContext facesContext)

See isDisabled() for more details

isDisabledSetted

public final boolean isDisabledSetted()

Returns true if the attribute "disabled" is set.

Returns:

true if the attribute is set.

setDisabled

public void setDisabled(boolean disabled)

Description copied from interface: IDisabledCapability

Disabled the receiver if the argument is true, and enables it otherwise. A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.

Specified by:

setDisabled in interface IDisabledCapability

Parameters:

disabled - the new enabled state

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

getText

public String getText()

Description copied from interface: ITextCapability

Returns a string value specifying the text shown.

Specified by:

getText in interface ITextCapability

Returns:

text

getText

public String getText(FacesContext facesContext)

See getText() for more details

isTextSetted

public final boolean isTextSetted()

Returns true if the attribute "text" is set.

Returns:

true if the attribute is set.

setText

public void setText(String text)

Description copied from interface: ITextCapability

Sets a string value specifying the text to be shown.

Specified by:

setText in interface ITextCapability

Parameters:

text - text

getTextDirection

public int getTextDirection()

Specified by:

getTextDirection in interface ITextDirectionCapability

getTextDirection

public int getTextDirection(FacesContext facesContext)

See getTextDirection() for more details

isTextDirectionSetted

public final boolean isTextDirectionSetted()

Returns true if the attribute "textDirection" is set.

Returns:

true if the attribute is set.

setTextDirection

public void setTextDirection(int textDirection)

Specified by:

setTextDirection in interface ITextDirectionCapability

getTextAlignment

public String getTextAlignment()

Description copied from interface: ITextAlignmentCapability

Returns horizontal alignment.

Specified by:

getTextAlignment in interface ITextAlignmentCapability

Returns:

alignment

getTextAlignment

public String getTextAlignment(FacesContext facesContext)

See getTextAlignment() for more details

isTextAlignmentSetted

public final boolean isTextAlignmentSetted()

Returns true if the attribute "textAlignment" is set.

Returns:

true if the attribute is set.

setTextAlignment

public void setTextAlignment(String textAlignment)

Description copied from interface: ITextAlignmentCapability

Specifies horizontal alignment.

Specified by:

setTextAlignment in interface ITextAlignmentCapability

Parameters:

textAlignment - text alignment

isCollapsed

public boolean isCollapsed()

Description copied from interface: ICollapsableCapability

Returns a boolean value indicating wether the component is collapsed.

Specified by:

isCollapsed in interface ICollapsableCapability

Returns:

boolean

isCollapsed

public boolean isCollapsed(FacesContext facesContext)

See isCollapsed() for more details

isCollapsedSetted

public final boolean isCollapsedSetted()

Returns true if the attribute "collapsed" is set.

Returns:

true if the attribute is set.

setCollapsed

public void setCollapsed(boolean collapsed)

Description copied from interface: ICollapsableCapability

Sets a boolean value indicating wether the component should be collapsed.

Specified by:

setCollapsed in interface ICollapsableCapability

Parameters:

collapsed - 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

getAccessKey

public String getAccessKey()

Description copied from interface: IAccessKeyCapability

Returns a string that indicates the alphanumeric key used to execute an action from the keyboard (in conjunction with a alteration key ex : Alt).

Specified by:

getAccessKey in interface IAccessKeyCapability

Returns:

<Any alphanumeric key>

getAccessKey

public String getAccessKey(FacesContext facesContext)

See getAccessKey() for more details

isAccessKeySetted

public final boolean isAccessKeySetted()

Returns true if the attribute "accessKey" is set.

Returns:

true if the attribute is set.

setAccessKey

public void setAccessKey(String accessKey)

Description copied from interface: IAccessKeyCapability

Sets a string that indicates the alphanumeric key used to execute an action from the keyboard (in conjunction with a alteration key ex : Alt).

Specified by:

setAccessKey in interface IAccessKeyCapability

Parameters:

accessKey - <Any alphanumeric key>

getTabIndex

public Integer getTabIndex()

Description copied from interface: ITabIndexCapability

Returns an int value specifying the position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.

Specified by:

getTabIndex in interface ITabIndexCapability

Returns:

index

getTabIndex

public Integer getTabIndex(FacesContext facesContext)

See getTabIndex() for more details

isTabIndexSetted

public final boolean isTabIndexSetted()

Returns true if the attribute "tabIndex" is set.

Returns:

true if the attribute is set.

setTabIndex

public void setTabIndex(Integer tabIndex)

Description copied from interface: ITabIndexCapability

Sets an int value specifying the position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.

Specified by:

setTabIndex in interface ITabIndexCapability

Parameters:

tabIndex - index

getGroupName

public String getGroupName()

Description copied from interface: IRadioGroupCapability

Returns a string specifying the name of the virtual entity that links different components together.

Specified by:

getGroupName in interface IRadioGroupCapability

Returns:

group name

getGroupName

public String getGroupName(FacesContext facesContext)

See getGroupName() for more details

isGroupNameSetted

public final boolean isGroupNameSetted()

Returns true if the attribute "groupName" is set.

Returns:

true if the attribute is set.

setGroupName

public void setGroupName(String groupName)

Description copied from interface: IRadioGroupCapability

Sets a string specifying the name of the virtual entity that links different components together.

Specified by:

setGroupName in interface IRadioGroupCapability

Parameters:

groupName - group name

addBlurListener

public final void addBlurListener(IBlurListener listener)

Description copied from interface: IFocusBlurEventCapability

Adds a listener to the component for the blur event

Specified by:

addBlurListener in interface IFocusBlurEventCapability

Parameters:

listener - the blur listener to add

removeBlurListener

public final void removeBlurListener(IBlurListener listener)

Description copied from interface: IFocusBlurEventCapability

Removes a listener from the component for the blur event

Specified by:

removeBlurListener in interface IFocusBlurEventCapability

Parameters:

listener - the blur listener to remove

listBlurListeners

public final FacesListener[] listBlurListeners()

Description copied from interface: IFocusBlurEventCapability

Returns a list of blur listener for the component

Specified by:

listBlurListeners in interface IFocusBlurEventCapability

Returns:

blur listeners' list

addFocusListener

public final void addFocusListener(IFocusListener listener)

Description copied from interface: IFocusBlurEventCapability

Adds a listener to the component for the focus event

Specified by:

addFocusListener in interface IFocusBlurEventCapability

Parameters:

listener - the focus listener to add

removeFocusListener

public final void removeFocusListener(IFocusListener listener)

Description copied from interface: IFocusBlurEventCapability

Removes a listener from the component for the focus event

Specified by:

removeFocusListener in interface IFocusBlurEventCapability

Parameters:

listener - the focus listener to remove

listFocusListeners

public final FacesListener[] listFocusListeners()

Description copied from interface: IFocusBlurEventCapability

Returns a list of focus listener for the component

Specified by:

listFocusListeners in interface IFocusBlurEventCapability

Returns:

focus listeners' list

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

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

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

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

getCollapseEffect

public String getCollapseEffect()

Returns a string value indicating the effect to use when transionning from one state to the other.

Returns:

the effect : slideUp|slideUpTrans

getCollapseEffect

public String getCollapseEffect(FacesContext facesContext)

Returns a string value indicating the effect to use when transionning from one state to the other.

Returns:

the effect : slideUp|slideUpTrans

setCollapseEffect

public void setCollapseEffect(String collapseEffect)

Sets a string value indicating the effect to use when transionning from one state to the other.

Parameters:

collapseEffect - the effect : slideUp|slideUpTrans

isCollapseEffectSetted

public boolean isCollapseEffectSetted()

Returns true if the attribute "collapseEffect" is set.

Returns:

true if the attribute is set.

getCollapsedText

public String getCollapsedText()

Returns a string value specifying the text to show when the component is collapsed.

Returns:

text

getCollapsedText

public String getCollapsedText(FacesContext facesContext)

Returns a string value specifying the text to show when the component is collapsed.

Returns:

text

setCollapsedText

public void setCollapsedText(String collapsedText)

Sets a string value specifying the text to show when the component is collapsed.

Parameters:

collapsedText - text

isCollapsedTextSetted

public boolean isCollapsedTextSetted()

Returns true if the attribute "collapsedText" is set.

Returns:

true if the attribute is set.

isUserExpandable

public boolean isUserExpandable()

Returns a boolean value indicating wether the user can expand the component.

Returns:

true if the user can expand the component

isUserExpandable

public boolean isUserExpandable(FacesContext facesContext)

Returns a boolean value indicating wether the user can expand the component.

Returns:

true if the user can expand the component

setUserExpandable

public void setUserExpandable(boolean userExpandable)

Sets a boolean value indicating wether the user can expand the component.

Parameters:

userExpandable - true if the user can expand the component

isUserExpandableSetted

public boolean isUserExpandableSetted()

Returns true if the attribute "userExpandable" is set.

Returns:

true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class AbstractOutputComponent

getCameliaValueAlias

protected String getCameliaValueAlias()

Overrides:

getCameliaValueAlias in class org.rcfaces.core.internal.component.CameliaOutputComponent