org.rcfaces.core.component
Class TextComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by org.rcfaces.core.internal.component.CameliaOutputComponent
                  extended by org.rcfaces.core.component.AbstractOutputComponent
                      extended by org.rcfaces.core.component.TextComponent
All Implemented Interfaces:
StateHolder, ValueHolder, IAccessKeyCapability, IClientDataCapability, IErrorEventCapability, IFontCapability, IForCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IInitEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IServerDataCapability, ISizeCapability, IStyleClassCapability, ITextAlignmentCapability, ITextCapability, ITextDirectionCapability, IToolTipCapability, ITypedComponentCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValueLockedCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, 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
Direct Known Subclasses:
StyledTextComponent

public class TextComponent
extends AbstractOutputComponent
implements ITextCapability, ITextDirectionCapability, IFontCapability, ITextAlignmentCapability, IAccessKeyCapability, IForCapability, ITypedComponentCapability

The text Component is a placeholder for displaying text.

The text Component has the following capabilities :

The default text renderer is linked to the f_text javascript class. f_text extends f_component

Table of component style classes:

Style Name Description
f_text Defines styles for the wrapper element


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.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
TextComponent()
           
TextComponent(String componentId)
           
 
Method Summary
 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
protected  Set getCameliaFields()
           
protected  String getCameliaValueAlias()
           
 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 getFor()
          Returns a component's id that express the link between the two components.
 String getFor(FacesContext facesContext)
          See getFor() 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
 String getType()
           
 String getType(FacesContext facesContext)
          See getType() for more details
 boolean isAccessKeySetted()
          Returns true if the attribute "accessKey" 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 isForSetted()
          Returns true if the attribute "for" 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 isTypeSetted()
          Returns true if the attribute "type" is set.
 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 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 setFor(String forValue)
          Sets a component's id that express the link between the two components.
 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 setType(String type)
           
 
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.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

TextComponent

public TextComponent()

TextComponent

public TextComponent(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

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>

getFor

public String getFor()
Description copied from interface: IForCapability
Returns a component's id that express the link between the two components.

Specified by:
getFor in interface IForCapability
Returns:
id for a linked component

getFor

public String getFor(FacesContext facesContext)
See getFor() for more details


isForSetted

public final boolean isForSetted()
Returns true if the attribute "for" is set.

Returns:
true if the attribute is set.

setFor

public void setFor(String forValue)
Description copied from interface: IForCapability
Sets a component's id that express the link between the two components.

Specified by:
setFor in interface IForCapability
Parameters:
forValue - id for a linked component

getType

public String getType()
Specified by:
getType in interface ITypedComponentCapability

getType

public String getType(FacesContext facesContext)
See getType() for more details


isTypeSetted

public final boolean isTypeSetted()
Returns true if the attribute "type" is set.

Returns:
true if the attribute is set.

setType

public void setType(String type)
Specified by:
setType in interface ITypedComponentCapability

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class AbstractOutputComponent

getCameliaValueAlias

protected String getCameliaValueAlias()
Overrides:
getCameliaValueAlias in class org.rcfaces.core.internal.component.CameliaOutputComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.