com.sap.ui.commons.client
Class LabelWidget

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

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 LabelWidget
extends com.sap.ui.core.client.ControlWidget

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

	LabelWidget() constructs the class LabelWidget
protected	LabelWidget(Label control) constructs the class LabelWidget
	LabelWidget(String id) constructs the class LabelWidget

Method Summary

Label	getControl() returns the reference to the Phoenix Control
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)
void	setDesign(LabelDesign value) Setter for property design Default value is: sap.ui.commons.LabelDesign.Standard
void	setIcon(String value) Setter for property icon
void	setLabelFor(com.sap.ui.core.client.Control labelFor) Association to the labeled control.
void	setLabelFor(String labelFor) Association to the labeled control.
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: sap.ui.core.TextAlign.Begin
void	setTextDirection(com.sap.ui.core.client.TextDirection value) Setter for property textDirection Default value is: sap.ui.core.TextDirection.Inherit
void	setVisible(boolean value) Setter for property visible Default value is: true
void	setWidth(String value) Setter for property width Default value is: ''
void	setWrapping(boolean value) Setter for property wrapping Default value is: false

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

LabelWidget

public LabelWidget()

constructs the class LabelWidget

LabelWidget

public LabelWidget(String id)

constructs the class LabelWidget

Parameters:

id - id of the LabelWidget

LabelWidget

protected LabelWidget(Label control)

constructs the class LabelWidget

Parameters:

control - reference to an existing Label

Method Detail

getControl

public Label getControl()

returns the reference to the Phoenix Control

Overrides:

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

Returns:

reference to the Phoenix Control

getDesign

public LabelDesign getDesign()

Getter for property design Labels can have bold format.

Returns:

the value of property design

setDesign

public void setDesign(LabelDesign value)

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

Parameters:

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

getTextDirection

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

isWrapping

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

Setter for property wrapping
Default value is: false

Parameters:

value - boolean

getWidth

public 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 void setWidth(String value)

Setter for property width
Default value is: ''

Overrides:

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

Parameters:

value - String

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

isVisible

public boolean isVisible()

Getter for property visible Invisible labels 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

getIcon

public String getIcon()

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

Returns:

the value of property icon

setIcon

public void setIcon(String value)

Setter for property icon

Parameters:

value - String

getTextAlign

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

getLabelFor

public String getLabelFor()

Association to the labeled control.

setLabelFor

public void setLabelFor(String labelFor)

Association to the labeled control.

Parameters:

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

setLabelFor

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