AbstractMessageComponent (Rich Client Faces 1.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.rcfaces.core.component
Class AbstractMessageComponent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIMessage
              org.rcfaces.core.internal.component.CameliaMessageComponent
                  org.rcfaces.core.component.AbstractMessageComponent

All Implemented Interfaces:: StateHolder, IClientDataCapability, IErrorEventCapability, IForCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IInitEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, 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:: MessageComponent

public abstract class AbstractMessageComponent
extends org.rcfaces.core.internal.component.CameliaMessageComponent
implements IMarginCapability, IUserEventCapability, IPositionCapability, IHelpCapability, IClientDataCapability, IPartialRenderingCapability, IStyleClassCapability, ILookAndFeelCapability, ISizeCapability, IForegroundBackgroundColorCapability, IVisibilityCapability, IErrorEventCapability, IWAIRoleCapability, ILayoutPositionCapability, IMouseEventCapability, IUnlockedClientAttributesCapability, IInitEventCapability, IPropertyChangeEventCapability, IHiddenModeCapability, IServerDataCapability, org.rcfaces.core.internal.manager.IClientDataManager, IForCapability, org.rcfaces.core.internal.manager.IServerDataManager
extends org.rcfaces.core.internal.component.CameliaMessageComponent
implements IMarginCapability, IUserEventCapability, IPositionCapability, IHelpCapability, IClientDataCapability, IPartialRenderingCapability, IStyleClassCapability, ILookAndFeelCapability, ISizeCapability, IForegroundBackgroundColorCapability, IVisibilityCapability, IErrorEventCapability, IWAIRoleCapability, ILayoutPositionCapability, IMouseEventCapability, IUnlockedClientAttributesCapability, IInitEventCapability, IPropertyChangeEventCapability, IHiddenModeCapability, IServerDataCapability, org.rcfaces.core.internal.manager.IClientDataManager, IForCapability, org.rcfaces.core.internal.manager.IServerDataManager

Technical component, used as a basis for building new RCFaces components.

Field Summary
`protected static Set`	`CAMELIA_ATTRIBUTES`

Fields inherited from class org.rcfaces.core.internal.component.CameliaMessageComponent
`engine`

Fields inherited from class javax.faces.component.UIMessage
`COMPONENT_FAMILY, COMPONENT_TYPE`

Fields inherited from class javax.faces.component.UIComponent
`bindings`

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
`AbstractMessageComponent()`

Method Summary
`void`	`addErrorListener(IErrorListener listener)` Adds a listener to the component for the error 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
`void`	`addPropertyChangeListener(IPropertyChangeListener listener)` Adds a listener to the component for the propertyChange event
`void`	`addUserEventListener(IUserEventListener listener)` Adds a listener to the component for the user event
`String`	`getAriaLabel()`
`String`	`getAriaLabel(FacesContext facesContext)` See `getAriaLabel()` for more details
`int`	`getAriaLevel()`
`int`	`getAriaLevel(FacesContext facesContext)` See `getAriaLevel()` for more details
`String`	`getBackgroundColor()` Returns the receiver's background color.
`String`	`getBackgroundColor(FacesContext facesContext)` See `getBackgroundColor()` for more details
`int`	`getBottom()`
`int`	`getBottom(FacesContext facesContext)` See `getBottom()` for more details
`protected Set`	`getCameliaFields()`
`String`	`getClientData(String name)` Retrieves the data associated to a variable
`String`	`getClientData(String name, FacesContext facesContext)`
`int`	`getClientDataCount()` Returns the number of variable associated to the component.
`Map`	`getClientDataMap()` Returns a map containing the couples variable-data
`Map`	`getClientDataMap(FacesContext facesContext)`
`String`	`getForegroundColor()` Returns the foreground color that the receiver will use to draw.
`String`	`getForegroundColor(FacesContext facesContext)` See `getForegroundColor()` for more details
`String`	`getHeight()` Returns a string value (as specified by CSS) for the height of the component.
`String`	`getHeight(FacesContext facesContext)` See `getHeight()` for more details
`String`	`getHelpMessage()` Returns a string value specifying the message to be shown by a helpMessageZone Component.
`String`	`getHelpMessage(FacesContext facesContext)` See `getHelpMessage()` for more details
`String`	`getHelpURL()` Returns an URL that points to a help page for the component. it is used for example by a helpButton Component.
`String`	`getHelpURL(FacesContext facesContext)` See `getHelpURL()` for more details
`int`	`getHiddenMode()` Returns the hidden mode in client side.
`int`	`getHiddenMode(FacesContext facesContext)` See `getHiddenMode()` for more details
`int`	`getLeft()`
`int`	`getLeft(FacesContext facesContext)` See `getLeft()` for more details
`String`	`getLookId()` Returns a string value specifying the choosen look of the component.
`String`	`getLookId(FacesContext facesContext)` See `getLookId()` for more details
`String`	`getMarginBottom()` Returns a string value specifying the margin size for the component's bottom (compliant to CSS margin-bottom).
`String`	`getMarginBottom(FacesContext facesContext)` See `getMarginBottom()` for more details
`String`	`getMarginLeft()` Returns a string value specifying the margin size for the component's left (compliant to CSS margin-left).
`String`	`getMarginLeft(FacesContext facesContext)` See `getMarginLeft()` for more details
`String`	`getMarginRight()` Returns a string value specifying the margin size for the component's right (compliant to CSS margin-right).
`String`	`getMarginRight(FacesContext facesContext)` See `getMarginRight()` for more details
`String`	`getMarginTop()` Returns a string value specifying the margin size for the component's top (compliant to CSS margin-top).
`String`	`getMarginTop(FacesContext facesContext)` See `getMarginTop()` for more details
`int`	`getRight()`
`int`	`getRight(FacesContext facesContext)` See `getRight()` for more details
`Object`	`getServerData(String name)` Retrieves an object data associated to a key
`Object`	`getServerData(String name, FacesContext facesContext)`
`int`	`getServerDataCount()` Returns the number of keys associated to the component.
`Map`	`getServerDataMap()` Returns a Map object containing keys and associated data objects
`Map`	`getServerDataMap(FacesContext facesContext)`
`String`	`getStyleClass()` Returns the style class of the component.
`String`	`getStyleClass(FacesContext facesContext)` See `getStyleClass()` for more details
`String`	`getToolTipText()` Returns the receiver's tool tip text, or `null` if it has not been set.
`String`	`getToolTipText(FacesContext facesContext)` See `getToolTipText()` for more details
`int`	`getTop()`
`int`	`getTop(FacesContext facesContext)` See `getTop()` for more details
`String`	`getUnlockedClientAttributeNames()` Returns a string value holding a comma separated list of the client modifiable properties.
`String`	`getUnlockedClientAttributeNames(FacesContext facesContext)` See `getUnlockedClientAttributeNames()` for more details
`Boolean`	`getVisibleState()` Returns `TRUE` if the receiver is visible, `FALSE` if the receiver is specified "not visible", and `null` otherwise.
`Boolean`	`getVisibleState(FacesContext facesContext)`
`String`	`getWaiRole()`
`String`	`getWaiRole(FacesContext facesContext)` See `getWaiRole()` for more details
`String`	`getWidth()` Returns a string value (as specified by CSS) for the width of the component.
`String`	`getWidth(FacesContext facesContext)` See `getWidth()` for more details
`String`	`getX()` Returns a string value (as specified by CSS) for the x position of the component.
`String`	`getX(FacesContext facesContext)` See `getX()` for more details
`String`	`getY()` Returns a string value (as specified by CSS) for the y position of the component.
`String`	`getY(FacesContext facesContext)` See `getY()` for more details
`boolean`	`isAriaLabelSetted()` Returns `true` if the attribute "ariaLabel" is set.
`boolean`	`isAriaLevelSetted()` Returns `true` if the attribute "ariaLevel" is set.
`boolean`	`isBackgroundColorSetted()` Returns `true` if the attribute "backgroundColor" is set.
`boolean`	`isBottomSetted()` Returns `true` if the attribute "bottom" is set.
`boolean`	`isForegroundColorSetted()` Returns `true` if the attribute "foregroundColor" is set.
`boolean`	`isHeightSetted()` Returns `true` if the attribute "height" is set.
`boolean`	`isHelpMessageSetted()` Returns `true` if the attribute "helpMessage" is set.
`boolean`	`isHelpURLSetted()` Returns `true` if the attribute "helpURL" is set.
`boolean`	`isHiddenModeSetted()` Returns `true` if the attribute "hiddenMode" is set.
`boolean`	`isLeftSetted()` Returns `true` if the attribute "left" is set.
`boolean`	`isLookIdSetted()` Returns `true` if the attribute "lookId" is set.
`boolean`	`isMarginBottomSetted()` Returns `true` if the attribute "marginBottom" is set.
`boolean`	`isMarginLeftSetted()` Returns `true` if the attribute "marginLeft" is set.
`boolean`	`isMarginRightSetted()` Returns `true` if the attribute "marginRight" is set.
`boolean`	`isMarginTopSetted()` Returns `true` if the attribute "marginTop" is set.
`boolean`	`isPartialRendering()`
`boolean`	`isPartialRendering(FacesContext facesContext)` See `isPartialRendering()` for more details
`boolean`	`isPartialRenderingSetted()` Returns `true` if the attribute "partialRendering" is set.
`boolean`	`isRightSetted()` Returns `true` if the attribute "right" is set.
`boolean`	`isStyleClassSetted()` Returns `true` if the attribute "styleClass" is set.
`boolean`	`isToolTipTextSetted()` Returns `true` if the attribute "toolTipText" is set.
`boolean`	`isTopSetted()` Returns `true` if the attribute "top" is set.
`boolean`	`isUnlockedClientAttributeNamesSetted()` Returns `true` if the attribute "unlockedClientAttributeNames" is set.
`boolean`	`isVisible()`
`boolean`	`isVisible(FacesContext facesContext)` See `isVisible()` for more details
`boolean`	`isVisibleSetted()` Returns `true` if the attribute "visible" is set.
`boolean`	`isWaiRoleSetted()` Returns `true` if the attribute "waiRole" is set.
`boolean`	`isWidthSetted()` Returns `true` if the attribute "width" is set.
`boolean`	`isXSetted()` Returns `true` if the attribute "x" is set.
`boolean`	`isYSetted()` Returns `true` if the attribute "y" is set.
`String[]`	`listClientDataKeys()` Returns the list of variable associated to the component.
`String[]`	`listClientDataKeys(FacesContext facesContext)`
`FacesListener[]`	`listErrorListeners()` Returns a list of Error listener for the component
`FacesListener[]`	`listInitListeners()` Returns a list of init listener for the component
`FacesListener[]`	`listMouseOutListeners()` Returns a list of mouseOut listener for the component
`FacesListener[]`	`listMouseOverListeners()` Returns a list of mouseOver listener for the component
`FacesListener[]`	`listPropertyChangeListeners()` Returns a list of propertyChange listener for the component
`String[]`	`listServerDataKeys()` Returns a list of the keys defined for the component
`String[]`	`listServerDataKeys(FacesContext facesContext)`
`FacesListener[]`	`listUserEventListeners()` Returns a list of user listener for the component
`String`	`removeClientData(String name)` Removes the variable name and the data associated to it
`void`	`removeErrorListener(IErrorListener listener)` Removes a listener from the component for the error 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`	`removePropertyChangeListener(IPropertyChangeListener listener)` Removes a listener from the component for the propertyChange event
`Object`	`removeServerData(String name)` Removes a key and the data object associated to it
`void`	`removeUserEventListener(IUserEventListener listener)` Removes a listener from the component for the user event
`void`	`setAriaLabel(String ariaLabel)`
`void`	`setAriaLevel(int ariaLevel)`
`void`	`setBackgroundColor(String backgroundColor)` Sets the receiver's background color to the color specified by the argument, or to the default system color for the control if the argument is null.
`void`	`setBottom(int bottom)`
`String`	`setClientData(String name, String value)` Associates data to variable name.
`void`	`setClientData(String name, javax.el.ValueExpression value)`
`void`	`setForegroundColor(String foregroundColor)` Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.
`void`	`setHeight(String height)` Sets a string value (as specified by CSS) for the height of the component.
`void`	`setHelpMessage(String helpMessage)` Sets a string value specifying the message to be shown by a helpMessageZone Component.
`void`	`setHelpURL(String helpURL)` Sets an URL that points to a help page for the component. it is used for example by a helpButton Component.
`void`	`setHiddenMode(int hiddenMode)` Set the hidden mode in client side.
`void`	`setHiddenMode(String hiddenMode)`
`void`	`setLeft(int left)`
`void`	`setLookId(String lookId)` Sets a string value specifying the choosen look of the component.
`void`	`setMarginBottom(String marginBottom)` Sets a string value specifying the margin size for the component's bottom (compliant to CSS margin-bottom).
`void`	`setMarginLeft(String marginLeft)` Sets a string value specifying the margin size for the component's left (compliant to CSS margin-left).
`void`	`setMarginRight(String marginRight)` Sets a string value specifying the margin size for the component's right (compliant to CSS margin-right).
`void`	`setMargins(String margins)`
`void`	`setMarginTop(String marginTop)` Sets a string value specifying the margin size for the component's top (compliant to CSS margin-top).
`void`	`setPartialRendering(boolean partialRendering)`
`void`	`setRight(int right)`
`Object`	`setServerData(String name, Object value)` Associates and object to a key for the component on the server side
`void`	`setServerData(String name, javax.el.ValueExpression value)`
`void`	`setStyleClass(String styleClass)` Specify the style class of the component.
`void`	`setToolTipText(String toolTipText)` Sets the receiver's tool tip text to the argument, which may be `null` indicating that no tool tip text should be shown.
`void`	`setTop(int top)`
`void`	`setUnlockedClientAttributeNames(String unlockedClientAttributeNames)` Sets a string value holding a comma separated list of the client modifiable properties.
`void`	`setVisible(boolean visible)` Marks the receiver as visible if the argument is `TRUE`, and marks it invisible if argument is `FALSE`.
`void`	`setWaiRole(String waiRole)`
`void`	`setWidth(String width)` Sets a string value (as specified by CSS) for the width of the component.
`void`	`setX(String x)` Sets a string value (as specified by CSS) for the x position of the component.
`void`	`setY(String y)` Sets a string value (as specified by CSS) for the y position of the component.

Methods inherited from class org.rcfaces.core.internal.component.CameliaMessageComponent
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 org.rcfaces.core.internal.component.CameliaMessageComponent

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.UIMessage
`getFor, isShowDetail, isShowSummary, setFor, setShowDetail, setShowSummary`

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.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.component.capability.IForCapability
`getFor, setFor`

Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager
`getChildCount`

Field Detail

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES

Constructor Detail

AbstractMessageComponent

public AbstractMessageComponent()

Method Detail

getServerDataMap

public Map getServerDataMap(FacesContext facesContext)

setServerData

public Object setServerData(String name,
                            Object value)

Description copied from interface: IServerDataCapability

Associates and object to a key for the component on the server side

Specified by:: setServerData in interface IServerDataCapability
Specified by:: setServerData in interface org.rcfaces.core.internal.manager.IServerDataManager

Parameters:: name - key used to retrieve the object associated; value - object to associate
Returns:: the object previously associated to teh key (null if none)

getClientDataMap

public Map getClientDataMap(FacesContext facesContext)

setClientData

public String setClientData(String name,
                            String value)

Description copied from interface: IClientDataCapability

Associates data to variable name.

Specified by:: setClientData in interface IClientDataCapability
Specified by:: setClientData in interface org.rcfaces.core.internal.manager.IClientDataManager

Parameters:: name - the variable to associate data to; value - the data to associate to the variable
Returns:: the data previously associated with the variable (empty if none)

setServerData

public void setServerData(String name,
                          javax.el.ValueExpression value)

Specified by:: setServerData in interface org.rcfaces.core.internal.manager.IServerDataManager

listClientDataKeys

public String[] listClientDataKeys(FacesContext facesContext)

setClientData

public void setClientData(String name,
                          javax.el.ValueExpression value)

Specified by:: setClientData in interface org.rcfaces.core.internal.manager.IClientDataManager

getClientData

public String getClientData(String name,
                            FacesContext facesContext)

getServerData

public Object getServerData(String name,
                            FacesContext facesContext)

setMargins

public void setMargins(String margins)

listServerDataKeys

public String[] listServerDataKeys(FacesContext facesContext)

setHiddenMode

public void setHiddenMode(String hiddenMode)

getVisibleState

public Boolean getVisibleState(FacesContext facesContext)

getMarginBottom

public String getMarginBottom()

Description copied from interface: IMarginCapability

Returns a string value specifying the margin size for the component's bottom (compliant to CSS margin-bottom).

Specified by:: getMarginBottom in interface IMarginCapability

Returns:: margin-bottom

getMarginBottom

public String getMarginBottom(FacesContext facesContext)

See getMarginBottom() for more details

isMarginBottomSetted

public final boolean isMarginBottomSetted()

Returns true if the attribute "marginBottom" is set.

Returns:: true if the attribute is set.

setMarginBottom

public void setMarginBottom(String marginBottom)

Description copied from interface: IMarginCapability

Sets a string value specifying the margin size for the component's bottom (compliant to CSS margin-bottom).

Specified by:: setMarginBottom in interface IMarginCapability

Parameters:: marginBottom - margin-bottom

getMarginLeft

public String getMarginLeft()

Description copied from interface: IMarginCapability

Returns a string value specifying the margin size for the component's left (compliant to CSS margin-left).

Specified by:: getMarginLeft in interface IMarginCapability

Returns:: margin-left

getMarginLeft

public String getMarginLeft(FacesContext facesContext)

See getMarginLeft() for more details

isMarginLeftSetted

public final boolean isMarginLeftSetted()

Returns true if the attribute "marginLeft" is set.

Returns:: true if the attribute is set.

setMarginLeft

public void setMarginLeft(String marginLeft)

Description copied from interface: IMarginCapability

Sets a string value specifying the margin size for the component's left (compliant to CSS margin-left).

Specified by:: setMarginLeft in interface IMarginCapability

Parameters:: marginLeft - margin-left

getMarginRight

public String getMarginRight()

Description copied from interface: IMarginCapability

Returns a string value specifying the margin size for the component's right (compliant to CSS margin-right).

Specified by:: getMarginRight in interface IMarginCapability

Returns:: margin-right

getMarginRight

public String getMarginRight(FacesContext facesContext)

See getMarginRight() for more details

isMarginRightSetted

public final boolean isMarginRightSetted()

Returns true if the attribute "marginRight" is set.

Returns:: true if the attribute is set.

setMarginRight

public void setMarginRight(String marginRight)

Description copied from interface: IMarginCapability

Sets a string value specifying the margin size for the component's right (compliant to CSS margin-right).

Specified by:: setMarginRight in interface IMarginCapability

Parameters:: marginRight - margin-right

getMarginTop

public String getMarginTop()

Description copied from interface: IMarginCapability

Returns a string value specifying the margin size for the component's top (compliant to CSS margin-top).

Specified by:: getMarginTop in interface IMarginCapability

Returns:: margin-top

getMarginTop

public String getMarginTop(FacesContext facesContext)

See getMarginTop() for more details

isMarginTopSetted

public final boolean isMarginTopSetted()

Returns true if the attribute "marginTop" is set.

Returns:: true if the attribute is set.

setMarginTop

public void setMarginTop(String marginTop)

Description copied from interface: IMarginCapability

Sets a string value specifying the margin size for the component's top (compliant to CSS margin-top).

Specified by:: setMarginTop in interface IMarginCapability

Parameters:: marginTop - margin-top

addUserEventListener

public final void addUserEventListener(IUserEventListener listener)

Description copied from interface: IUserEventCapability

Adds a listener to the component for the user event

Specified by:: addUserEventListener in interface IUserEventCapability

Parameters:: listener - the user listener to add

removeUserEventListener

public final void removeUserEventListener(IUserEventListener listener)

Description copied from interface: IUserEventCapability

Removes a listener from the component for the user event

Specified by:: removeUserEventListener in interface IUserEventCapability

Parameters:: listener - the user listener to remove

listUserEventListeners

public final FacesListener[] listUserEventListeners()

Description copied from interface: IUserEventCapability

Returns a list of user listener for the component

Specified by:: listUserEventListeners in interface IUserEventCapability

Returns:: user listeners' list

getX

public String getX()

Description copied from interface: IPositionCapability

Returns a string value (as specified by CSS) for the x position of the component.

Specified by:: getX in interface IPositionCapability

Returns:: as specified by CSS

getX

public String getX(FacesContext facesContext)

See getX() for more details

isXSetted

public final boolean isXSetted()

Returns true if the attribute "x" is set.

Returns:: true if the attribute is set.

setX

public void setX(String x)

Description copied from interface: IPositionCapability

Sets a string value (as specified by CSS) for the x position of the component.

Specified by:: setX in interface IPositionCapability

Parameters:: x - as specified by CSS

getY

public String getY()

Description copied from interface: IPositionCapability

Returns a string value (as specified by CSS) for the y position of the component.

Specified by:: getY in interface IPositionCapability

Returns:: as specified by CSS

getY

public String getY(FacesContext facesContext)

See getY() for more details

isYSetted

public final boolean isYSetted()

Returns true if the attribute "y" is set.

Returns:: true if the attribute is set.

setY

public void setY(String y)

Description copied from interface: IPositionCapability

Sets a string value (as specified by CSS) for the y position of the component.

Specified by:: setY in interface IPositionCapability

Parameters:: y - as specified by CSS

getHelpMessage

public String getHelpMessage()

Description copied from interface: IHelpCapability

Returns a string value specifying the message to be shown by a helpMessageZone Component.

Specified by:: getHelpMessage in interface IHelpCapability

Returns:: help message

getHelpMessage

public String getHelpMessage(FacesContext facesContext)

See getHelpMessage() for more details

isHelpMessageSetted

public final boolean isHelpMessageSetted()

Returns true if the attribute "helpMessage" is set.

Returns:: true if the attribute is set.

setHelpMessage

public void setHelpMessage(String helpMessage)

Description copied from interface: IHelpCapability

Sets a string value specifying the message to be shown by a helpMessageZone Component.

Specified by:: setHelpMessage in interface IHelpCapability

Parameters:: helpMessage - help message

getHelpURL

public String getHelpURL()

Description copied from interface: IHelpCapability

Returns an URL that points to a help page for the component. it is used for example by a helpButton Component.

Specified by:: getHelpURL in interface IHelpCapability

Returns:: help url

getHelpURL

public String getHelpURL(FacesContext facesContext)

See getHelpURL() for more details

isHelpURLSetted

public final boolean isHelpURLSetted()

Returns true if the attribute "helpURL" is set.

Returns:: true if the attribute is set.

setHelpURL

public void setHelpURL(String helpURL)

Description copied from interface: IHelpCapability

Sets an URL that points to a help page for the component. it is used for example by a helpButton Component.

Specified by:: setHelpURL in interface IHelpCapability

Parameters:: helpURL - help url

getToolTipText

public String getToolTipText()

Description copied from interface: IToolTipCapability

Returns the receiver's tool tip text, or null if it has not been set.

Specified by:: getToolTipText in interface IToolTipCapability

Returns:: the receiver's tool tip text

getToolTipText

public String getToolTipText(FacesContext facesContext)

See getToolTipText() for more details

isToolTipTextSetted

public final boolean isToolTipTextSetted()

Returns true if the attribute "toolTipText" is set.

Returns:: true if the attribute is set.

setToolTipText

public void setToolTipText(String toolTipText)

Description copied from interface: IToolTipCapability

Sets the receiver's tool tip text to the argument, which may be null indicating that no tool tip text should be shown.

Specified by:: setToolTipText in interface IToolTipCapability

Parameters:: toolTipText - the new tool tip text (or null)

getClientDataCount

public int getClientDataCount()

Description copied from interface: IClientDataCapability

Returns the number of variable associated to the component.

Specified by:: getClientDataCount in interface IClientDataCapability

Returns:: number of variable

listClientDataKeys

public String[] listClientDataKeys()

Description copied from interface: IClientDataCapability

Returns the list of variable associated to the component.

Specified by:: listClientDataKeys in interface IClientDataCapability

Returns:: a list of variables

removeClientData

public String removeClientData(String name)

Description copied from interface: IClientDataCapability

Removes the variable name and the data associated to it

Specified by:: removeClientData in interface IClientDataCapability

Parameters:: name - the variable to associate data to
Returns:: the data that was associated to the variable

getClientData

public String getClientData(String name)

Description copied from interface: IClientDataCapability

Retrieves the data associated to a variable

Specified by:: getClientData in interface IClientDataCapability

Parameters:: name - the variable to associate data to
Returns:: the data associated to the variable

getClientDataMap

public Map getClientDataMap()

Description copied from interface: IClientDataCapability

Returns a map containing the couples variable-data

Specified by:: getClientDataMap in interface IClientDataCapability

Returns:: a map

isPartialRendering

public boolean isPartialRendering()

Specified by:: isPartialRendering in interface IPartialRenderingCapability

isPartialRendering

public boolean isPartialRendering(FacesContext facesContext)

See isPartialRendering() for more details

isPartialRenderingSetted

public final boolean isPartialRenderingSetted()

Returns true if the attribute "partialRendering" is set.

Returns:: true if the attribute is set.

setPartialRendering

public void setPartialRendering(boolean partialRendering)

Specified by:: setPartialRendering in interface IPartialRenderingCapability

getStyleClass

public String getStyleClass()

Description copied from interface: IStyleClassCapability

Returns the style class of the component.

Specified by:: getStyleClass in interface IStyleClassCapability

Returns:: style class

getStyleClass

public String getStyleClass(FacesContext facesContext)

See getStyleClass() for more details

isStyleClassSetted

public final boolean isStyleClassSetted()

Returns true if the attribute "styleClass" is set.

Returns:: true if the attribute is set.

setStyleClass

public void setStyleClass(String styleClass)

Description copied from interface: IStyleClassCapability

Specify the style class of the component.

Specified by:: setStyleClass in interface IStyleClassCapability

Parameters:: styleClass - style class

getLookId

public String getLookId()

Description copied from interface: ILookAndFeelCapability

Returns a string value specifying the choosen look of the component.

Specified by:: getLookId in interface ILookAndFeelCapability

Returns:: lookId

getLookId

public String getLookId(FacesContext facesContext)

See getLookId() for more details

isLookIdSetted

public final boolean isLookIdSetted()

Returns true if the attribute "lookId" is set.

Returns:: true if the attribute is set.

setLookId

public void setLookId(String lookId)

Description copied from interface: ILookAndFeelCapability

Sets a string value specifying the choosen look of the component.

Specified by:: setLookId in interface ILookAndFeelCapability

Parameters:: lookId - lookId

getWidth

public String getWidth()

Description copied from interface: IWidthCapability

Returns a string value (as specified by CSS) for the width of the component.

Specified by:: getWidth in interface IWidthCapability

Returns:: width

getWidth

public String getWidth(FacesContext facesContext)

See getWidth() for more details

isWidthSetted

public final boolean isWidthSetted()

Returns true if the attribute "width" is set.

Returns:: true if the attribute is set.

setWidth

public void setWidth(String width)

Description copied from interface: IWidthCapability

Sets a string value (as specified by CSS) for the width of the component.

Specified by:: setWidth in interface IWidthCapability

Parameters:: width - width

getHeight

public String getHeight()

Description copied from interface: IHeightCapability

Returns a string value (as specified by CSS) for the height of the component.

Specified by:: getHeight in interface IHeightCapability

Returns:: height

getHeight

public String getHeight(FacesContext facesContext)

See getHeight() for more details

isHeightSetted

public final boolean isHeightSetted()

Returns true if the attribute "height" is set.

Returns:: true if the attribute is set.

setHeight

public void setHeight(String height)

Description copied from interface: IHeightCapability

Sets a string value (as specified by CSS) for the height of the component.

Specified by:: setHeight in interface IHeightCapability

Parameters:: height - height

getBackgroundColor

public String getBackgroundColor()

Description copied from interface: IForegroundBackgroundColorCapability

Returns the receiver's background color.

Specified by:: getBackgroundColor in interface IForegroundBackgroundColorCapability

Returns:: the background color

getBackgroundColor

public String getBackgroundColor(FacesContext facesContext)

See getBackgroundColor() for more details

isBackgroundColorSetted

public final boolean isBackgroundColorSetted()

Returns true if the attribute "backgroundColor" is set.

Returns:: true if the attribute is set.

setBackgroundColor

public void setBackgroundColor(String backgroundColor)

Description copied from interface: IForegroundBackgroundColorCapability

Sets the receiver's background color to the color specified by the argument, or to the default system color for the control if the argument is null.

Specified by:: setBackgroundColor in interface IForegroundBackgroundColorCapability

Parameters:: backgroundColor - background color

getForegroundColor

public String getForegroundColor()

Description copied from interface: IForegroundBackgroundColorCapability

Returns the foreground color that the receiver will use to draw.

Specified by:: getForegroundColor in interface IForegroundBackgroundColorCapability

Returns:: the receiver's foreground color

getForegroundColor

public String getForegroundColor(FacesContext facesContext)

See getForegroundColor() for more details

isForegroundColorSetted

public final boolean isForegroundColorSetted()

Returns true if the attribute "foregroundColor" is set.

Returns:: true if the attribute is set.

setForegroundColor

public void setForegroundColor(String foregroundColor)

Description copied from interface: IForegroundBackgroundColorCapability

Sets the receiver's foreground color to the color specified by the argument, or to the default system color for the control if the argument is null.

Specified by:: setForegroundColor in interface IForegroundBackgroundColorCapability

Parameters:: foregroundColor - foreground color

isVisible

public boolean isVisible()

Specified by:: isVisible in interface IVisibilityCapability

isVisible

public boolean isVisible(FacesContext facesContext)

See isVisible() for more details

isVisibleSetted

public final boolean isVisibleSetted()

Returns true if the attribute "visible" is set.

Returns:: true if the attribute is set.

setVisible

public void setVisible(boolean visible)

Description copied from interface: IVisibilityCapability

Marks the receiver as visible if the argument is TRUE, and marks it invisible if argument is FALSE.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.

Specified by:: setVisible in interface IVisibilityCapability

Parameters:: visible - the new visibility state.

getVisibleState

public Boolean getVisibleState()

Description copied from interface: IVisibilityCapability

Returns TRUE if the receiver is visible, FALSE if the receiver is specified "not visible", and null otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.

Specified by:: getVisibleState in interface IVisibilityCapability

Returns:: the receiver's visibility state

addErrorListener

public final void addErrorListener(IErrorListener listener)

Description copied from interface: IErrorEventCapability

Adds a listener to the component for the error event

Specified by:: addErrorListener in interface IErrorEventCapability

Parameters:: listener - the load listener to add

removeErrorListener

public final void removeErrorListener(IErrorListener listener)

Description copied from interface: IErrorEventCapability

Removes a listener from the component for the error event

Specified by:: removeErrorListener in interface IErrorEventCapability

Parameters:: listener - the load listener to remove

listErrorListeners

public final FacesListener[] listErrorListeners()

Description copied from interface: IErrorEventCapability

Returns a list of Error listener for the component

Specified by:: listErrorListeners in interface IErrorEventCapability

Returns:: load listeners' list

getAriaLabel

public String getAriaLabel()

Specified by:: getAriaLabel in interface IWAIRoleCapability

getAriaLabel

public String getAriaLabel(FacesContext facesContext)

See getAriaLabel() for more details

isAriaLabelSetted

public final boolean isAriaLabelSetted()

Returns true if the attribute "ariaLabel" is set.

Returns:: true if the attribute is set.

setAriaLabel

public void setAriaLabel(String ariaLabel)

Specified by:: setAriaLabel in interface IWAIRoleCapability

getAriaLevel

public int getAriaLevel()

Specified by:: getAriaLevel in interface IWAIRoleCapability

getAriaLevel

public int getAriaLevel(FacesContext facesContext)

See getAriaLevel() for more details

isAriaLevelSetted

public final boolean isAriaLevelSetted()

Returns true if the attribute "ariaLevel" is set.

Returns:: true if the attribute is set.

setAriaLevel

public void setAriaLevel(int ariaLevel)

Specified by:: setAriaLevel in interface IWAIRoleCapability

getWaiRole

public String getWaiRole()

Specified by:: getWaiRole in interface IWAIRoleCapability

getWaiRole

public String getWaiRole(FacesContext facesContext)

See getWaiRole() for more details

isWaiRoleSetted

public final boolean isWaiRoleSetted()

Returns true if the attribute "waiRole" is set.

Returns:: true if the attribute is set.

setWaiRole

public void setWaiRole(String waiRole)

Specified by:: setWaiRole in interface IWAIRoleCapability

getBottom

public int getBottom()

Specified by:: getBottom in interface ILayoutPositionCapability

getBottom

public int getBottom(FacesContext facesContext)

See getBottom() for more details

isBottomSetted

public final boolean isBottomSetted()

Returns true if the attribute "bottom" is set.

Returns:: true if the attribute is set.

setBottom

public void setBottom(int bottom)

Specified by:: setBottom in interface ILayoutPositionCapability

getLeft

public int getLeft()

Specified by:: getLeft in interface ILayoutPositionCapability

getLeft

public int getLeft(FacesContext facesContext)

See getLeft() for more details

isLeftSetted

public final boolean isLeftSetted()

Returns true if the attribute "left" is set.

Returns:: true if the attribute is set.

setLeft

public void setLeft(int left)

Specified by:: setLeft in interface ILayoutPositionCapability

getRight

public int getRight()

Specified by:: getRight in interface ILayoutPositionCapability

getRight

public int getRight(FacesContext facesContext)

See getRight() for more details

isRightSetted

public final boolean isRightSetted()

Returns true if the attribute "right" is set.

Returns:: true if the attribute is set.

setRight

public void setRight(int right)

Specified by:: setRight in interface ILayoutPositionCapability

getTop

public int getTop()

Specified by:: getTop in interface ILayoutPositionCapability

getTop

public int getTop(FacesContext facesContext)

See getTop() for more details

isTopSetted

public final boolean isTopSetted()

Returns true if the attribute "top" is set.

Returns:: true if the attribute is set.

setTop

public void setTop(int top)

Specified by:: setTop in interface ILayoutPositionCapability

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

getUnlockedClientAttributeNames

public String getUnlockedClientAttributeNames()

Description copied from interface: IUnlockedClientAttributesCapability

Returns a string value holding a comma separated list of the client modifiable properties.

Specified by:: getUnlockedClientAttributeNames in interface IUnlockedClientAttributesCapability

Returns:: list of modifiable attributes

getUnlockedClientAttributeNames

public String getUnlockedClientAttributeNames(FacesContext facesContext)

See getUnlockedClientAttributeNames() for more details

isUnlockedClientAttributeNamesSetted

public final boolean isUnlockedClientAttributeNamesSetted()

Returns true if the attribute "unlockedClientAttributeNames" is set.

Returns:: true if the attribute is set.

setUnlockedClientAttributeNames

public void setUnlockedClientAttributeNames(String unlockedClientAttributeNames)

Description copied from interface: IUnlockedClientAttributesCapability

Sets a string value holding a comma separated list of the client modifiable properties.

Specified by:: setUnlockedClientAttributeNames in interface IUnlockedClientAttributesCapability

Parameters:: unlockedClientAttributeNames - list of modifiable attributes

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

addPropertyChangeListener

public final void addPropertyChangeListener(IPropertyChangeListener listener)

Description copied from interface: IPropertyChangeEventCapability

Adds a listener to the component for the propertyChange event

Specified by:: addPropertyChangeListener in interface IPropertyChangeEventCapability

Parameters:: listener - the propertyChange listener to add

removePropertyChangeListener

public final void removePropertyChangeListener(IPropertyChangeListener listener)

Description copied from interface: IPropertyChangeEventCapability

Removes a listener from the component for the propertyChange event

Specified by:: removePropertyChangeListener in interface IPropertyChangeEventCapability

Parameters:: listener - the propertyChange listener to remove

listPropertyChangeListeners

public final FacesListener[] listPropertyChangeListeners()

Description copied from interface: IPropertyChangeEventCapability

Returns a list of propertyChange listener for the component

Specified by:: listPropertyChangeListeners in interface IPropertyChangeEventCapability

Returns:: propertyChange listeners' list

getHiddenMode

public int getHiddenMode()

Description copied from interface: IHiddenModeCapability

Returns the hidden mode in client side.

Specified by:: getHiddenMode in interface IHiddenModeCapability

Returns:: hidden mode

getHiddenMode

public int getHiddenMode(FacesContext facesContext)

See getHiddenMode() for more details

isHiddenModeSetted

public final boolean isHiddenModeSetted()

Returns true if the attribute "hiddenMode" is set.

Returns:: true if the attribute is set.

setHiddenMode

public void setHiddenMode(int hiddenMode)

Description copied from interface: IHiddenModeCapability

Set the hidden mode in client side.

Specified by:: setHiddenMode in interface IHiddenModeCapability

Parameters:: hiddenMode - hidden mode

listServerDataKeys

public String[] listServerDataKeys()

Description copied from interface: IServerDataCapability

Returns a list of the keys defined for the component

Specified by:: listServerDataKeys in interface IServerDataCapability

Returns:: list of keys

getServerDataMap

public Map getServerDataMap()

Description copied from interface: IServerDataCapability

Returns a Map object containing keys and associated data objects

Specified by:: getServerDataMap in interface IServerDataCapability

Returns:: a map

getServerDataCount

public int getServerDataCount()

Description copied from interface: IServerDataCapability

Returns the number of keys associated to the component.

Specified by:: getServerDataCount in interface IServerDataCapability

Returns:: number of keys

getServerData

public Object getServerData(String name)

Description copied from interface: IServerDataCapability

Retrieves an object data associated to a key

Specified by:: getServerData in interface IServerDataCapability

Parameters:: name - the key to retrieve
Returns:: the data object associated to the key

removeServerData

public Object removeServerData(String name)

Description copied from interface: IServerDataCapability

Removes a key and the data object associated to it

Specified by:: removeServerData in interface IServerDataCapability

Parameters:: name - the key to remove
Returns:: the data object that was associated to the key (null if none)

getCameliaFields

protected Set getCameliaFields()

Overrides:: getCameliaFields in class org.rcfaces.core.internal.component.CameliaMessageComponent

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.rcfaces.core.component Class AbstractMessageComponent

CAMELIA_ATTRIBUTES

AbstractMessageComponent

getServerDataMap

setServerData

getClientDataMap

setClientData

setServerData

listClientDataKeys

setClientData

getClientData

getServerData

setMargins

listServerDataKeys

setHiddenMode

getVisibleState

getMarginBottom

getMarginBottom

isMarginBottomSetted

setMarginBottom

getMarginLeft

getMarginLeft

isMarginLeftSetted

setMarginLeft

getMarginRight

getMarginRight

isMarginRightSetted

setMarginRight

getMarginTop

getMarginTop

isMarginTopSetted

setMarginTop

addUserEventListener

removeUserEventListener

listUserEventListeners

getX

getX

isXSetted

setX

getY

getY

isYSetted

setY

getHelpMessage

getHelpMessage

isHelpMessageSetted

setHelpMessage

getHelpURL

getHelpURL

isHelpURLSetted

setHelpURL

getToolTipText

getToolTipText

isToolTipTextSetted

setToolTipText

getClientDataCount

listClientDataKeys

removeClientData

getClientData

getClientDataMap

isPartialRendering

isPartialRendering

isPartialRenderingSetted

setPartialRendering

getStyleClass

getStyleClass

isStyleClassSetted

setStyleClass

getLookId

getLookId

isLookIdSetted

setLookId

getWidth

getWidth

isWidthSetted

setWidth

getHeight

getHeight

isHeightSetted

setHeight

org.rcfaces.core.component
Class AbstractMessageComponent