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!

Field Summary

static WDLabelDesign	DEFAULT_DESIGN Default value of property design.
static java.lang.String	DEFAULT_LABEL_FOR Default value of property labelFor.
static java.lang.String	DEFAULT_TEXT Default value of property text.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of property textDirection.
static java.lang.String	DEFAULT_WIDTH Default value of property width.
static boolean	DEFAULT_WRAPPING Default value of property wrapping.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

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

getId, getView, requestFocus

Field Detail

DEFAULT_DESIGN

public static final WDLabelDesign DEFAULT_DESIGN

Default value of property design.

DEFAULT_LABEL_FOR

public static final java.lang.String DEFAULT_LABEL_FOR

Default value of property labelFor.

DEFAULT_TEXT

public static final java.lang.String DEFAULT_TEXT

Default value of property text.

DEFAULT_TEXT_DIRECTION

public static final WDTextDirection DEFAULT_TEXT_DIRECTION

Default value of property textDirection.

DEFAULT_WIDTH

public static final java.lang.String DEFAULT_WIDTH

Default value of property width.

DEFAULT_WRAPPING

public static final boolean DEFAULT_WRAPPING

Default value of property wrapping.

Method Detail

bindDesign

public void bindDesign(java.lang.String path)

Binds property design to the context attribute specified by path.

Parameters:

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

bindDesign

public void bindDesign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDesign

public java.lang.String bindingOfDesign()

Binding path of property design.

Returns:

the path of the context attribute to which the design 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 property design to the new value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

getLabelFor

public java.lang.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(java.lang.String labelFor)

Sets property labelFor to the given value.

Parameters:

labelFor - the new labelFor value

See Also:

getLabelFor()

bindText

public void bindText(java.lang.String path)

Binds property text to the context attribute specified by path.

Parameters:

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

bindText

public void bindText(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfText

public java.lang.String bindingOfText()

Binding path of property text.

Returns:

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

getText

public java.lang.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(java.lang.String value)

Sets property text to the new value.

Parameters:

value - the new value of the text property

See Also:

getText()

bindTextDirection

public void bindTextDirection(java.lang.String path)

Binds property textDirection to the context attribute specified by path.

Parameters:

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

bindTextDirection

public void bindTextDirection(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTextDirection

public java.lang.String bindingOfTextDirection()

Binding path of property textDirection.

Returns:

the path of the context attribute to which the textDirection 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 property textDirection to the new value.

Parameters:

value - the new value of the textDirection property

See Also:

getTextDirection()

bindWidth

public void bindWidth(java.lang.String path)

Binds property width to the context attribute specified by path.

Parameters:

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

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfWidth

public java.lang.String bindingOfWidth()

Binding path of property width.

Returns:

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

getWidth

public java.lang.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(java.lang.String value)

Sets property width to the new value.

Parameters:

value - the new value of the width property

See Also:

getWidth()

bindWrapping

public void bindWrapping(java.lang.String path)

Binds property wrapping to the context attribute specified by path.

Parameters:

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

bindWrapping

public void bindWrapping(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfWrapping

public java.lang.String bindingOfWrapping()

Binding path of property wrapping.

Returns:

the path of the context attribute to which the wrapping 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 property wrapping to the new value.

Parameters:

value - the new value of the wrapping property

See Also:

getWrapping()