|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
org.rcfaces.core.internal.component.CameliaInputComponent
org.rcfaces.core.component.AbstractInputComponent
org.rcfaces.core.component.TextAreaComponent
public class TextAreaComponent
The textAreaEntry Component is based on the standard HTML tag <TEXTAREA> and is a textEntry Component.
The textAreaEntry Component has the following capabilities :
The default textArea renderer is linked to the f_textArea javascript class. f_textArea extends f_abstractEntry
Table of component style classes:
| Style Name | Description |
|---|---|
| f_textArea | 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 | |
|---|---|
TextAreaComponent()
|
|
TextAreaComponent(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()
|
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. |
int |
getRowNumber()
Returns an int value specifying the number of rows to be displayed. |
int |
getRowNumber(FacesContext facesContext)
Returns an int value specifying the number of rows to be displayed. |
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 |
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 |
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 |
isIgnoreWhenFull()
|
boolean |
isIgnoreWhenFull(FacesContext facesContext)
|
boolean |
isIgnoreWhenFullSetted()
Returns true if the attribute "ignoreWhenFull" 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 |
isRowNumberSetted()
Returns true if the attribute "rowNumber" 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 |
void |
removeValueChangeListener(ValueChangeListener listener)
Removes a listener from the component for the valueChange event |
void |
setAlternateText(String alternateText)
|
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 |
setIgnoreWhenFull(boolean ignoreWhenFull)
|
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 |
setRowNumber(int rowNumber)
Sets an int value specifying the number of rows to be displayed. |
void |
setText(String text)
Sets a string value specifying the text to be shown. |
void |
setTextDirection(int textDirection)
|
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.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 |
|---|
public static final String COMPONENT_TYPE
protected static final Set CAMELIA_ATTRIBUTES
protected static final String CAMELIA_VALUE_ALIAS
| Constructor Detail |
|---|
public TextAreaComponent()
public TextAreaComponent(String componentId)
| Method Detail |
|---|
public String getText()
ITextCapability
getText in interface ITextCapabilitypublic String getText(FacesContext facesContext)
getText() for more details
public final boolean isTextSetted()
true if the attribute "text" is set.
true if the attribute is set.public void setText(String text)
ITextCapability
setText in interface ITextCapabilitytext - textpublic int getTextDirection()
getTextDirection in interface ITextDirectionCapabilitypublic int getTextDirection(FacesContext facesContext)
getTextDirection() for more details
public final boolean isTextDirectionSetted()
true if the attribute "textDirection" is set.
true if the attribute is set.public void setTextDirection(int textDirection)
setTextDirection in interface ITextDirectionCapabilitypublic String getEmptyMessage()
IEmptyMessageCapability
getEmptyMessage in interface IEmptyMessageCapabilitypublic String getEmptyMessage(FacesContext facesContext)
getEmptyMessage() for more details
public final boolean isEmptyMessageSetted()
true if the attribute "emptyMessage" is set.
true if the attribute is set.public void setEmptyMessage(String emptyMessage)
IEmptyMessageCapability
setEmptyMessage in interface IEmptyMessageCapabilityemptyMessage - the messagepublic boolean isReadOnly()
IReadOnlyCapability
isReadOnly in interface IReadOnlyCapabilitypublic boolean isReadOnly(FacesContext facesContext)
isReadOnly() for more details
public final boolean isReadOnlySetted()
true if the attribute "readOnly" is set.
true if the attribute is set.public void setReadOnly(boolean readOnly)
IReadOnlyCapability
setReadOnly in interface IReadOnlyCapabilityreadOnly - readOnly boolean propertypublic final void addValueChangeListener(ValueChangeListener listener)
IValueChangeEventCapability
addValueChangeListener in interface EditableValueHolderaddValueChangeListener in interface IValueChangeEventCapabilityaddValueChangeListener in class UIInputlistener - the valueChange listener to addpublic final void removeValueChangeListener(ValueChangeListener listener)
IValueChangeEventCapability
removeValueChangeListener in interface EditableValueHolderremoveValueChangeListener in interface IValueChangeEventCapabilityremoveValueChangeListener in class UIInputlistener - the valueChange listener to removepublic final FacesListener[] listValueChangeListeners()
IValueChangeEventCapability
listValueChangeListeners in interface IValueChangeEventCapabilitypublic IMenuComponent getMenu()
IMenuCapability
getMenu in interface IMenuCapabilitypublic IMenuComponent getMenu(String menuId)
IMenuCapability
getMenu in interface IMenuCapabilitymenuId - Id for a particular menu
public IMenuIterator listMenus()
IMenuCapability
listMenus in interface IMenuCapabilitypublic String getFocusStyleClass()
IFocusStyleClassCapability
getFocusStyleClass in interface IFocusStyleClassCapabilitypublic String getFocusStyleClass(FacesContext facesContext)
getFocusStyleClass() for more details
public final boolean isFocusStyleClassSetted()
true if the attribute "focusStyleClass" is set.
true if the attribute is set.public void setFocusStyleClass(String focusStyleClass)
IFocusStyleClassCapability
setFocusStyleClass in interface IFocusStyleClassCapabilityfocusStyleClass - style classpublic String getErrorStyleClass()
ISeverityStyleClassCapability
getErrorStyleClass in interface ISeverityStyleClassCapabilitypublic String getErrorStyleClass(FacesContext facesContext)
getErrorStyleClass() for more details
public final boolean isErrorStyleClassSetted()
true if the attribute "errorStyleClass" is set.
true if the attribute is set.public void setErrorStyleClass(String errorStyleClass)
ISeverityStyleClassCapability
setErrorStyleClass in interface ISeverityStyleClassCapabilityerrorStyleClass - list of CSS style classespublic String getFatalStyleClass()
ISeverityStyleClassCapability
getFatalStyleClass in interface ISeverityStyleClassCapabilitypublic String getFatalStyleClass(FacesContext facesContext)
getFatalStyleClass() for more details
public final boolean isFatalStyleClassSetted()
true if the attribute "fatalStyleClass" is set.
true if the attribute is set.public void setFatalStyleClass(String fatalStyleClass)
ISeverityStyleClassCapability
setFatalStyleClass in interface ISeverityStyleClassCapabilityfatalStyleClass - list of CSS style classespublic String getInfoStyleClass()
ISeverityStyleClassCapability
getInfoStyleClass in interface ISeverityStyleClassCapabilitypublic String getInfoStyleClass(FacesContext facesContext)
getInfoStyleClass() for more details
public final boolean isInfoStyleClassSetted()
true if the attribute "infoStyleClass" is set.
true if the attribute is set.public void setInfoStyleClass(String infoStyleClass)
ISeverityStyleClassCapability
setInfoStyleClass in interface ISeverityStyleClassCapabilityinfoStyleClass - list of CSS style classespublic String getWarnStyleClass()
ISeverityStyleClassCapability
getWarnStyleClass in interface ISeverityStyleClassCapabilitypublic String getWarnStyleClass(FacesContext facesContext)
getWarnStyleClass() for more details
public final boolean isWarnStyleClassSetted()
true if the attribute "warnStyleClass" is set.
true if the attribute is set.public void setWarnStyleClass(String warnStyleClass)
ISeverityStyleClassCapability
setWarnStyleClass in interface ISeverityStyleClassCapabilitywarnStyleClass - list of CSS style classespublic final void addSelectionListener(ISelectionListener listener)
ISelectionEventCapability
addSelectionListener in interface ISelectionEventCapabilitylistener - the selection listener to addpublic final void removeSelectionListener(ISelectionListener listener)
ISelectionEventCapability
removeSelectionListener in interface ISelectionEventCapabilitylistener - the selection listener to removepublic final FacesListener[] listSelectionListeners()
ISelectionEventCapability
listSelectionListeners in interface ISelectionEventCapabilitypublic String getAlternateText()
getAlternateText in interface IAlternateTextCapabilitypublic String getAlternateText(FacesContext facesContext)
getAlternateText() for more details
public final boolean isAlternateTextSetted()
true if the attribute "alternateText" is set.
true if the attribute is set.public void setAlternateText(String alternateText)
setAlternateText in interface IAlternateTextCapabilitypublic int getMaxTextLength()
IMaxTextLengthCapability
getMaxTextLength in interface IMaxTextLengthCapabilitypublic int getMaxTextLength(FacesContext facesContext)
getMaxTextLength() for more details
public final boolean isMaxTextLengthSetted()
true if the attribute "maxTextLength" is set.
true if the attribute is set.public void setMaxTextLength(int maxTextLength)
IMaxTextLengthCapability
setMaxTextLength in interface IMaxTextLengthCapabilitymaxTextLength - maximum number of characterspublic int getColumnNumber()
public int getColumnNumber(FacesContext facesContext)
public void setColumnNumber(int columnNumber)
columnNumber - width in characterspublic boolean isColumnNumberSetted()
true if the attribute "columnNumber" is set.
true if the attribute is set.public int getRowNumber()
public int getRowNumber(FacesContext facesContext)
public void setRowNumber(int rowNumber)
rowNumber - number of rowspublic boolean isRowNumberSetted()
true if the attribute "rowNumber" is set.
true if the attribute is set.public boolean isIgnoreWhenFull()
public boolean isIgnoreWhenFull(FacesContext facesContext)
public void setIgnoreWhenFull(boolean ignoreWhenFull)
public boolean isIgnoreWhenFullSetted()
true if the attribute "ignoreWhenFull" is set.
true if the attribute is set.protected Set getCameliaFields()
getCameliaFields in class AbstractInputComponentprotected String getCameliaValueAlias()
getCameliaValueAlias in class org.rcfaces.core.internal.component.CameliaInputComponent
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||