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

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDTextEdit

extends IWDUIElement

Web Dynpro TextEdit API. TextEdit is used to display and edit several lines of text. The edited value is given by the value property. The size of the text edit is given by the cols and rows properties.

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

Field Summary

static int	DEFAULT_COLS Default value of property cols.
static java.lang.String	DEFAULT_HEIGHT Default value of property height.
static boolean	DEFAULT_READ_ONLY Default value of property readOnly.
static int	DEFAULT_ROWS Default value of property rows.
static WDState	DEFAULT_STATE Default value of property state.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of property textDirection.
static java.lang.String	DEFAULT_WIDTH Default value of property width.
static WDTextWrapping	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	bindCols(IWDAttributeInfo attributeInfo) Binds property cols to the context attribute specified by the given attribute info.
void	bindCols(java.lang.String path) Binds property cols to the context attribute specified by path.
void	bindHeight(IWDAttributeInfo attributeInfo) Binds property height to the context attribute specified by the given attribute info.
void	bindHeight(java.lang.String path) Binds property height to the context attribute specified by path.
java.lang.String	bindingOfCols() Binding path of property cols.
java.lang.String	bindingOfHeight() Binding path of property height.
java.lang.String	bindingOfReadOnly() Binding path of property readOnly.
java.lang.String	bindingOfRows() Binding path of property rows.
java.lang.String	bindingOfState() Binding path of property state.
java.lang.String	bindingOfTextDirection() Binding path of property textDirection.
java.lang.String	bindingOfValue() Note: This property must be bound to the context! Binding path of property value.
java.lang.String	bindingOfWidth() Binding path of property width.
java.lang.String	bindingOfWrapping() Binding path of property wrapping.
void	bindReadOnly(IWDAttributeInfo attributeInfo) Binds property readOnly to the context attribute specified by the given attribute info.
void	bindReadOnly(java.lang.String path) Binds property readOnly to the context attribute specified by path.
void	bindRows(IWDAttributeInfo attributeInfo) Binds property rows to the context attribute specified by the given attribute info.
void	bindRows(java.lang.String path) Binds property rows to the context attribute specified by path.
void	bindState(IWDAttributeInfo attributeInfo) Binds property state to the context attribute specified by the given attribute info.
void	bindState(java.lang.String path) Binds property state 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	bindValue(IWDAttributeInfo attributeInfo) Note: This property must be bound to the context! Binds property value to the context attribute specified by the given attribute info.
void	bindValue(java.lang.String path) Note: This property must be bound to the context! Binds property value 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.
int	getCols() Returns the value of the cols property.
java.lang.String	getHeight() Returns the value of the height property.
boolean	getReadOnly() Returns the value of the readOnly property.
int	getRows() Returns the value of the rows property.
WDState	getState() Returns the value of the state property.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
java.lang.String	getValue() Note: This property must be bound to the context! Returns the value of the value property.
java.lang.String	getWidth() Returns the value of the width property.
WDTextWrapping	getWrapping() Returns the value of the wrapping property.
void	setCols(int value) Sets property cols to the new value.
void	setHeight(java.lang.String value) Sets property height to the new value.
void	setReadOnly(boolean value) Sets property readOnly to the new value.
void	setRows(int value) Sets property rows to the new value.
void	setState(WDState value) Sets property state to the new value.
void	setTextDirection(WDTextDirection value) Sets property textDirection to the new value.
void	setValue(java.lang.String value) Note: This property must be bound to the context! Sets property value to the new value.
void	setWidth(java.lang.String value) Sets property width to the new value.
void	setWrapping(WDTextWrapping 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_COLS

public static final int DEFAULT_COLS

Default value of property cols.

DEFAULT_HEIGHT

public static final java.lang.String DEFAULT_HEIGHT

Default value of property height.

DEFAULT_READ_ONLY

public static final boolean DEFAULT_READ_ONLY

Default value of property readOnly.

DEFAULT_ROWS

public static final int DEFAULT_ROWS

Default value of property rows.

DEFAULT_STATE

public static final WDState DEFAULT_STATE

Default value of property state.

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

Default value of property wrapping.

Method Detail

bindCols

public void bindCols(java.lang.String path)

Binds property cols to the context attribute specified by path.

Parameters:

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

bindCols

public void bindCols(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfCols

public java.lang.String bindingOfCols()

Binding path of property cols.

Returns:

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

getCols

public int getCols()

Returns the value of the cols property. The initial value is 40. Determines the number of text columns displayed.

Returns:

the current value of the cols property

See Also:

setCols(int)

setCols

public void setCols(int value)

Sets property cols to the new value.

Parameters:

value - the new value of the cols property

See Also:

getCols()

bindHeight

public void bindHeight(java.lang.String path)

Binds property height to the context attribute specified by path.

Parameters:

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

bindHeight

public void bindHeight(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHeight

public java.lang.String bindingOfHeight()

Binding path of property height.

Returns:

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

getHeight

public java.lang.String getHeight()

Returns the value of the height property. The initial value is "". The height (CSS size) of the TextEdit.

Returns:

the current value of the height property

See Also:

setHeight(String)

setHeight

public void setHeight(java.lang.String value)

Sets property height to the new value.

Parameters:

value - the new value of the height property

See Also:

getHeight()

bindReadOnly

public void bindReadOnly(java.lang.String path)

Binds property readOnly to the context attribute specified by path.

Parameters:

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

bindReadOnly

public void bindReadOnly(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfReadOnly

public java.lang.String bindingOfReadOnly()

Binding path of property readOnly.

Returns:

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

getReadOnly

public boolean getReadOnly()

Returns the value of the readOnly property. The initial value is false. Determines if the value of the TextEdit may be edited.

Returns:

the current value of the readOnly property

See Also:

setReadOnly(boolean)

setReadOnly

public void setReadOnly(boolean value)

Sets property readOnly to the new value.

Parameters:

value - the new value of the readOnly property

See Also:

getReadOnly()

bindRows

public void bindRows(java.lang.String path)

Binds property rows to the context attribute specified by path.

Parameters:

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

bindRows

public void bindRows(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfRows

public java.lang.String bindingOfRows()

Binding path of property rows.

Returns:

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

getRows

public int getRows()

Returns the value of the rows property. The initial value is 5. Determines the number of text rows displayed.

Returns:

the current value of the rows property

See Also:

setRows(int)

setRows

public void setRows(int value)

Sets property rows to the new value.

Parameters:

value - the new value of the rows property

See Also:

getRows()

bindState

public void bindState(java.lang.String path)

Binds property state to the context attribute specified by path.

Parameters:

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

bindState

public void bindState(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfState

public java.lang.String bindingOfState()

Binding path of property state.

Returns:

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

getState

public WDState getState()

Returns the value of the state property. The initial value is WDState.NORMAL. The error state of the text edit element.

Returns:

the current value of the state property

See Also:

setState(WDState)

setState

public void setState(WDState value)

Sets property state to the new value.

Parameters:

value - the new value of the state property

See Also:

getState()

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

bindValue

public void bindValue(java.lang.String path)

Note: This property must be bound to the context! Binds property value to the context attribute specified by path.

Parameters:

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

bindValue

public void bindValue(IWDAttributeInfo attributeInfo)

Note: This property must be bound to the context! Binds property value to the context attribute specified by the given attribute info.

Parameters:

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

bindingOfValue

public java.lang.String bindingOfValue()

Note: This property must be bound to the context! Binding path of property value.

Returns:

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

getValue

public java.lang.String getValue()

Note: This property must be bound to the context! Returns the value of the value property. The initial value is "". Determines the value edited by this text editor.

Returns:

the current value of the value property

See Also:

setValue(String)

setValue

public void setValue(java.lang.String value)

Note: This property must be bound to the context! Sets property value to the new value.

Parameters:

value - the new value of the value property

See Also:

getValue()

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

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

Returns the value of the wrapping property. The initial value is WDTextWrapping.SOFT. Determines how the text is wrapped.

Returns:

the current value of the wrapping property

See Also:

setWrapping(WDTextWrapping)

setWrapping

public void setWrapping(WDTextWrapping value)

Sets property wrapping to the new value.

Parameters:

value - the new value of the wrapping property

See Also:

getWrapping()