Klasse UITextarea

java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIOutput
Alle implementierten Schnittstellen:
jakarta.faces.component.behavior.ClientBehaviorHolder, jakarta.faces.component.EditableValueHolder, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.component.ValueHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, EventListener, SupportFieldId, SupportsAccessKey, SupportsAutocomplete, SupportsAutoSpacing, SupportsDecorationPosition, SupportsHelp, SupportsLabelLayout, Visual

@Generated("component.stg") public class UITextarea extends AbstractUITextarea
Renders a multi line text input control. UIComponent class, generated from template component.stg with class TextareaTagDeclaration.
  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    static final String
     
    static final String
     

    Von Klasse geerbte Felder jakarta.faces.component.UIInput

    ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

    Von Klasse geerbte Felder jakarta.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
     
  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    The access key of this control.
     
    Automatically add spacing (margins/paddings) to the component for better positioning.
    Sets a CSS class in its parent, if the parent supports it.
     
     
     
    Text value to display as a help.
    Defines the position and the appearance of a help message on a component.
    A localized user presentable label for this component.
    Defines the position of the label relative to the field.
     
    Defines the position and the appearance of additional faces messages (like error message or help message) on a component.
    Displays a short text in the input field, that describes the meaning of this field.
    The row count for this component.
    Should HTML content sanitized?
    Controls the navigation of the focus through the input controls on a page with the Tab-Key.
    Text value to display as tooltip.
    boolean
    Flag indicating that this element is disabled.
    boolean
    Flag indicating this component should receive the focus.
    boolean
    Flag indicating that this component will prohibit changes by the user.
    void
    restoreState(jakarta.faces.context.FacesContext context, Object state)
     
    void
     
    void
    setAutocomplete(Object autocomplete)
     
    void
    setAutoSpacing(Boolean autoSpacing)
     
    void
     
    void
    setDisabled(boolean disabled)
     
    void
    setFocus(boolean focus)
     
    void
     
    void
     
    void
     
    void
     
    void
    setMarkup(Markup markup)
     
    void
     
    void
    setPlaceholder(String placeholder)
     
    void
    setReadonly(boolean readonly)
     
    void
     
    void
     
    void
    setTabIndex(Integer tabIndex)
     
    void
     

    Von Klasse geerbte Methoden org.apache.myfaces.tobago.internal.component.AbstractUIInput

    getFieldId, isError, isNextToRenderIsLabel, setNextToRenderIsLabel

    Von Klasse geerbte Methoden jakarta.faces.component.UIInput

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

    Von Klasse geerbte Methoden jakarta.faces.component.UIOutput

    getConverter, getLocalValue, setConverter

    Von Klasse geerbte Methoden jakarta.faces.component.UIComponentBase

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

    Von Klasse geerbte Methoden jakarta.faces.component.UIComponent

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

    Von Klasse geerbte Methoden java.lang.Object

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

    Von Schnittstelle geerbte Methoden jakarta.faces.component.behavior.ClientBehaviorHolder

    addClientBehavior, getClientBehaviors

    Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.SupportsAutocomplete

    getAutocompleteString

    Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.SupportsAutoSpacing

    getAutoSpacing

    Von Schnittstelle geerbte Methoden jakarta.faces.component.ValueHolder

    getConverter, getLocalValue, setConverter

    Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.Visual

    getRendererType, isPlain
  • Felddetails

    • COMPONENT_TYPE

      public static final String COMPONENT_TYPE
    • COMPONENT_FAMILY

      public static final String COMPONENT_FAMILY
      Siehe auch:
  • Konstruktordetails

    • UITextarea

      public UITextarea()
  • Methodendetails

    • getEventNames

      public Collection<String> getEventNames()
      Angegeben von:
      getEventNames in Schnittstelle jakarta.faces.component.behavior.ClientBehaviorHolder
      Setzt außer Kraft:
      getEventNames in Klasse jakarta.faces.component.UIComponentBase
    • getDefaultEventName

      public String getDefaultEventName()
      Angegeben von:
      getDefaultEventName in Schnittstelle jakarta.faces.component.behavior.ClientBehaviorHolder
      Setzt außer Kraft:
      getDefaultEventName in Klasse jakarta.faces.component.UIComponentBase
    • getFamily

      public String getFamily()
      Setzt außer Kraft:
      getFamily in Klasse jakarta.faces.component.UIInput
    • 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. Set to 'skip' to avoid surrounding label container. Hint for tc:out: set also compact=true to render only text (without html tags).
    • setLabelLayout

      public void setLabelLayout(LabelLayout labelLayout)
    • isFocus

      public boolean isFocus()
      Flag indicating this component should receive the focus.
      Default: false
      Angegeben von:
      isFocus in Klasse 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.
      Angegeben von:
      getTabIndex in Klasse AbstractUIInput
    • setTabIndex

      public void setTabIndex(Integer tabIndex)
    • isReadonly

      public boolean isReadonly()
      Flag indicating that this component will prohibit changes by the user.
      Default: false
      Angegeben von:
      isReadonly in Klasse AbstractUIInput
    • setReadonly

      public void setReadonly(boolean readonly)
    • isDisabled

      public boolean isDisabled()
      Flag indicating that this element is disabled.
      Default: false
      Angegeben von:
      isDisabled in Klasse AbstractUIInput
    • setDisabled

      public void setDisabled(boolean disabled)
    • getTip

      public String getTip()
      Text value to display as tooltip.
    • setTip

      public void setTip(String tip)
    • getPlaceholder

      public String getPlaceholder()

      Displays a short text in the input field, that describes the meaning of this field.

      Angegeben von:
      getPlaceholder in Klasse AbstractUITextarea
    • setPlaceholder

      public void setPlaceholder(String placeholder)
    • getMarkup

      public Markup getMarkup()
    • setMarkup

      public void setMarkup(Markup markup)
    • getAutocomplete

      public Object getAutocomplete()
    • setAutocomplete

      public void setAutocomplete(Object autocomplete)
    • getMessagePosition

      public DecorationPosition getMessagePosition()
      Defines the position and the appearance of additional faces messages (like error message or help message) on a component. The default is popoverRight.
    • setMessagePosition

      public void setMessagePosition(DecorationPosition messagePosition)
    • getLabel

      public String getLabel()
      A localized user presentable label for this component.
    • setLabel

      public void setLabel(String label)
    • getRows

      public Integer getRows()
      The row count for this component.
      Angegeben von:
      getRows in Klasse AbstractUITextarea
    • setRows

      public void setRows(Integer rows)
    • getHelp

      public String getHelp()
      Text value to display as a help.
    • setHelp

      public void setHelp(String help)
    • getAutoSpacing

      public Boolean getAutoSpacing()
      Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet
    • setAutoSpacing

      public void setAutoSpacing(Boolean autoSpacing)
    • getHelpPosition

      public DecorationPosition getHelpPosition()
      Defines the position and the appearance of a help message on a component. The default is popoverRight.
    • setHelpPosition

      public void setHelpPosition(DecorationPosition helpPosition)
    • getAccessKey

      public Character getAccessKey()
      The access key of this control.
    • 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.
    • setCustomClass

      public void setCustomClass(CustomClass customClass)
    • 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
      Angegeben von:
      getSanitize in Klasse AbstractUITextarea
    • setSanitize

      public void setSanitize(SanitizeMode sanitize)
    • restoreState

      public void restoreState(jakarta.faces.context.FacesContext context, Object state)
      Angegeben von:
      restoreState in Schnittstelle jakarta.faces.component.StateHolder
      Setzt außer Kraft:
      restoreState in Klasse jakarta.faces.component.UIInput