org.rcfaces.core.component
Class HelpMessageZoneComponent

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

All Implemented Interfaces:

StateHolder, ValueHolder, IClientDataCapability, IErrorEventCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IInitEventCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPositionCapability, IPropertyChangeEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, ITextAlignmentCapability, ITextCapability, ITextDirectionCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValueLockedCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, org.rcfaces.core.internal.capability.IConvertValueHolder, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager

public class HelpMessageZoneComponent
extends AbstractOutputComponent
implements ITextCapability, ITextDirectionCapability, IFontCapability, ITextAlignmentCapability

The helpMessageZone Component is a placeholder for help messages. The messages are shown when the pointer hover a component and this component has a "helpMessage" property.

The helpMessageZone Component has the following capabilities :

• Position & Size
• Foreground & Background Color
• Text, font & position
• Margin & border
• Help
• Visibility
• Events Handling

Field Summary

protected static Set	CAMELIA_ATTRIBUTES
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.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

HelpMessageZoneComponent()

HelpMessageZoneComponent(String componentId)

Method Summary

protected Set	getCameliaFields()
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	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	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	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.
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	setText(String text) Sets a string value specifying the text to be shown.
void	setTextAlignment(String textAlignment) Specifies horizontal alignment.
void	setTextDirection(int textDirection)

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

addErrorListener, addInitListener, addMouseOutListener, addMouseOverListener, addPropertyChangeListener, addUserEventListener, getBackgroundColor, getBackgroundColor, getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, getForegroundColor, getForegroundColor, getHeight, getHeight, getHelpMessage, getHelpMessage, getHelpURL, getHelpURL, getHiddenMode, getHiddenMode, getLookId, getLookId, getMarginBottom, getMarginBottom, getMarginLeft, getMarginLeft, getMarginRight, getMarginRight, getMarginTop, getMarginTop, getServerData, getServerData, getServerDataCount, getServerDataMap, getServerDataMap, getStyleClass, getStyleClass, getToolTipText, getToolTipText, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isBackgroundColorSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isStyleClassSetted, isToolTipTextSetted, 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, setBackgroundColor, setClientData, setClientData, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setServerData, setServerData, setStyleClass, setToolTipText, setUnlockedClientAttributeNames, setValueLocked, setVisible, setWaiRole, setWidth, setX, setY

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

clearListeners, constructTemplate, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, getFamily, getRendererType, getTransientAttribute, getValueExpression, hasDefaultProperties, initializeComponent, isClientRendered, isRendered, isTemplateComponent, processDecodes, processEngineUpdates, processUpdates, processValidators, queueEvent, restoreState, saveState, setConverter, setConverter, setDefaultProperties, setRendered, setTransientAttribute, setValueExpression, toString, 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.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

Constructor Detail

HelpMessageZoneComponent

public HelpMessageZoneComponent()

HelpMessageZoneComponent

public HelpMessageZoneComponent(String componentId)

Method Detail

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

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

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

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class AbstractOutputComponent