org.rcfaces.core.component
Class TextEntryComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by org.rcfaces.core.internal.component.CameliaInputComponent
                      extended by org.rcfaces.core.component.AbstractInputComponent
                          extended by org.rcfaces.core.component.TextEntryComponent
All Implemented Interfaces:
EditableValueHolder, StateHolder, ValueHolder, IAccessKeyCapability, IAlternateTextCapability, IAutoTabCapability, IClientDataCapability, IClientValidationCapability, IDisabledCapability, IEmptyMessageCapability, IErrorEventCapability, IFocusBlurEventCapability, IFocusStyleClassCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, IKeyDownEventCapability, IKeyEventCapability, IKeyPressEventCapability, IKeyUpEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMaxTextLengthCapability, IMenuCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IReadOnlyCapability, IRequiredCapability, ISelectionEventCapability, IServerDataCapability, ISeverityStyleClassCapability, ISizeCapability, IStyleClassCapability, ITabIndexCapability, ITextAlignmentCapability, ITextCapability, ITextDirectionCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValidationEventCapability, IValueChangeEventCapability, 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.capability.ISubmittedExternalValue, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager, org.rcfaces.core.internal.manager.IValidationParameters
Direct Known Subclasses:
PasswordEntryComponent, SpinnerComponent, SuggestTextEntryComponent

public class TextEntryComponent
extends AbstractInputComponent
implements IRequiredCapability, IAutoTabCapability, ITextCapability, ITextDirectionCapability, IEmptyMessageCapability, IReadOnlyCapability, IValueChangeEventCapability, IMenuCapability, IFocusStyleClassCapability, ISeverityStyleClassCapability, IAlternateTextCapability, IMaxTextLengthCapability, IClientValidationCapability, ISelectionEventCapability, org.rcfaces.core.internal.manager.IValidationParameters

The textEntry Component is based on the standard HTML tag <INPUT TYPE="text">.

The textEntry Component has the following capabilities :

The default textEntry renderer is linked to the f_textEntry javascript class. f_textEntry extends f_abstractEntry

Table of component style classes:

Style Name Description
f_textEntry 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.CameliaInputComponent
engine
 
Fields inherited from class javax.faces.component.UIInput
COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID
 
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
TextEntryComponent()
           
TextEntryComponent(String componentId)
           
 
Method Summary
 void addSelectionListener(ISelectionListener listener)
          Adds a listener to the component for the selection event
 void addValueChangeListener(ValueChangeListener listener)
          Adds a listener to the component for the valueChange event
 String getAlternateText()
           
 String getAlternateText(FacesContext facesContext)
          See getAlternateText() for more details
protected  Set getCameliaFields()
           
protected  String getCameliaValueAlias()
           
 Map getClientValidationParametersMap()
           
 Map getClientValidationParametersMap(FacesContext facesContext)
           
 String getClientValidator()
          Returns a key identifying a validation process to apply to the component.
 String getClientValidator(FacesContext facesContext)
          See getClientValidator() for more details
 int getColumnNumber()
          Returns an int value holding the width of the component in characters : x characters translates into y pixels width.
 int getColumnNumber(FacesContext facesContext)
          Returns an int value holding the width of the component in characters : x characters translates into y pixels width.
 String getEmptyMessage()
          Returns a string containing the message shown when there is no result.
 String getEmptyMessage(FacesContext facesContext)
          See getEmptyMessage() for more details
 String getErrorStyleClass()
          Returns a space-separated list of CSS style class(es) to be applied for error messages.
 String getErrorStyleClass(FacesContext facesContext)
          See getErrorStyleClass() for more details
 String getFatalStyleClass()
          Returns a space-separated list of CSS style class(es) to be applied for fatal messages.
 String getFatalStyleClass(FacesContext facesContext)
          See getFatalStyleClass() for more details
 String getFocusStyleClass()
          Returns the style class of the component.
 String getFocusStyleClass(FacesContext facesContext)
          See getFocusStyleClass() for more details
 String getInfoStyleClass()
          Returns a space-separated list of CSS style class(es) to be applied for info messages.
 String getInfoStyleClass(FacesContext facesContext)
          See getInfoStyleClass() for more details
 int getMaxTextLength()
          Returns an int value specifying the maximum number of characters that the user can enter in the component.
 int getMaxTextLength(FacesContext facesContext)
          See getMaxTextLength() for more details
 IMenuComponent getMenu()
          Returns the top-most menu associated to the component.
 IMenuComponent getMenu(String menuId)
          Returns the menu identified by its id from the menus associated to the component.
 String getText()
          Returns a string value specifying the text shown.
 String getText(FacesContext facesContext)
          See getText() for more details
 int getTextDirection()
           
 int getTextDirection(FacesContext facesContext)
          See getTextDirection() for more details
 String getValidationParameter(String name)
           
 String getValidationParameter(String name, FacesContext facesContext)
           
 int getValidationParametersCount()
           
 int getValidationParametersCount(FacesContext facesContext)
           
 Map getValidationParametersMap()
           
 Map getValidationParametersMap(FacesContext facesContext)
           
 String getWarnStyleClass()
          Returns a space-separated list of CSS style class(es) to be applied for warning messages.
 String getWarnStyleClass(FacesContext facesContext)
          See getWarnStyleClass() for more details
 boolean isAlternateTextSetted()
          Returns true if the attribute "alternateText" is set.
 boolean isAutoCompletion()
          Returns a boolean value indicating if the component should complete automaticaly the user entry.
 boolean isAutoCompletion(FacesContext facesContext)
          Returns a boolean value indicating if the component should complete automaticaly the user entry.
 boolean isAutoCompletionSetted()
          Returns true if the attribute "autoCompletion" is set.
 boolean isAutoTab()
          Returns a boolean value indicating if the focus should move automatically to the next element when the entry is completed.
 boolean isAutoTab(FacesContext facesContext)
          See isAutoTab() for more details
 boolean isAutoTabSetted()
          Returns true if the attribute "autoTab" is set.
 boolean isClientSideValidationParameter(String name)
           
 boolean isClientSideValidationParameter(String name, FacesContext facesContext)
           
 boolean isClientValidatorSetted()
          Returns true if the attribute "clientValidator" is set.
 boolean isColumnNumberSetted()
          Returns true if the attribute "columnNumber" is set.
 boolean isEmptyMessageSetted()
          Returns true if the attribute "emptyMessage" is set.
 boolean isErrorStyleClassSetted()
          Returns true if the attribute "errorStyleClass" is set.
 boolean isFatalStyleClassSetted()
          Returns true if the attribute "fatalStyleClass" is set.
 boolean isFocusStyleClassSetted()
          Returns true if the attribute "focusStyleClass" is set.
 boolean isInfoStyleClassSetted()
          Returns true if the attribute "infoStyleClass" is set.
 boolean isMaxTextLengthSetted()
          Returns true if the attribute "maxTextLength" 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 isTextDirectionSetted()
          Returns true if the attribute "textDirection" is set.
 boolean isTextSetted()
          Returns true if the attribute "text" is set.
 boolean isWarnStyleClassSetted()
          Returns true if the attribute "warnStyleClass" is set.
 IMenuIterator listMenus()
          Returns a list of all the menus associated to the component.
 FacesListener[] listSelectionListeners()
          Returns a list of selection listener for the component
 FacesListener[] listValueChangeListeners()
          Returns a list of valueChange listener for the component
 void removeSelectionListener(ISelectionListener listener)
          Removes a listener from the component for the selection event
 String removeValidationParameter(String name)
           
 void removeValueChangeListener(ValueChangeListener listener)
          Removes a listener from the component for the valueChange event
 void setAlternateText(String alternateText)
           
 void setAutoCompletion(boolean autoCompletion)
          Sets a boolean value indicating if the component should complete automaticaly the user entry.
 void setAutoTab(boolean autoTab)
          Sets a boolean value indicating if the focus should move automatically to the next element when the entry is completed.
 void setClientValidator(String clientValidator)
          Sets a key identifying a validation process to apply to the component.
 void setColumnNumber(int columnNumber)
          Sets an int value holding the width of the component in characters : x characters translates into y pixels width.
 void setEmptyMessage(String emptyMessage)
          Sets the string conatining the message shown when there is no result.
 void setErrorStyleClass(String errorStyleClass)
          Sets a space-separated list of CSS style class(es) to be applied for error messages.
 void setFatalStyleClass(String fatalStyleClass)
          Sets a space-separated list of CSS style class(es) to be applied for fatal messages.
 void setFocusStyleClass(String focusStyleClass)
          Specify the style class of the component.
 void setInfoStyleClass(String infoStyleClass)
          Sets a space-separated list of CSS style class(es) to be applied for info messages.
 void setMaxTextLength(int maxTextLength)
          Sets an int value specifying the maximum number of characters that the user can enter in the component.
 void setReadOnly(boolean readOnly)
          Sets a boolean value indicating that this component will prohibit changes by the user.
 void setText(String text)
          Sets a string value specifying the text to be shown.
 void setTextDirection(int textDirection)
           
 String setValidationParameter(String name, String value, boolean client)
           
 void setValidationParameter(String name, javax.el.ValueExpression value, boolean client)
           
 void setWarnStyleClass(String warnStyleClass)
          Sets a space-separated list of CSS style class(es) to be applied for warning messages.
 
Methods inherited from class org.rcfaces.core.component.AbstractInputComponent
addBlurListener, addErrorListener, addFocusListener, addInitListener, addKeyDownListener, addKeyPressListener, addKeyUpListener, addMouseOutListener, addMouseOverListener, addPropertyChangeListener, addUserEventListener, addValidationListener, getAccessKey, getAccessKey, getAriaLabel, getAriaLabel, getAriaLevel, getAriaLevel, getBackgroundColor, getBackgroundColor, getBottom, getBottom, getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, getFontBold, getFontBold, getFontItalic, getFontItalic, getFontName, getFontName, getFontSize, getFontSize, getFontUnderline, getFontUnderline, 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, getTabIndex, getTabIndex, getTextAlignment, getTextAlignment, getToolTipText, getToolTipText, getTop, getTop, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isAccessKeySetted, isAriaLabelSetted, isAriaLevelSetted, isBackgroundColorSetted, isBottomSetted, isDisabled, isDisabled, isDisabledSetted, isFontBoldSetted, isFontItalicSetted, isFontNameSetted, isFontSizeSetted, isFontUnderlineSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isLeftSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isPartialRendering, isPartialRendering, isPartialRenderingSetted, isRightSetted, isStyleClassSetted, isTabIndexSetted, isTextAlignmentSetted, isToolTipTextSetted, isTopSetted, isUnlockedClientAttributeNamesSetted, isValueLocked, isValueLocked, isValueLockedSetted, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWidthSetted, isXSetted, isYSetted, listBlurListeners, listClientDataKeys, listClientDataKeys, listErrorListeners, listFocusListeners, listInitListeners, listKeyDownListeners, listKeyPressListeners, listKeyUpListeners, listMouseOutListeners, listMouseOverListeners, listPropertyChangeListeners, listServerDataKeys, listServerDataKeys, listUserEventListeners, listValidationListeners, removeBlurListener, removeClientData, removeErrorListener, removeFocusListener, removeInitListener, removeKeyDownListener, removeKeyPressListener, removeKeyUpListener, removeMouseOutListener, removeMouseOverListener, removePropertyChangeListener, removeServerData, removeUserEventListener, removeValidationListener, setAccessKey, setAriaLabel, setAriaLevel, setBackgroundColor, setBottom, setClientData, setClientData, setDisabled, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setLeft, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPartialRendering, setRight, setServerData, setServerData, setStyleClass, setTabIndex, setTextAlignment, setToolTipText, setTop, setUnlockedClientAttributeNames, setValueLocked, setVisible, setWaiRole, setWidth, setX, setY
 
Methods inherited from class org.rcfaces.core.internal.component.CameliaInputComponent
broadcast, clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getChildren, getChildrenListState, getConvertedValue, getFamily, getLocalValue, getRendererType, getSubmittedExternalValue, getTransientAttribute, getValue, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isSubmittedValueSetted, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setConverter, setConverter, setDefaultProperties, setRendered, setSubmittedExternalValue, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode
 
Methods inherited from class javax.faces.component.UIInput
addValidator, compareValues, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, removeValidator, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, 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.IRequiredCapability
isRequired, setRequired
 
Methods inherited from interface org.rcfaces.core.component.capability.IStyleClassCapability
getStyleClass, setStyleClass
 
Methods inherited from interface org.rcfaces.core.component.capability.IImmediateCapability
isImmediate, setImmediate
 
Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager
getChildCount
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, 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

TextEntryComponent

public TextEntryComponent()

TextEntryComponent

public TextEntryComponent(String componentId)
Method Detail

getValidationParametersCount

public int getValidationParametersCount()
Specified by:
getValidationParametersCount in interface org.rcfaces.core.internal.manager.IValidationParameters

isClientSideValidationParameter

public boolean isClientSideValidationParameter(String name)
Specified by:
isClientSideValidationParameter in interface org.rcfaces.core.internal.manager.IValidationParameters

getValidationParametersMap

public Map getValidationParametersMap()
Specified by:
getValidationParametersMap in interface org.rcfaces.core.internal.manager.IValidationParameters

setValidationParameter

public void setValidationParameter(String name,
                                   javax.el.ValueExpression value,
                                   boolean client)
Specified by:
setValidationParameter in interface org.rcfaces.core.internal.manager.IValidationParameters

getValidationParameter

public String getValidationParameter(String name)
Specified by:
getValidationParameter in interface org.rcfaces.core.internal.manager.IValidationParameters

getClientValidationParametersMap

public Map getClientValidationParametersMap()
Specified by:
getClientValidationParametersMap in interface org.rcfaces.core.internal.manager.IValidationParameters

removeValidationParameter

public String removeValidationParameter(String name)
Specified by:
removeValidationParameter in interface org.rcfaces.core.internal.manager.IValidationParameters

setValidationParameter

public String setValidationParameter(String name,
                                     String value,
                                     boolean client)
Specified by:
setValidationParameter in interface org.rcfaces.core.internal.manager.IValidationParameters

getValidationParameter

public String getValidationParameter(String name,
                                     FacesContext facesContext)

getValidationParametersCount

public int getValidationParametersCount(FacesContext facesContext)

getValidationParametersMap

public Map getValidationParametersMap(FacesContext facesContext)

getClientValidationParametersMap

public Map getClientValidationParametersMap(FacesContext facesContext)

isClientSideValidationParameter

public boolean isClientSideValidationParameter(String name,
                                               FacesContext facesContext)

setClientValidator

public void setClientValidator(String clientValidator)
Description copied from interface: IClientValidationCapability
Sets a key identifying a validation process to apply to the component. this validation process can handle parameters. cf. the clientValidator doc.

Specified by:
setClientValidator in interface IClientValidationCapability
Parameters:
clientValidator - client validator key

isAutoTab

public boolean isAutoTab()
Description copied from interface: IAutoTabCapability
Returns a boolean value indicating if the focus should move automatically to the next element when the entry is completed.

Specified by:
isAutoTab in interface IAutoTabCapability
Returns:
boolean

isAutoTab

public boolean isAutoTab(FacesContext facesContext)
See isAutoTab() for more details


isAutoTabSetted

public final boolean isAutoTabSetted()
Returns true if the attribute "autoTab" is set.

Returns:
true if the attribute is set.

setAutoTab

public void setAutoTab(boolean autoTab)
Description copied from interface: IAutoTabCapability
Sets a boolean value indicating if the focus should move automatically to the next element when the entry is completed.

Specified by:
setAutoTab in interface IAutoTabCapability
Parameters:
autoTab - boolean

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

getEmptyMessage

public String getEmptyMessage()
Description copied from interface: IEmptyMessageCapability
Returns a string containing the message shown when there is no result.

Specified by:
getEmptyMessage in interface IEmptyMessageCapability
Returns:
message

getEmptyMessage

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


isEmptyMessageSetted

public final boolean isEmptyMessageSetted()
Returns true if the attribute "emptyMessage" is set.

Returns:
true if the attribute is set.

setEmptyMessage

public void setEmptyMessage(String emptyMessage)
Description copied from interface: IEmptyMessageCapability
Sets the string conatining the message shown when there is no result.

Specified by:
setEmptyMessage in interface IEmptyMessageCapability
Parameters:
emptyMessage - the message

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

addValueChangeListener

public final void addValueChangeListener(ValueChangeListener listener)
Description copied from interface: IValueChangeEventCapability
Adds a listener to the component for the valueChange event

Specified by:
addValueChangeListener in interface EditableValueHolder
Specified by:
addValueChangeListener in interface IValueChangeEventCapability
Overrides:
addValueChangeListener in class UIInput
Parameters:
listener - the valueChange listener to add

removeValueChangeListener

public final void removeValueChangeListener(ValueChangeListener listener)
Description copied from interface: IValueChangeEventCapability
Removes a listener from the component for the valueChange event

Specified by:
removeValueChangeListener in interface EditableValueHolder
Specified by:
removeValueChangeListener in interface IValueChangeEventCapability
Overrides:
removeValueChangeListener in class UIInput
Parameters:
listener - the valueChange listener to remove

listValueChangeListeners

public final FacesListener[] listValueChangeListeners()
Description copied from interface: IValueChangeEventCapability
Returns a list of valueChange listener for the component

Specified by:
listValueChangeListeners in interface IValueChangeEventCapability
Returns:
valueChange listeners' list

getMenu

public IMenuComponent getMenu()
Description copied from interface: IMenuCapability
Returns the top-most menu associated to the component.

Specified by:
getMenu in interface IMenuCapability
Returns:
top-most menu component

getMenu

public IMenuComponent getMenu(String menuId)
Description copied from interface: IMenuCapability
Returns the menu identified by its id from the menus associated to the component.

Specified by:
getMenu in interface IMenuCapability
Parameters:
menuId - Id for a particular menu
Returns:
menu component

listMenus

public IMenuIterator listMenus()
Description copied from interface: IMenuCapability
Returns a list of all the menus associated to the component.

Specified by:
listMenus in interface IMenuCapability
Returns:
Menu iterator

getFocusStyleClass

public String getFocusStyleClass()
Description copied from interface: IFocusStyleClassCapability
Returns the style class of the component.

Specified by:
getFocusStyleClass in interface IFocusStyleClassCapability
Returns:
style class

getFocusStyleClass

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


isFocusStyleClassSetted

public final boolean isFocusStyleClassSetted()
Returns true if the attribute "focusStyleClass" is set.

Returns:
true if the attribute is set.

setFocusStyleClass

public void setFocusStyleClass(String focusStyleClass)
Description copied from interface: IFocusStyleClassCapability
Specify the style class of the component.

Specified by:
setFocusStyleClass in interface IFocusStyleClassCapability
Parameters:
focusStyleClass - style class

getErrorStyleClass

public String getErrorStyleClass()
Description copied from interface: ISeverityStyleClassCapability
Returns a space-separated list of CSS style class(es) to be applied for error messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
getErrorStyleClass in interface ISeverityStyleClassCapability
Returns:
list of CSS style classes

getErrorStyleClass

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


isErrorStyleClassSetted

public final boolean isErrorStyleClassSetted()
Returns true if the attribute "errorStyleClass" is set.

Returns:
true if the attribute is set.

setErrorStyleClass

public void setErrorStyleClass(String errorStyleClass)
Description copied from interface: ISeverityStyleClassCapability
Sets a space-separated list of CSS style class(es) to be applied for error messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
setErrorStyleClass in interface ISeverityStyleClassCapability
Parameters:
errorStyleClass - list of CSS style classes

getFatalStyleClass

public String getFatalStyleClass()
Description copied from interface: ISeverityStyleClassCapability
Returns a space-separated list of CSS style class(es) to be applied for fatal messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
getFatalStyleClass in interface ISeverityStyleClassCapability
Returns:
list of CSS style classes

getFatalStyleClass

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


isFatalStyleClassSetted

public final boolean isFatalStyleClassSetted()
Returns true if the attribute "fatalStyleClass" is set.

Returns:
true if the attribute is set.

setFatalStyleClass

public void setFatalStyleClass(String fatalStyleClass)
Description copied from interface: ISeverityStyleClassCapability
Sets a space-separated list of CSS style class(es) to be applied for fatal messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
setFatalStyleClass in interface ISeverityStyleClassCapability
Parameters:
fatalStyleClass - list of CSS style classes

getInfoStyleClass

public String getInfoStyleClass()
Description copied from interface: ISeverityStyleClassCapability
Returns a space-separated list of CSS style class(es) to be applied for info messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
getInfoStyleClass in interface ISeverityStyleClassCapability
Returns:
list of CSS style classes

getInfoStyleClass

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


isInfoStyleClassSetted

public final boolean isInfoStyleClassSetted()
Returns true if the attribute "infoStyleClass" is set.

Returns:
true if the attribute is set.

setInfoStyleClass

public void setInfoStyleClass(String infoStyleClass)
Description copied from interface: ISeverityStyleClassCapability
Sets a space-separated list of CSS style class(es) to be applied for info messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
setInfoStyleClass in interface ISeverityStyleClassCapability
Parameters:
infoStyleClass - list of CSS style classes

getWarnStyleClass

public String getWarnStyleClass()
Description copied from interface: ISeverityStyleClassCapability
Returns a space-separated list of CSS style class(es) to be applied for warning messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
getWarnStyleClass in interface ISeverityStyleClassCapability
Returns:
list of CSS style classes

getWarnStyleClass

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


isWarnStyleClassSetted

public final boolean isWarnStyleClassSetted()
Returns true if the attribute "warnStyleClass" is set.

Returns:
true if the attribute is set.

setWarnStyleClass

public void setWarnStyleClass(String warnStyleClass)
Description copied from interface: ISeverityStyleClassCapability
Sets a space-separated list of CSS style class(es) to be applied for warning messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:
setWarnStyleClass in interface ISeverityStyleClassCapability
Parameters:
warnStyleClass - list of CSS style classes

getAlternateText

public String getAlternateText()
Specified by:
getAlternateText in interface IAlternateTextCapability

getAlternateText

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


isAlternateTextSetted

public final boolean isAlternateTextSetted()
Returns true if the attribute "alternateText" is set.

Returns:
true if the attribute is set.

setAlternateText

public void setAlternateText(String alternateText)
Specified by:
setAlternateText in interface IAlternateTextCapability

getMaxTextLength

public int getMaxTextLength()
Description copied from interface: IMaxTextLengthCapability
Returns an int value specifying the maximum number of characters that the user can enter in the component.

Specified by:
getMaxTextLength in interface IMaxTextLengthCapability
Returns:
maximum number of characters

getMaxTextLength

public int getMaxTextLength(FacesContext facesContext)
See getMaxTextLength() for more details


isMaxTextLengthSetted

public final boolean isMaxTextLengthSetted()
Returns true if the attribute "maxTextLength" is set.

Returns:
true if the attribute is set.

setMaxTextLength

public void setMaxTextLength(int maxTextLength)
Description copied from interface: IMaxTextLengthCapability
Sets an int value specifying the maximum number of characters that the user can enter in the component.

Specified by:
setMaxTextLength in interface IMaxTextLengthCapability
Parameters:
maxTextLength - maximum number of characters

getClientValidator

public String getClientValidator()
Description copied from interface: IClientValidationCapability
Returns a key identifying a validation process to apply to the component. this validation process can handle parameters. cf. the clientValidator doc.

Specified by:
getClientValidator in interface IClientValidationCapability
Returns:
client validator key

getClientValidator

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


isClientValidatorSetted

public final boolean isClientValidatorSetted()
Returns true if the attribute "clientValidator" is set.

Returns:
true if the attribute is set.

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

getColumnNumber

public int getColumnNumber()
Returns an int value holding the width of the component in characters : x characters translates into y pixels width.

Returns:
width in characters

getColumnNumber

public int getColumnNumber(FacesContext facesContext)
Returns an int value holding the width of the component in characters : x characters translates into y pixels width.

Returns:
width in characters

setColumnNumber

public void setColumnNumber(int columnNumber)
Sets an int value holding the width of the component in characters : x characters translates into y pixels width.

Parameters:
columnNumber - width in characters

isColumnNumberSetted

public boolean isColumnNumberSetted()
Returns true if the attribute "columnNumber" is set.

Returns:
true if the attribute is set.

isAutoCompletion

public boolean isAutoCompletion()
Returns a boolean value indicating if the component should complete automaticaly the user entry.

Returns:
true if the user entry must completed

isAutoCompletion

public boolean isAutoCompletion(FacesContext facesContext)
Returns a boolean value indicating if the component should complete automaticaly the user entry.

Returns:
true if the user entry must completed

setAutoCompletion

public void setAutoCompletion(boolean autoCompletion)
Sets a boolean value indicating if the component should complete automaticaly the user entry.

Parameters:
autoCompletion - true if the user entry must completed

isAutoCompletionSetted

public boolean isAutoCompletionSetted()
Returns true if the attribute "autoCompletion" is set.

Returns:
true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class AbstractInputComponent

getCameliaValueAlias

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


Copyright © 2006-2011 Vedana. All Rights Reserved.