Control to enter or display multible row text.
Deprecated API:Since version 1.38. Instead, use the sap.m.TextArea control.
Method Summary
sap.ui.commons.TextArea.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.TextArea with name sClassName and enriches it with the information contained in oClassInfo. getCols()Gets current value of property cols. getHeight()Gets current value of property height. getRows()Gets current value of property rows. setCols(iCols)Sets a new value for property cols. setCursorPos(iCursorPos)Property setter for the cursor position setExplanation(sExplanation)Sets a new value for property explanation. setHeight(sHeight)Sets a new value for property height. setRows(iRows)Sets a new value for property rows. setWrapping(sWrapping)Sets a new value for property wrapping. setLabeledBy(sLabeledBy)Sets a new value for property labeledBy. _checkChange,
addAriaDescribedBy,
addAriaLabelledBy,
attachChange,
attachLiveChange,
bindValue,
detachChange,
detachLiveChange,
fireChange,
fireLiveChange,
getAccessibilityInfo,
getAccessibleRole,
getAriaDescribedBy,
getAriaLabelledBy,
getDesign,
getEditable,
getEnabled,
getFocusInfo,
getHelpId,
getImeMode,
getInputDomRef,
getLiveValue,
getMaxLength,
getName,
getPlaceholder,
getRequired,
getTextAlign,
getTextDirection,
getValue,
getValueState,
getWidth,
onsapfocusleave,
onselectstart,
removeAllAriaDescribedBy,
removeAllAriaLabelledBy,
removeAriaDescribedBy,
removeAriaLabelledBy,
setAccessibleRole,
setDesign,
setEditable,
setEnabled,
setHelpId,
setImeMode,
setName,
setPlaceholder,
setRequired,
setTextAlign,
setTextDirection,
setValue,
setValueState,
setWidth,
unbindValue addStyleClass,
allowTextSelection,
attachBrowserEvent,
attachValidateFieldGroup,
checkFieldGroupIds,
clone,
detachBrowserEvent,
detachValidateFieldGroup,
fireValidateFieldGroup,
getBusy,
getBusyIndicatorDelay,
getControlsByFieldGroupId,
getFieldGroupIds,
getIdForLabel,
getRenderer,
getVisible,
hasStyleClass,
invalidate,
isBusy,
placeAt,
removeStyleClass,
rerender,
setBusy,
setBusyIndicatorDelay,
setFieldGroupIds,
setVisible,
toggleStyleClass,
triggerValidateFieldGroup $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
data,
destroy,
destroyCustomData,
destroyDependents,
destroyLayoutData,
destroyTooltip,
enhanceAccessibilityState,
findElements,
fireEvent,
focus,
getCustomData,
getDependents,
getDomRef,
getElementBinding,
getFocusDomRef,
getInterface,
getLayoutData,
getMetadata,
getTooltip,
getTooltip_AsString,
getTooltip_Text,
indexOfCustomData,
indexOfDependent,
init,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
setLayoutData,
setTooltip,
toString,
unbindElement addAggregation,
addAssociation,
applySettings,
attachFormatError,
attachModelContextChange,
attachParseError,
attachValidationError,
attachValidationSuccess,
bindAggregation,
bindContext,
bindObject,
bindProperty,
destroyAggregation,
detachFormatError,
detachModelContextChange,
detachParseError,
detachValidationError,
detachValidationSuccess,
findAggregatedObjects,
fireFormatError,
fireModelContextChange,
fireParseError,
fireValidationError,
fireValidationSuccess,
getAggregation,
getAssociation,
getBinding,
getBindingContext,
getBindingInfo,
getBindingPath,
getEventingParent,
getId,
getModel,
getObjectBinding,
getOriginInfo,
getParent,
getProperty,
hasModel,
indexOfAggregation,
insertAggregation,
isBound,
isInvalidateSuppressed,
isTreeBinding,
propagateMessages,
removeAggregation,
removeAllAggregation,
removeAllAssociation,
removeAssociation,
setAggregation,
setAssociation,
setBindingContext,
setModel,
setProperty,
unbindAggregation,
unbindContext,
unbindObject,
unbindProperty,
validateAggregation,
validateProperty Constructor Detail
new sap.ui.commons.TextArea(sId?, mSettings?)
Constructor for a new TextArea.
Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.
The supported settings are:
In addition, all settings applicable to the base type sap.ui.commons.TextField can be used as well.
Parameters:
| {string} | sId? | id for the new control, generated automatically if no id is given |
| {object} | mSettings? | initial settings for the new control |
- Deprecated:
- Since version 1.38. Instead, use the
sap.m.TextArea control.
Method Detail
sap.ui.commons.TextArea.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.TextArea with name
sClassName and enriches it with the information contained in
oClassInfo.
oClassInfo might contain the same kind of information as described in sap.ui.commons.TextField.extend.
Parameters:
| {string} | sClassName | Name of the class being created |
| {object} | oClassInfo? | Object literal with information about the class |
| {function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
Returns:
| {function} | Created class / constructor function |
Returns a metadata object for class sap.ui.commons.TextArea.
Returns:
getCols(): int
Gets current value of property
cols.
Number of Columns. Cols means number of characters per row. This proprty is only used if Width is not used.
Returns:
| {int} | Value of property cols |
getCursorPos(): int
Gets current value of property
cursorPos.
Position of cursor, e.g., to let the user re-start typing at the same position as before the server roundtrip
Returns:
| {int} | Value of property cursorPos |
getExplanation(): string
Gets current value of property
explanation.
text which appears, in case quick-help is switched on
Returns:
| {string} | Value of property explanation |
Gets current value of property
height.
Height of text field. When it is set (CSS-size such as % or px), this is the exact size.
Returns:
getRows(): int
Gets current value of property
rows.
Number of Rows. This proprty is only used if Height is not used.
Returns:
| {int} | Value of property rows |
Gets current value of property
wrapping.
Text wrapping. Possible values are: Soft, Hard, Off.
Returns:
Sets a new value for property
cols.
Number of Columns. Cols means number of characters per row. This proprty is only used if Width is not used.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {int} | iCols | New value for property cols |
Returns:
Property setter for the cursor position
Parameters:
| {int} | iCursorPos | cursor position |
Returns:
Sets a new value for property
explanation.
text which appears, in case quick-help is switched on
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sExplanation | New value for property explanation |
Returns:
Sets a new value for property
height.
Height of text field. When it is set (CSS-size such as % or px), this is the exact size.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
Returns:
Property setter for MaxLength
Parameters:
| {int} | iMaxLength | maximal length of text |
Returns:
Sets a new value for property
rows.
Number of Rows. This proprty is only used if Height is not used.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {int} | iRows | New value for property rows |
Returns:
Sets a new value for property
wrapping.
Text wrapping. Possible values are: Soft, Hard, Off.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
Returns:
getLabeledBy(): string
Gets current value of property
labeledBy.
ID of label control
- Deprecated:
- Since version 1.5.2. Please use association AriaLabelledBy instead.
Returns:
| {string} | Value of property labeledBy |
Sets a new value for property
labeledBy.
ID of label control
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sLabeledBy | New value for property labeledBy |
- Deprecated:
- Since version 1.5.2. Please use association AriaLabelledBy instead.
Returns: