com.sap.ui.commons.client
Class Label

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

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

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

Is used for labeling other controls. The API provides formatting options, for example for bold display or alignment. A label can have an icon.

• Properties
  • design : com.sap.ui.commons.client.LabelDesign
    Labels can have bold format.
  • textDirection : com.sap.ui.core.client.TextDirection
    Options for the text direction are RTL and LTR. Alternatively, the control can inherit the text direction from its parent container.
  • wrapping : boolean
    Specifies whether a line wrapping shall be displayed when the text value is longer than the width (feature support in preparation)
  • width : String
    Control width as common CSS-size (px or % as unit, for example).
  • text : String
    Text to be displayed.
  • visible : boolean
    Invisible labels are not rendered.
  • icon : String
    Icon to be displayed in the control.
  • textAlign : com.sap.ui.core.client.TextAlign
    Available alignment settings are "Begin", "Center", "End", "Left", and "Right".
• Aggregations
• Associations
  • labelFor : com.sap.ui.core.client.Control
    Association to the labeled control.
• Events

Version:

0.18.0-SNAPSHOT

Author:

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

Constructor Summary

protected

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

Method Summary

static Label	create() creates a new instance of the class Label
static Label	create(String idOrConfig) creates a new instance of the class Label
static Label	create(String id, String config) creates a new instance of the class Label
LabelDesign	getDesign() Getter for property design Labels can have bold format.
String	getIcon() Getter for property icon Icon to be displayed in the control.
String	getLabelFor() Association to the labeled control.
String	getText() Getter for property text Text to be displayed.
com.sap.ui.core.client.TextAlign	getTextAlign() Getter for property textAlign Available alignment settings are "Begin", "Center", "End", "Left", and "Right".
com.sap.ui.core.client.TextDirection	getTextDirection() Getter for property textDirection Options for the text direction are RTL and LTR.
String	getWidth() Getter for property width Control width as common CSS-size (px or % as unit, for example).
boolean	isVisible() Getter for property visible Invisible labels are not rendered.
boolean	isWrapping() Getter for property wrapping Specifies whether a line wrapping shall be displayed when the text value is longer than the width (feature support in preparation)
Label	setDesign(LabelDesign value) Setter for property design Default value is: sap.ui.commons.LabelDesign.Standard
Label	setIcon(String value) Setter for property icon
Label	setLabelFor(com.sap.ui.core.client.Control labelFor) Association to the labeled control.
Label	setLabelFor(String labelFor) Association to the labeled control.
Label	setText(String value) Setter for property text Default value is: ''
Label	setTextAlign(com.sap.ui.core.client.TextAlign value) Setter for property textAlign Default value is: sap.ui.core.TextAlign.Begin
Label	setTextDirection(com.sap.ui.core.client.TextDirection value) Setter for property textDirection Default value is: sap.ui.core.TextDirection.Inherit
Label	setVisible(boolean value) Setter for property visible Default value is: true
Label	setWidth(String value) Setter for property width Default value is: ''
Label	setWrapping(boolean value) Setter for property wrapping Default value is: false

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

Label

protected Label()

constructs the class Label
hidden due to JavaScriptObject restriction

Method Detail

create

public static Label create()

creates a new instance of the class Label

create

public static Label create(String idOrConfig)

creates a new instance of the class Label

Parameters:

id - id of the Label or configuration JSON string

create

public static Label create(String id,
                           String config)

creates a new instance of the class Label

Parameters:

id - id of the Label

config - configuration JSON string

getDesign

public final LabelDesign getDesign()

Getter for property design Labels can have bold format.

Returns:

the value of property design

setDesign

public final Label setDesign(LabelDesign value)

Setter for property design
Default value is: sap.ui.commons.LabelDesign.Standard

Parameters:

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

Returns:

this to allow method chaining

getTextDirection

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

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

Returns:

the value of property textDirection

setTextDirection

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

Setter for property textDirection
Default value is: sap.ui.core.TextDirection.Inherit

Parameters:

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

Returns:

this to allow method chaining

isWrapping

public final boolean isWrapping()

Getter for property wrapping Specifies whether a line wrapping shall be displayed when the text value is longer than the width (feature support in preparation)

Returns:

the value of property wrapping

setWrapping

public final Label setWrapping(boolean value)

Setter for property wrapping
Default value is: false

Parameters:

value - boolean

Returns:

this to allow method chaining

getWidth

public final String getWidth()

Getter for property width Control width as common CSS-size (px or % as unit, for example).

Returns:

the value of property width

setWidth

public final Label setWidth(String value)

Setter for property width
Default value is: ''

Parameters:

value - String

Returns:

this to allow method chaining

getText

public final String getText()

Getter for property text Text to be displayed.

Returns:

the value of property text

setText

public final Label setText(String value)

Setter for property text
Default value is: ''

Parameters:

value - String

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Invisible labels are not rendered.

Returns:

the value of property visible

setVisible

public final Label setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getIcon

public final String getIcon()

Getter for property icon Icon to be displayed in the control.

Returns:

the value of property icon

setIcon

public final Label setIcon(String value)

Setter for property icon

Parameters:

value - String

Returns:

this to allow method chaining

getTextAlign

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

Getter for property textAlign Available alignment settings are "Begin", "Center", "End", "Left", and "Right".

Returns:

the value of property textAlign

setTextAlign

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

Setter for property textAlign
Default value is: sap.ui.core.TextAlign.Begin

Parameters:

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

Returns:

this to allow method chaining

getLabelFor

public final String getLabelFor()

Association to the labeled control.

setLabelFor

public final Label setLabelFor(String labelFor)

Association to the labeled control.

Parameters:

labelFor - id of the associated com.sap.ui.core.client.Control or null

Returns:

this to allow method chaining

setLabelFor

public final Label setLabelFor(com.sap.ui.core.client.Control labelFor)

Association to the labeled control.

Parameters:

labelFor - An associated com.sap.ui.core.client.Control or null

Returns:

this to allow method chaining