com.sap.ui.commons.client
Class TextView

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.TextView

public class TextView
extends com.sap.ui.core.client.Control

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

Is used to display some continous text. The control can inherit the text direction from its parent control.

• Properties
  • text : String
    Text to be displayed.
  • textDirection : com.sap.ui.core.client.TextDirection
    Available options are LTR and RTL. Alternatively, the control can inherit the text direction from its parent control.
  • visible : boolean
    Invisible text views are not rendered.
  • enabled : boolean
    When the control is disabled, it is greyed out and no longer focusable.
  • helpId : String
    Unique identifier used for help services.
  • accessibleRole : com.sap.ui.core.client.AccessibleRole
    The ARIA role for the control.
  • design : com.sap.ui.commons.client.TextViewDesign
    Defines the visual appearance of the control.
  • wrapping : boolean
    Disabled automatic wrapping of the text.
  • semanticColor : com.sap.ui.commons.client.TextViewColor
    Semantic color of the text View
  • textAlign : com.sap.ui.core.client.TextAlign
    Sets the horizontal alignment of the text.
  • width : String
    Width of the TextView
• Aggregations
• Associations
• Events

Version:

0.18.0-SNAPSHOT

Author:

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

Constructor Summary

protected

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

Method Summary

TextView	bindText(String path) Binder for property text.
TextView	bindText(String path, com.sap.ui.core.client.Formatter formatter) Binder for property text.
static TextView	create() creates a new instance of the class TextView
static TextView	create(String idOrConfig) creates a new instance of the class TextView
static TextView	create(String id, String config) creates a new instance of the class TextView
com.sap.ui.core.client.AccessibleRole	getAccessibleRole() Getter for property accessibleRole The ARIA role for the control.
TextViewDesign	getDesign() Getter for property design Defines the visual appearance of the control.
String	getHelpId() Getter for property helpId Unique identifier used for help services.
TextViewColor	getSemanticColor() Getter for property semanticColor Semantic color of the text View
String	getText() Getter for property text Text to be displayed.
com.sap.ui.core.client.TextAlign	getTextAlign() Getter for property textAlign Sets the horizontal alignment of the text.
com.sap.ui.core.client.TextDirection	getTextDirection() Getter for property textDirection Available options are LTR and RTL.
String	getWidth() Getter for property width Width of the TextView
boolean	isEnabled() Getter for property enabled When the control is disabled, it is greyed out and no longer focusable.
boolean	isVisible() Getter for property visible Invisible text views are not rendered.
boolean	isWrapping() Getter for property wrapping Disabled automatic wrapping of the text.
TextView	setAccessibleRole(com.sap.ui.core.client.AccessibleRole value) Setter for property accessibleRole Default value is: Document
TextView	setDesign(TextViewDesign value) Setter for property design Default value is: Standard
TextView	setEnabled(boolean value) Setter for property enabled Default value is: true
TextView	setHelpId(String value) Setter for property helpId Default value is: ''
TextView	setSemanticColor(TextViewColor value) Setter for property semanticColor Default value is: Default
TextView	setText(String value) Setter for property text Default value is: ''
TextView	setTextAlign(com.sap.ui.core.client.TextAlign value) Setter for property textAlign Default value is: Begin
TextView	setTextDirection(com.sap.ui.core.client.TextDirection value) Setter for property textDirection Default value is: Inherit
TextView	setVisible(boolean value) Setter for property visible Default value is: true
TextView	setWidth(String value) Setter for property width
TextView	setWrapping(boolean value) Setter for property wrapping Default value is: true
TextView	unbindText() Unbinder for property text.

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

TextView

protected TextView()

constructs the class TextView
hidden due to JavaScriptObject restriction

Method Detail

create

public static TextView create()

creates a new instance of the class TextView

create

public static TextView create(String idOrConfig)

creates a new instance of the class TextView

Parameters:

id - id of the TextView or configuration JSON string

create

public static TextView create(String id,
                              String config)

creates a new instance of the class TextView

Parameters:

id - id of the TextView

config - configuration JSON string

getText

public final String getText()

Getter for property text Text to be displayed.

Returns:

the value of property text

setText

public final TextView setText(String value)

Setter for property text
Default value is: ''

Parameters:

value - String

Returns:

this to allow method chaining

bindText

public final TextView bindText(String path)

Binder for property text.

Parameters:

path - path to a property in the model

Returns:

this to allow method chaining

bindText

public final TextView bindText(String path,
                               com.sap.ui.core.client.Formatter formatter)

Binder for property text.

Parameters:

path - path to a property in the model

formatter - an optional Formatter function for the value

Returns:

this to allow method chaining

unbindText

public final TextView unbindText()

Unbinder for property text.

Returns:

this to allow method chaining

getTextDirection

public final com.sap.ui.core.client.TextDirection getTextDirection()

Getter for property textDirection Available options are LTR and RTL. Alternatively, the control can inherit the text direction from its parent control.

Returns:

the value of property textDirection

setTextDirection

public final TextView setTextDirection(com.sap.ui.core.client.TextDirection value)

Setter for property textDirection
Default value is: Inherit

Parameters:

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

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Invisible text views are not rendered.

Returns:

the value of property visible

setVisible

public final TextView setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isEnabled

public final boolean isEnabled()

Getter for property enabled When the control is disabled, it is greyed out and no longer focusable.

Returns:

the value of property enabled

setEnabled

public final TextView setEnabled(boolean value)

Setter for property enabled
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getHelpId

public final String getHelpId()

Getter for property helpId Unique identifier used for help services.

Returns:

the value of property helpId

setHelpId

public final TextView setHelpId(String value)

Setter for property helpId
Default value is: ''

Parameters:

value - String

Returns:

this to allow method chaining

getAccessibleRole

public final com.sap.ui.core.client.AccessibleRole getAccessibleRole()

Getter for property accessibleRole The ARIA role for the control.

Returns:

the value of property accessibleRole

setAccessibleRole

public final TextView setAccessibleRole(com.sap.ui.core.client.AccessibleRole value)

Setter for property accessibleRole
Default value is: Document

Parameters:

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

Returns:

this to allow method chaining

getDesign

public final TextViewDesign getDesign()

Getter for property design Defines the visual appearance of the control.

Returns:

the value of property design

setDesign

public final TextView setDesign(TextViewDesign value)

Setter for property design
Default value is: Standard

Parameters:

value - com.sap.ui.commons.client.TextViewDesign

Returns:

this to allow method chaining

isWrapping

public final boolean isWrapping()

Getter for property wrapping Disabled automatic wrapping of the text.

Returns:

the value of property wrapping

setWrapping

public final TextView setWrapping(boolean value)

Setter for property wrapping
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getSemanticColor

public final TextViewColor getSemanticColor()

Getter for property semanticColor Semantic color of the text View

Returns:

the value of property semanticColor

setSemanticColor

public final TextView setSemanticColor(TextViewColor value)

Setter for property semanticColor
Default value is: Default

Parameters:

value - com.sap.ui.commons.client.TextViewColor

Returns:

this to allow method chaining

getTextAlign

public final com.sap.ui.core.client.TextAlign getTextAlign()

Getter for property textAlign Sets the horizontal alignment of the text.

Returns:

the value of property textAlign

setTextAlign

public final TextView setTextAlign(com.sap.ui.core.client.TextAlign value)

Setter for property textAlign
Default value is: Begin

Parameters:

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

Returns:

this to allow method chaining

getWidth

public final String getWidth()

Getter for property width Width of the TextView

Returns:

the value of property width

setWidth

public final TextView setWidth(String value)

Setter for property width

Parameters:

value - String

Returns:

this to allow method chaining