com.sap.ui.commons.client
Class TextArea

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.TextField
                  com.sap.ui.commons.client.TextArea

All Implemented Interfaces:

ToolbarItem

public class TextArea
extends TextField

The class TextArea is the GWT wrapper for the Phoenix control: sap.ui.commons.TextArea.

Control to enter or display multible row text.

• Properties
  • height : String
    Height of text field. When it is set (CSS-size such as % or px), this is the exact size.
  • cols : int
    Number of Columns. Cols means number of characters per row. This proprty is only used if Width is not used.
  • rows : int
    Number of Rows. This proprty is only used if Height is not used.
  • wrapping : com.sap.ui.core.client.Wrapping
    Text wrapping. Possible values are: Soft, Hard, Off.
  • cursorPos : int
    Position of cursor, e.g., to let the user re-start typing at the same position as before the server roundtrip
  • explanation : String
    text which appears, in case quick-help is switched on
  • labeledBy : String
    ID of label control
• Aggregations
• Associations
• Events

For further parameters see {@link com.sap.ui.commons.client.TextField

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.TextArea)

Constructor Summary

protected

TextArea() constructs the class TextArea hidden due to JavaScriptObject restriction

Method Summary

static TextArea	create() creates a new instance of the class TextArea
static TextArea	create(String idOrConfig) creates a new instance of the class TextArea
static TextArea	create(String id, String config) creates a new instance of the class TextArea
int	getCols() Getter for property cols Number of Columns.
int	getCursorPos() Getter for property cursorPos Position of cursor, e.g., to let the user re-start typing at the same position as before the server roundtrip
String	getExplanation() Getter for property explanation text which appears, in case quick-help is switched on
String	getHeight() Getter for property height Height of text field.
String	getLabeledBy() Getter for property labeledBy ID of label control
int	getRows() Getter for property rows Number of Rows.
com.sap.ui.core.client.Wrapping	getWrapping() Getter for property wrapping Text wrapping.
TextArea	setCols(int value) Setter for property cols
TextArea	setCursorPos(int value) Setter for property cursorPos
TextArea	setExplanation(String value) Setter for property explanation
TextArea	setHeight(String value) Setter for property height
TextArea	setLabeledBy(String value) Setter for property labeledBy
TextArea	setRows(int value) Setter for property rows
TextArea	setWrapping(com.sap.ui.core.client.Wrapping value) Setter for property wrapping

Methods inherited from class com.sap.ui.commons.client.TextField

attachChangeEvent, bindValue, bindValue, detachChangeEvent, focus, getAccessibleDescription, getAccessibleName, getAccessibleRole, getDesign, getHelpId, getImeMode, getMaxLength, getTextAlign, getTextDirection, getValue, getValueState, getWidth, isEditable, isEnabled, isRequired, isVisible, setAccessibleDescription, setAccessibleName, setAccessibleRole, setDesign, setEditable, setEnabled, setHelpId, setImeMode, setMaxLength, setRequired, setTextAlign, setTextDirection, setValue, setValueState, setVisible, setWidth, unbindValue

Methods inherited from class com.sap.ui.core.client.Control

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TextArea

protected TextArea()

constructs the class TextArea
hidden due to JavaScriptObject restriction

Method Detail

create

public static TextArea create()

creates a new instance of the class TextArea

create

public static TextArea create(String idOrConfig)

creates a new instance of the class TextArea

Parameters:

id - id of the TextArea or configuration JSON string

create

public static TextArea create(String id,
                              String config)

creates a new instance of the class TextArea

Parameters:

id - id of the TextArea

config - configuration JSON string

getHeight

public final String getHeight()

Getter for property height Height of text field. When it is set (CSS-size such as % or px), this is the exact size.

Returns:

the value of property height

setHeight

public final TextArea setHeight(String value)

Setter for property height

Parameters:

value - String

Returns:

this to allow method chaining

getCols

public final int getCols()

Getter for property cols Number of Columns. Cols means number of characters per row. This proprty is only used if Width is not used.

Returns:

the value of property cols

setCols

public final TextArea setCols(int value)

Setter for property cols

Parameters:

value - int

Returns:

this to allow method chaining

getRows

public final int getRows()

Getter for property rows Number of Rows. This proprty is only used if Height is not used.

Returns:

the value of property rows

setRows

public final TextArea setRows(int value)

Setter for property rows

Parameters:

value - int

Returns:

this to allow method chaining

getWrapping

public final com.sap.ui.core.client.Wrapping getWrapping()

Getter for property wrapping Text wrapping. Possible values are: Soft, Hard, Off.

Returns:

the value of property wrapping

setWrapping

public final TextArea setWrapping(com.sap.ui.core.client.Wrapping value)

Setter for property wrapping

Parameters:

value - com.sap.ui.core.client.Wrapping

Returns:

this to allow method chaining

getCursorPos

public final int getCursorPos()

Getter for property cursorPos Position of cursor, e.g., to let the user re-start typing at the same position as before the server roundtrip

Returns:

the value of property cursorPos

setCursorPos

public final TextArea setCursorPos(int value)

Setter for property cursorPos

Parameters:

value - int

Returns:

this to allow method chaining

getExplanation

public final String getExplanation()

Getter for property explanation text which appears, in case quick-help is switched on

Returns:

the value of property explanation

setExplanation

public final TextArea setExplanation(String value)

Setter for property explanation

Parameters:

value - String

Returns:

this to allow method chaining

getLabeledBy

public final String getLabeledBy()

Getter for property labeledBy ID of label control

Returns:

the value of property labeledBy

setLabeledBy

public final TextArea setLabeledBy(String value)

Setter for property labeledBy

Parameters:

value - String

Returns:

this to allow method chaining