com.sap.tc.webdynpro.clientserver.uielib.standard.api

Interface IWDLabel

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDLabel

extends IWDUIElement

Web Dynpro Label API. Label is used to carry the labelling text for another UI element.

Data binding:
The labelFor property must contain the ID of another UI element in the view. The displayed text is given by the text property or is automatically derived from the labeled component.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Field Summary

static WDLabelDesign	DEFAULT_DESIGN Default value of the design property is WDLabelDesign.STANDARD.
static String	DEFAULT_LABEL_FOR Default value of the labelFor property is "".
static String	DEFAULT_TEXT Default value of the text property is "".
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of the textDirection property is WDTextDirection.INHERIT.
static String	DEFAULT_WIDTH Default value of the width property is "".
static boolean	DEFAULT_WRAPPING Default value of the wrapping property is false.

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindDesign(IWDAttributeInfo attributeInfo) Binds the design property to the context attribute specified by the given attribute info.
void	bindDesign(String path) Binds the design property to the context attribute specified by the given path.
String	bindingOfDesign() Returns the binding path of the design property.
String	bindingOfText() Returns the binding path of the text property.
String	bindingOfTextDirection() Returns the binding path of the textDirection property.
String	bindingOfWidth() Returns the binding path of the width property.
String	bindingOfWrapping() Returns the binding path of the wrapping property.
void	bindText(IWDAttributeInfo attributeInfo) Binds the text property to the context attribute specified by the given attribute info.
void	bindText(String path) Binds the text property to the context attribute specified by the given path.
void	bindTextDirection(IWDAttributeInfo attributeInfo) Binds the textDirection property to the context attribute specified by the given attribute info.
void	bindTextDirection(String path) Binds the textDirection property to the context attribute specified by the given path.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds the width property to the context attribute specified by the given attribute info.
void	bindWidth(String path) Binds the width property to the context attribute specified by the given path.
void	bindWrapping(IWDAttributeInfo attributeInfo) Binds the wrapping property to the context attribute specified by the given attribute info.
void	bindWrapping(String path) Binds the wrapping property to the context attribute specified by the given path.
WDLabelDesign	getDesign() Returns the value of the design property.
String	getLabelFor() Returns the value of the labelFor property.
String	getText() Returns the value of the text property.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
String	getWidth() Returns the value of the width property.
boolean	getWrapping() Returns the value of the wrapping property.
void	setDesign(WDLabelDesign value) Sets the design property to the given value.
void	setLabelFor(String labelFor) Sets the labelFor property to the given value.
void	setText(String value) Sets the text property to the given value.
void	setTextDirection(WDTextDirection value) Sets the textDirection property to the given value.
void	setWidth(String value) Sets the width property to the given value.
void	setWrapping(boolean value) Sets the wrapping property to the given value.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_DESIGN

public static final WDLabelDesign DEFAULT_DESIGN

Default value of the design property is WDLabelDesign.STANDARD.

DEFAULT_LABEL_FOR

public static final String DEFAULT_LABEL_FOR

Default value of the labelFor property is "".

See Also:

Constant Field Values

DEFAULT_TEXT

public static final String DEFAULT_TEXT

Default value of the text property is "".

See Also:

Constant Field Values

DEFAULT_TEXT_DIRECTION

public static final WDTextDirection DEFAULT_TEXT_DIRECTION

Default value of the textDirection property is WDTextDirection.INHERIT.

DEFAULT_WIDTH

public static final String DEFAULT_WIDTH

Default value of the width property is "".

See Also:

Constant Field Values

DEFAULT_WRAPPING

public static final boolean DEFAULT_WRAPPING

Default value of the wrapping property is false.

See Also:

Constant Field Values

Method Detail

bindDesign

public void bindDesign(String path)

Binds the design property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the design property will be bound

bindDesign

public void bindDesign(IWDAttributeInfo attributeInfo)

Binds the design property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the design property will be bound

bindingOfDesign

public String bindingOfDesign()

Returns the binding path of the design property.

Returns:

the path of the context attribute to which the design property is currently bound

getDesign

public WDLabelDesign getDesign()

Returns the value of the design property.

The initial value is WDLabelDesign.STANDARD.

Determines the design of the label.

Returns:

the current value of the design property

See Also:

setDesign(WDLabelDesign)

setDesign

public void setDesign(WDLabelDesign value)

Sets the design property to the given value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

getLabelFor

public String getLabelFor()

Returns the value of the labelFor property. The initial value is "". Determines the ID of the labelled component.

Returns:

the value of the labelFor property

See Also:

setLabelFor(String)

setLabelFor

public void setLabelFor(String labelFor)

Sets the labelFor property to the given value.

Parameters:

labelFor - the new value of the labelFor property

See Also:

getLabelFor()

bindText

public void bindText(String path)

Binds the text property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the text property will be bound

bindText

public void bindText(IWDAttributeInfo attributeInfo)

Binds the text property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the text property will be bound

bindingOfText

public String bindingOfText()

Returns the binding path of the text property.

Returns:

the path of the context attribute to which the text property is currently bound

getText

public String getText()

Returns the value of the text property.

The initial value is null.

Determines the label text. If not set the label retrieves its text from the labelled component.

Returns:

the current value of the text property

See Also:

setText(String)

setText

public void setText(String value)

Sets the text property to the given value.

Parameters:

value - the new value of the text property

See Also:

getText()

bindTextDirection

public void bindTextDirection(String path)

Binds the textDirection property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the textDirection property will be bound

bindTextDirection

public void bindTextDirection(IWDAttributeInfo attributeInfo)

Binds the textDirection property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the textDirection property will be bound

bindingOfTextDirection

public String bindingOfTextDirection()

Returns the binding path of the textDirection property.

Returns:

the path of the context attribute to which the textDirection property is currently bound

getTextDirection

public WDTextDirection getTextDirection()

Returns the value of the textDirection property.

The initial value is WDTextDirection.INHERIT.

Determines the direction of displayed text.

Returns:

the current value of the textDirection property

See Also:

setTextDirection(WDTextDirection)

setTextDirection

public void setTextDirection(WDTextDirection value)

Sets the textDirection property to the given value.

Parameters:

value - the new value of the textDirection property

See Also:

getTextDirection()

bindWidth

public void bindWidth(String path)

Binds the width property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the width property will be bound

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

Binds the width property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the width property will be bound

bindingOfWidth

public String bindingOfWidth()

Returns the binding path of the width property.

Returns:

the path of the context attribute to which the width property is currently bound

getWidth

public String getWidth()

Returns the value of the width property.

The initial value is "".

The width (CSS size) of the Label.

Returns:

the current value of the width property

See Also:

setWidth(String)

setWidth

public void setWidth(String value)

Sets the width property to the given value.

Parameters:

value - the new value of the width property

See Also:

getWidth()

bindWrapping

public void bindWrapping(String path)

Binds the wrapping property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the wrapping property will be bound

bindWrapping

public void bindWrapping(IWDAttributeInfo attributeInfo)

Binds the wrapping property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the wrapping property will be bound

bindingOfWrapping

public String bindingOfWrapping()

Returns the binding path of the wrapping property.

Returns:

the path of the context attribute to which the wrapping property is currently bound

getWrapping

public boolean getWrapping()

Returns the value of the wrapping property.

The initial value is false.

Determines if the label wraps its text.

Returns:

the current value of the wrapping property

See Also:

setWrapping(boolean)

setWrapping

public void setWrapping(boolean value)

Sets the wrapping property to the given value.

Parameters:

value - the new value of the wrapping property

See Also:

getWrapping()