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

All Superinterfaces:

IWDTableCellEditor, IWDUIElement, IWDViewElement

public interface IWDTextView

extends IWDUIElement, IWDTableCellEditor

Web Dynpro TextView API. The TextView UI element provides an area for displaying a multiline text.

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

Field Summary

static WDTextViewDesign	DEFAULT_DESIGN Default value of property design.
static WDInputFieldAlignment	DEFAULT_H_ALIGN Default value of property hAlign.
static WDTextViewLayout	DEFAULT_LAYOUT Default value of property layout.
static WDTextViewSemanticColor	DEFAULT_SEMANTIC_COLOR Default value of property semanticColor.
static java.lang.String	DEFAULT_TEXT Default value of property text.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of property textDirection.
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.
void	bindHAlign(IWDAttributeInfo attributeInfo) Binds property hAlign to the context attribute specified by the given attribute info.
void	bindHAlign(java.lang.String path) Binds property hAlign to the context attribute specified by path.
java.lang.String	bindingOfDesign() Binding path of property design.
java.lang.String	bindingOfHAlign() Binding path of property hAlign.
java.lang.String	bindingOfLayout() Binding path of property layout.
java.lang.String	bindingOfSemanticColor() Binding path of property semanticColor.
java.lang.String	bindingOfText() Binding path of property text.
java.lang.String	bindingOfTextDirection() Binding path of property textDirection.
java.lang.String	bindingOfWrapping() Binding path of property wrapping.
void	bindLayout(IWDAttributeInfo attributeInfo) Binds property layout to the context attribute specified by the given attribute info.
void	bindLayout(java.lang.String path) Binds property layout to the context attribute specified by path.
void	bindSemanticColor(IWDAttributeInfo attributeInfo) Binds property semanticColor to the context attribute specified by the given attribute info.
void	bindSemanticColor(java.lang.String path) Binds property semanticColor to the context attribute specified by path.
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	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.
WDTextViewDesign	getDesign() Returns the value of the design property.
WDInputFieldAlignment	getHAlign() Returns the value of the hAlign property.
WDTextViewLayout	getLayout() Returns the value of the layout property.
WDTextViewSemanticColor	getSemanticColor() Returns the value of the semanticColor property.
java.lang.String	getText() Returns the value of the text property.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
boolean	getWrapping() Returns the value of the wrapping property.
void	setDesign(WDTextViewDesign value) Sets property design to the new value.
void	setHAlign(WDInputFieldAlignment value) Sets property hAlign to the new value.
void	setLayout(WDTextViewLayout value) Sets property layout to the new value.
void	setSemanticColor(WDTextViewSemanticColor value) Sets property semanticColor to the new 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	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 WDTextViewDesign DEFAULT_DESIGN

Default value of property design.

DEFAULT_H_ALIGN

public static final WDInputFieldAlignment DEFAULT_H_ALIGN

Default value of property hAlign.

DEFAULT_LAYOUT

public static final WDTextViewLayout DEFAULT_LAYOUT

Default value of property layout.

DEFAULT_SEMANTIC_COLOR

public static final WDTextViewSemanticColor DEFAULT_SEMANTIC_COLOR

Default value of property semanticColor.

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_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 WDTextViewDesign getDesign()

Returns the value of the design property. The initial value is WDTextViewDesign.STANDARD. Describes the appearance of the TextView UI element.

Returns:

the current value of the design property

See Also:

setDesign(WDTextViewDesign)

setDesign

public void setDesign(WDTextViewDesign value)

Sets property design to the new value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindHAlign

public void bindHAlign(java.lang.String path)

Binds property hAlign to the context attribute specified by path.

Parameters:

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

bindHAlign

public void bindHAlign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHAlign

public java.lang.String bindingOfHAlign()

Binding path of property hAlign.

Returns:

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

getHAlign

public WDInputFieldAlignment getHAlign()

Returns the value of the hAlign property. The initial value is WDInputFieldAlignment.AUTO. Specifies the horizontal alignment of the TextView. It isn't considered if the layout attribute of the TextView has the value native.

Returns:

the current value of the hAlign property

See Also:

setHAlign(WDInputFieldAlignment)

setHAlign

public void setHAlign(WDInputFieldAlignment value)

Sets property hAlign to the new value.

Parameters:

value - the new value of the hAlign property

See Also:

getHAlign()

bindLayout

public void bindLayout(java.lang.String path)

Binds property layout to the context attribute specified by path.

Parameters:

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

bindLayout

public void bindLayout(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfLayout

public java.lang.String bindingOfLayout()

Binding path of property layout.

Returns:

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

getLayout

public WDTextViewLayout getLayout()

Returns the value of the layout property. The initial value is WDTextViewLayout.NATIVE. Determines the layout of this text view.

Returns:

the current value of the layout property

See Also:

setLayout(WDTextViewLayout)

setLayout

public void setLayout(WDTextViewLayout value)

Sets property layout to the new value.

Parameters:

value - the new value of the layout property

See Also:

getLayout()

bindSemanticColor

public void bindSemanticColor(java.lang.String path)

Binds property semanticColor to the context attribute specified by path.

Parameters:

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

bindSemanticColor

public void bindSemanticColor(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfSemanticColor

public java.lang.String bindingOfSemanticColor()

Binding path of property semanticColor.

Returns:

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

getSemanticColor

public WDTextViewSemanticColor getSemanticColor()

Returns the value of the semanticColor property. The initial value is WDTextViewSemanticColor.STANDARD. Determines the font color of the TextView.

Returns:

the current value of the semanticColor property

See Also:

setSemanticColor(WDTextViewSemanticColor)

setSemanticColor

public void setSemanticColor(WDTextViewSemanticColor value)

Sets property semanticColor to the new value.

Parameters:

value - the new value of the semanticColor property

See Also:

getSemanticColor()

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 "". Determines the text displayed in this text view.

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

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 text is wrapped.

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