The inputText component creates a browser input text widget. Depending on the value of "rows", this component either maps to a single-row text field or a multi-row text area.It also supports displaying a label, text, and messages.

If the input should be hidden from the user while displayed, such as for passwords, the secret property should be set to "true".

If the input has readOnly=true, it will display like an outputText, i.e. no borders.

<section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g., panelStretchLayout, if the dimensionsFrom attribute is set to "auto" or "parent" and the simple attribute is true. </html:li> <html:li>This component does not stretch its children.</html:li> </html:ul> </section>

Events:

Type

Phases

Description

javax.faces.event.ValueChangeEvent

Process Validations
Apply Request Values

The valueChange event is delivered when the value attribute is changed.

org.apache.myfaces.trinidad.event.AttributeChangeEvent

Invoke Application
Apply Request Values

Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

isSimple()
Gets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives.

setSimple(boolean simple)
Sets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives.

void

setStyleClass(java.lang.String styleClass)
Sets a CSS style class to use for this component.

void

setUnsecure(java.util.Set<java.lang.String> unsecure)
Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.

void

setUsage(java.lang.String usage)
Sets The usage attribute will set the type of the input to allow for different html types (such as search).

RichInputText

getHelp

This facet is deprecated, helpTopicId should be used for providing help. This is a no-op for form components.

setHelp

public final void setHelp(javax.faces.component.UIComponent helpFacet)

This facet is deprecated, helpTopicId should be used for providing help. This is a no-op for form components.

getContext

public final javax.faces.component.UIComponent getContext()

Location for contextual information. A contextInfo component is expected.

setContext

public final void setContext(javax.faces.component.UIComponent contextFacet)

Location for contextual information. A contextInfo component is expected.

isChanged

public final boolean isChanged()

Gets an attribute which if set to true, the changed indicator icon will be displayed on the component. This value defaults to false.

Returns:

the new changed value

setChanged

public final void setChanged(boolean changed)

Sets an attribute which if set to true, the changed indicator icon will be displayed on the component. This value defaults to false.

Parameters:

changed - the new changed value

getChangedDesc

public final java.lang.String getChangedDesc()

Gets the text commonly used by user agents to display tooltip text on the changed indicator icon. Default value is "Changed". The behavior of the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips.

Returns:

the new changedDesc value

setChangedDesc

public final void setChangedDesc(java.lang.String changedDesc)

Sets the text commonly used by user agents to display tooltip text on the changed indicator icon. Default value is "Changed". The behavior of the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips.

Parameters:

changedDesc - the new changedDesc value

isAutoSubmit

public final boolean isAutoSubmit()

Gets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.). Since autoSubmit is a partial submit, also submitted and re-rendered are any other components with partialTriggers pointing to this component.

Returns:

the new autoSubmit value

setAutoSubmit

public final void setAutoSubmit(boolean autoSubmit)

Sets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.). Since autoSubmit is a partial submit, also submitted and re-rendered are any other components with partialTriggers pointing to this component.

Parameters:

autoSubmit - the new autoSubmit value

getAccessKey

public final char getAccessKey()

Gets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element). For accessibility reasons, this functionality is not supported in screen reader mode. If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.

Returns:

the new accessKey value

setAccessKey

public final void setAccessKey(char accessKey)

Sets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element). For accessibility reasons, this functionality is not supported in screen reader mode. If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.

Parameters:

accessKey - the new accessKey value

getContentStyle

public final java.lang.String getContentStyle()

Gets the style of the content piece of the component. You can style width by setting this attribute like this: width: 100px.

Returns:

the new contentStyle value

setContentStyle

public final void setContentStyle(java.lang.String contentStyle)

Sets the style of the content piece of the component. You can style width by setting this attribute like this: width: 100px.

Parameters:

contentStyle - the new contentStyle value

getHelpTopicId

public final java.lang.String getHelpTopicId()

Gets the id used to look up a topic in a helpProvider.

Returns:

the new helpTopicId value

setHelpTopicId

public final void setHelpTopicId(java.lang.String helpTopicId)

Sets the id used to look up a topic in a helpProvider.

Parameters:

helpTopicId - the new helpTopicId value

isDisabled

public final boolean isDisabled()

Gets whether the element is disabled. Unlike a readonly component, a disabled component is unable to receive focus. If the component has the potential to have a scrollbar, and you want the user to be able to scroll through the component's text or values, use the 'readOnly' attribute, not the 'disabled' attribute.

Returns:

the new disabled value

setDisabled

public final void setDisabled(boolean disabled)

Sets whether the element is disabled. Unlike a readonly component, a disabled component is unable to receive focus. If the component has the potential to have a scrollbar, and you want the user to be able to scroll through the component's text or values, use the 'readOnly' attribute, not the 'disabled' attribute.

Parameters:

disabled - the new disabled value

getLabel

public final java.lang.String getLabel()

Gets the label of the component. If you want the label to appear above the control, use a panelFormLayout.

Returns:

the new label value

setLabel

public final void setLabel(java.lang.String label)

Sets the label of the component. If you want the label to appear above the control, use a panelFormLayout.

Parameters:

label - the new label value

isReadOnly

public final boolean isReadOnly()

Gets whether the control is displayed as an editable field or as an output-style text control. Unlike a disabled component, a readonly component is able to receive focus.

Returns:

the new readOnly value

setReadOnly

public final void setReadOnly(boolean readOnly)

Sets whether the control is displayed as an editable field or as an output-style text control. Unlike a disabled component, a readonly component is able to receive focus.

Parameters:

readOnly - the new readOnly value

isShowRequired

public final boolean isShowRequired()

Gets whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. An example of when it can be desirable to use the showRequired property is if you have a field that is initially empty and is required only if some other field on the page is touched.

Returns:

the new showRequired value

setShowRequired

public final void setShowRequired(boolean showRequired)

Sets whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. An example of when it can be desirable to use the showRequired property is if you have a field that is initially empty and is required only if some other field on the page is touched.

Parameters:

showRequired - the new showRequired value

isSimple

public final boolean isSimple()

Gets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives. One of the usecases can be when the component is used in repeatable elements like in table, for-each etc., where label is not required.

Returns:

the new simple value

setSimple

public final void setSimple(boolean simple)

Sets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives. One of the usecases can be when the component is used in repeatable elements like in table, for-each etc., where label is not required.

Parameters:

simple - the new simple value

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final java.util.Set<java.lang.String> getUnsecure()

Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(java.util.Set<java.lang.String> unsecure)

Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.

Parameters:

unsecure - the new unsecure value

isVisible

public final boolean isVisible()

Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Parameters:

visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

Deprecated.This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)

Deprecated.This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

setClientListeners

getEditable

public final java.lang.String getEditable()

Gets the editable look and feel to use for input components. 'always' indicates that the input component should always look editable. 'onAccess' indicates that the input will only look editable when accessed (hover, focus). 'inherit' indicates that we want to use the component parent's setting. None of the ancestor components define 'always' or 'onAccess', then 'always' will be used.

Returns:

the new editable value

setEditable

public final void setEditable(java.lang.String editable)

Sets the editable look and feel to use for input components. 'always' indicates that the input component should always look editable. 'onAccess' indicates that the input will only look editable when accessed (hover, focus). 'inherit' indicates that we want to use the component parent's setting. None of the ancestor components define 'always' or 'onAccess', then 'always' will be used.

Parameters:

editable - the new editable value

getPlaceholder

public final java.lang.String getPlaceholder()

Gets Text to be displayed in the input component when a value is not present.

Returns:

the new placeholder value

setPlaceholder

public final void setPlaceholder(java.lang.String placeholder)

Sets Text to be displayed in the input component when a value is not present.

Parameters:

placeholder - the new placeholder value

isAutoTab

public final boolean isAutoTab()

Gets whether focus will automatically move to the next tabstop when the maximum length for the current component is reached. Currently, this feature is not supported for mobile Safari.

Returns:

the new autoTab value

setAutoTab

public final void setAutoTab(boolean autoTab)

Sets whether focus will automatically move to the next tabstop when the maximum length for the current component is reached. Currently, this feature is not supported for mobile Safari.

Parameters:

autoTab - the new autoTab value

getColumns

public final int getColumns()

Gets the size of the text control specified by the number of characters shown. The number of columns is estimated based on the default font size of the browser.

Returns:

the new columns value

setColumns

public final void setColumns(int columns)

Sets the size of the text control specified by the number of characters shown. The number of columns is estimated based on the default font size of the browser.

Parameters:

columns - the new columns value

getDimensionsFrom

public final java.lang.String getDimensionsFrom()

Gets

determines how the component will handle geometry management (when the simple attribute is true). This specifies where the dimensions of the inputText come from:

<html:ul> <html:li>auto - either "disclosedChild" or "parent", depending on the container the inputText is inside; if the inputText is being stretched by its ancestor then "parent" will be used, otherwise "content" will be used</html:li> <html:li>content (the default) - the inputText will get its dimensions from the parent component</html:li> <html:li>parent - the inputText will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin.</html:li> </html:ul>

Returns:

the new dimensionsFrom value

setDimensionsFrom

public final void setDimensionsFrom(java.lang.String dimensionsFrom)

Sets

determines how the component will handle geometry management (when the simple attribute is true). This specifies where the dimensions of the inputText come from:

<html:ul> <html:li>auto - either "disclosedChild" or "parent", depending on the container the inputText is inside; if the inputText is being stretched by its ancestor then "parent" will be used, otherwise "content" will be used</html:li> <html:li>content (the default) - the inputText will get its dimensions from the parent component</html:li> <html:li>parent - the inputText will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin.</html:li> </html:ul>

Parameters:

dimensionsFrom - the new dimensionsFrom value

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.

Parameters:

inlineStyle - the new inlineStyle value

getMaximumLength

public final int getMaximumLength()

Gets the maximum number of characters that can be entered into the text control. This includes the characters representing the new line. If set to 0 or less, the maximumLength is ignored.

Note that in some browsers like IE new line is treated as two characters.

Returns:

the new maximumLength value

setMaximumLength

public final void setMaximumLength(int maximumLength)

Sets the maximum number of characters that can be entered into the text control. This includes the characters representing the new line. If set to 0 or less, the maximumLength is ignored.

Note that in some browsers like IE new line is treated as two characters.

Parameters:

maximumLength - the new maximumLength value

getAutoComplete

public final java.lang.String getAutoComplete()

Gets whether previous values of text fields in the form should be remembered and offered for auto completion.

Returns:

the new autoComplete value

setAutoComplete

public final void setAutoComplete(java.lang.String autoComplete)

Sets whether previous values of text fields in the form should be remembered and offered for auto completion.

Parameters:

autoComplete - the new autoComplete value

getRows

public final int getRows()

Gets the height of the text control specified by the number of characters shown. The default value is 1, which generates a one-row input field. The number of rows is estimated based on the default font size of the browser.

Returns:

the new rows value

setRows

public final void setRows(int rows)

Sets the height of the text control specified by the number of characters shown. The default value is 1, which generates a one-row input field. The number of rows is estimated based on the default font size of the browser.

Parameters:

rows - the new rows value

isSecret

public final boolean isSecret()

Gets a boolean value that only applies to single line text controls. When set to "true", it hides the actual value of the text from the user, and will prevent the actual "value" from being shown to the user. When the user manually enters a value, each character will appear as an *. After the value is posted to the server, the value (if not null) will always appear (and be sent to the client) as "******", or whichever value is defined in UIConstants.SECRET_FIELD_DEFAULT_VALUE. If secret is set to true, be sure to not use a converter or validator tag with this inputText which would expose the value the user entered via its messages.

Returns:

the new secret value

setSecret

public final void setSecret(boolean secret)

Sets a boolean value that only applies to single line text controls. When set to "true", it hides the actual value of the text from the user, and will prevent the actual "value" from being shown to the user. When the user manually enters a value, each character will appear as an *. After the value is posted to the server, the value (if not null) will always appear (and be sent to the client) as "******", or whichever value is defined in UIConstants.SECRET_FIELD_DEFAULT_VALUE. If secret is set to true, be sure to not use a converter or validator tag with this inputText which would expose the value the user entered via its messages.

Parameters:

secret - the new secret value

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component. The styleClass attribute value is rendered on the root dom element. We provide some public style classes you can set the styleClass to that will affect only the 'content' piece of the component. These are: AFAddressFieldTextMarker, AFPostalCodeFieldTextMarker, AFPhoneFieldTextMarker, AFFieldNumberMarker, AFFieldTextLTRMarker, AFFieldTextMarker, AFFieldNumberMarker. In LTR languages, these styles have no effect by default, other than AFFieldNumberMarker which right aligns the text. They have more styling in RTL mode. If needed, you can skin the public style definitions for these marker style classes (e.g., AFAddressFieldText, AFPostalCodeFieldText, etc.) and it will be picked up by using these "Marker" style class because in our base skin implementation we map to the public style by doing this: af|inputText.AFFieldNumberMarker af|inputText::content {-tr-rule-ref:selector(".AFFieldNumber")}. We recommend that you do not add style properties to the "Marker" style classes, since they are used solely in the CSS descendant selector to point to the content pseudo-element.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component. The styleClass attribute value is rendered on the root dom element. We provide some public style classes you can set the styleClass to that will affect only the 'content' piece of the component. These are: AFAddressFieldTextMarker, AFPostalCodeFieldTextMarker, AFPhoneFieldTextMarker, AFFieldNumberMarker, AFFieldTextLTRMarker, AFFieldTextMarker, AFFieldNumberMarker. In LTR languages, these styles have no effect by default, other than AFFieldNumberMarker which right aligns the text. They have more styling in RTL mode. If needed, you can skin the public style definitions for these marker style classes (e.g., AFAddressFieldText, AFPostalCodeFieldText, etc.) and it will be picked up by using these "Marker" style class because in our base skin implementation we map to the public style by doing this: af|inputText.AFFieldNumberMarker af|inputText::content {-tr-rule-ref:selector(".AFFieldNumber")}. We recommend that you do not add style properties to the "Marker" style classes, since they are used solely in the CSS descendant selector to point to the content pseudo-element.

Parameters:

styleClass - the new styleClass value

getUsage

public final java.lang.String getUsage()

Gets The usage attribute will set the type of the input to allow for different html types (such as search). Currently only auto, text and search are valid. auto is the default. Currently, auto will default to text but may in the future conditionally default to some other type. This attribute is ignored for rows > 1.

Returns:

the new usage value

setUsage

public final void setUsage(java.lang.String usage)

Sets The usage attribute will set the type of the input to allow for different html types (such as search). Currently only auto, text and search are valid. auto is the default. Currently, auto will default to text but may in the future conditionally default to some other type. This attribute is ignored for rows > 1.

Parameters:

usage - the new usage value

getWrap

public final java.lang.String getWrap()

Gets the type of text wrapping to be used in a multi-row text control. This attribute is ignored for single row inputText. By default (or "soft"), multirow text wraps visually, but does not include carriage returns in the submitted value. Setting this to "off" will disable wrapping; the multirow text will scroll horizontally. Setting it to "hard" specifies that the value of the text should include any carriage returns needed to wrap the lines.

Returns:

the new wrap value

setWrap

public final void setWrap(java.lang.String wrap)

Sets the type of text wrapping to be used in a multi-row text control. This attribute is ignored for single row inputText. By default (or "soft"), multirow text wraps visually, but does not include carriage returns in the submitted value. Setting this to "off" will disable wrapping; the multirow text will scroll horizontally. Setting it to "hard" specifies that the value of the text should include any carriage returns needed to wrap the lines.