org.apache.myfaces.tobago.component

Class UITextarea

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

org.apache.myfaces.tobago.internal.component.AbstractUIInput

org.apache.myfaces.tobago.internal.component.AbstractUITextarea

org.apache.myfaces.tobago.component.UITextarea

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, SupportFieldId, SupportsAccessKey, SupportsLabelLayout, Visual

public class UITextarea
extends AbstractUITextarea
implements Visual

Renders a multi line text input control. UIComponent class, generated from template component.stg with class TextareaTagDeclaration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
UITextarea()

Method Summary

Modifier and Type	Method and Description
Character	getAccessKey() The access key of this control.
CustomClass	getCustomClass() Sets a CSS class in its parent, if the parent supports it.
String	getDefaultEventName()
Collection<String>	getEventNames()
String	getFamily()
String	getLabel() A localized user presentable label for this component.
LabelLayout	getLabelLayout() Defines the position of the label relative to the field.
Markup	getMarkup()
Integer	getRows() The row count for this component.
SanitizeMode	getSanitize() Should HTML content sanitized?
Style	getStyle() For internal use.
Integer	getTabIndex() Controls the navigation of the focus through the input controls on a page with the Tab-Key.
String	getTip() Text value to display as tooltip.
boolean	isDisabled() Flag indicating that this element is disabled.
boolean	isFocus() Flag indicating this component should receive the focus.
boolean	isReadonly() Flag indicating that this component will prohibit changes by the user.
void	setAccessKey(Character accessKey)
void	setCustomClass(CustomClass customClass)
void	setDisabled(boolean disabled)
void	setFocus(boolean focus)
void	setLabel(String label)
void	setLabelLayout(LabelLayout labelLayout)
void	setMarkup(Markup markup)
void	setReadonly(boolean readonly)
void	setRows(Integer rows)
void	setSanitize(SanitizeMode sanitize)
void	setStyle(Style style)
void	setTabIndex(Integer tabIndex)
void	setTip(String tip)

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUITextarea

getPlaceholder

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIInput

getFieldId, isLabelLayoutSkip

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.myfaces.tobago.component.Visual

getRendererType

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UITextarea

public UITextarea()

Method Detail

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface Visual

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface Visual

getLabelLayout

public LabelLayout getLabelLayout()

Defines the position of the label relative to the field. The default is flexLeft, if the label is set, or none, if the label isn't set.

Specified by:

getLabelLayout in interface SupportsLabelLayout

setLabelLayout

public void setLabelLayout(LabelLayout labelLayout)

Specified by:

setLabelLayout in interface SupportsLabelLayout

isFocus

public boolean isFocus()

Flag indicating this component should receive the focus.
Default: false

Specified by:

isFocus in class AbstractUIInput

setFocus

public void setFocus(boolean focus)

getTabIndex

public Integer getTabIndex()

Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.

Specified by:

getTabIndex in class AbstractUIInput

setTabIndex

public void setTabIndex(Integer tabIndex)

getLabel

public String getLabel()

A localized user presentable label for this component.

Specified by:

getLabel in interface SupportsAccessKey

setLabel

public void setLabel(String label)

getRows

public Integer getRows()

The row count for this component.

setRows

public void setRows(Integer rows)

isReadonly

public boolean isReadonly()

Flag indicating that this component will prohibit changes by the user.
Default: false

Specified by:

isReadonly in class AbstractUIInput

setReadonly

public void setReadonly(boolean readonly)

getAccessKey

public Character getAccessKey()

The access key of this control.

Specified by:

getAccessKey in interface SupportsAccessKey

setAccessKey

public void setAccessKey(Character accessKey)

getCustomClass

public CustomClass getCustomClass()

Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:

   <tc:in>
     <tc:style customClass="my-emphasized"/>
   </tc:in>
   

One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.

Specified by:

getCustomClass in interface Visual

setCustomClass

public void setCustomClass(CustomClass customClass)

Specified by:

setCustomClass in interface Visual

isDisabled

public boolean isDisabled()

Flag indicating that this element is disabled.
Default: false

Specified by:

isDisabled in class AbstractUIInput

setDisabled

public void setDisabled(boolean disabled)

getTip

public String getTip()

Text value to display as tooltip.

setTip

public void setTip(String tip)

getStyle

public Style getStyle()

For internal use. Used for rendering, if there is a child tag <tc:style>

Specified by:

getStyle in interface Visual

setStyle

public void setStyle(Style style)

Specified by:

setStyle in interface Visual

getSanitize

public SanitizeMode getSanitize()

Should HTML content sanitized? The effect of sanitizing depends on the configuration. The value "auto" means, that sanitizing take place for

• tc:out when escape="false" or
• tc:textarea when attribute data-html-editor is set,

because that are the critical parts.
Default: auto
Allowed Values: auto,never

setSanitize

public void setSanitize(SanitizeMode sanitize)