com.sap.ui.commons.client
Class TextViewWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.TextViewWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class TextViewWidget
extends com.sap.ui.core.client.ControlWidget

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 AG)

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	TextViewWidget() constructs the class TextViewWidget
	TextViewWidget(String id) constructs the class TextViewWidget
protected	TextViewWidget(TextView control) constructs the class TextViewWidget

Method Summary

void	bindText(String path) Binder for property text.
void	bindText(String path, com.sap.ui.core.client.Formatter formatter) Binder for property text.
com.sap.ui.core.client.AccessibleRole	getAccessibleRole() Getter for property accessibleRole The ARIA role for the control.
TextView	getControl() returns the reference to the Phoenix 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.
void	setAccessibleRole(com.sap.ui.core.client.AccessibleRole value) Setter for property accessibleRole Default value is: Document
void	setDesign(TextViewDesign value) Setter for property design Default value is: Standard
void	setEnabled(boolean value) Setter for property enabled Default value is: true
void	setHelpId(String value) Setter for property helpId Default value is: ''
void	setSemanticColor(TextViewColor value) Setter for property semanticColor Default value is: Default
void	setText(String value) Setter for property text Default value is: ''
void	setTextAlign(com.sap.ui.core.client.TextAlign value) Setter for property textAlign Default value is: Begin
void	setTextDirection(com.sap.ui.core.client.TextDirection value) Setter for property textDirection Default value is: Inherit
void	setVisible(boolean value) Setter for property visible Default value is: true
void	setWidth(String value) Setter for property width
void	setWrapping(boolean value) Setter for property wrapping Default value is: true
void	unbindText() Unbinder for property text.

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

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

TextViewWidget

public TextViewWidget()

constructs the class TextViewWidget

TextViewWidget

public TextViewWidget(String id)

constructs the class TextViewWidget

Parameters:

id - id of the TextViewWidget

TextViewWidget

protected TextViewWidget(TextView control)

constructs the class TextViewWidget

Parameters:

control - reference to an existing TextView

Method Detail

getControl

public TextView getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

getText

public String getText()

Getter for property text Text to be displayed.

Returns:

the value of property text

setText

public void setText(String value)

Setter for property text
Default value is: ''

Parameters:

value - String

bindText

public final void bindText(String path)

Binder for property text.

Parameters:

path - path to a property in the model

bindText

public final void 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

unbindText

public final void unbindText()

Unbinder for property text.

getTextDirection

public 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 void setTextDirection(com.sap.ui.core.client.TextDirection value)

Setter for property textDirection
Default value is: Inherit

Parameters:

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

isVisible

public boolean isVisible()

Getter for property visible Invisible text views are not rendered.

Overrides:

isVisible in class com.google.gwt.user.client.ui.UIObject

Returns:

the value of property visible

setVisible

public void setVisible(boolean value)

Setter for property visible
Default value is: true

Overrides:

setVisible in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - boolean

isEnabled

public 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 void setEnabled(boolean value)

Setter for property enabled
Default value is: true

Parameters:

value - boolean

getHelpId

public String getHelpId()

Getter for property helpId Unique identifier used for help services.

Returns:

the value of property helpId

setHelpId

public void setHelpId(String value)

Setter for property helpId
Default value is: ''

Parameters:

value - String

getAccessibleRole

public 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 void setAccessibleRole(com.sap.ui.core.client.AccessibleRole value)

Setter for property accessibleRole
Default value is: Document

Parameters:

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

getDesign

public TextViewDesign getDesign()

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

Returns:

the value of property design

setDesign

public void setDesign(TextViewDesign value)

Setter for property design
Default value is: Standard

Parameters:

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

isWrapping

public boolean isWrapping()

Getter for property wrapping Disabled automatic wrapping of the text.

Returns:

the value of property wrapping

setWrapping

public void setWrapping(boolean value)

Setter for property wrapping
Default value is: true

Parameters:

value - boolean

getSemanticColor

public TextViewColor getSemanticColor()

Getter for property semanticColor Semantic color of the text View

Returns:

the value of property semanticColor

setSemanticColor

public void setSemanticColor(TextViewColor value)

Setter for property semanticColor
Default value is: Default

Parameters:

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

getTextAlign

public 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 void setTextAlign(com.sap.ui.core.client.TextAlign value)

Setter for property textAlign
Default value is: Begin

Parameters:

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

getWidth

public String getWidth()

Getter for property width Width of the TextView

Returns:

the value of property width

setWidth

public void setWidth(String value)

Setter for property width

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String