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

All Superinterfaces:

IWDUIElement, IWDViewElement

All Known Subinterfaces:

IWDInputField, IWDToolBarInputField

public interface IWDAbstractInputField

extends IWDUIElement

Web Dynpro AbstractInputField API. Abstract base class of input fields. Used to display and edit a single line of text. The edited value is given by the property value. If the readOnly property is set to true the value may not be edited. The passwordField property is used to enter text that should not be visible when edited. The length property determines the width of the field measured in characters.

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

Field Summary

static WDInputFieldAlignment	DEFAULT_ALIGNMENT Default value of property alignment.
static int	DEFAULT_LENGTH Default value of property length.
static boolean	DEFAULT_PASSWORD_FIELD Default value of property passwordField.
static boolean	DEFAULT_READ_ONLY Default value of property readOnly.
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.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindAlignment(IWDAttributeInfo attributeInfo) Binds property alignment to the context attribute specified by the given attribute info.
void	bindAlignment(java.lang.String path) Binds property alignment to the context attribute specified by path.
java.lang.String	bindingOfAlignment() Binding path of property alignment.
java.lang.String	bindingOfLength() Binding path of property length.
java.lang.String	bindingOfPasswordField() Binding path of property passwordField.
java.lang.String	bindingOfReadOnly() Binding path of property readOnly.
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.
void	bindLength(IWDAttributeInfo attributeInfo) Binds property length to the context attribute specified by the given attribute info.
void	bindLength(java.lang.String path) Binds property length to the context attribute specified by path.
void	bindPasswordField(IWDAttributeInfo attributeInfo) Binds property passwordField to the context attribute specified by the given attribute info.
void	bindPasswordField(java.lang.String path) Binds property passwordField to the context attribute specified by path.
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	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.
WDInputFieldAlignment	getAlignment() Returns the value of the alignment property.
int	getLength() Returns the value of the length property.
IWDAction	getOnEnter() Returns the action to which the event onEnter is mapped.
boolean	getPasswordField() Returns the value of the passwordField property.
boolean	getReadOnly() Returns the value of the readOnly 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.
IWDParameterMapping	mappingOfOnEnter() Returns the parameter mapping of event onEnter.
void	setAlignment(WDInputFieldAlignment value) Sets property alignment to the new value.
void	setLength(int value) Sets property length to the new value.
void	setOnEnter(IWDAction action) Maps the event onEnter to the given action.
void	setPasswordField(boolean value) Sets property passwordField to the new value.
void	setReadOnly(boolean value) Sets property readOnly 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.

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_ALIGNMENT

public static final WDInputFieldAlignment DEFAULT_ALIGNMENT

Default value of property alignment.

DEFAULT_LENGTH

public static final int DEFAULT_LENGTH

Default value of property length.

DEFAULT_PASSWORD_FIELD

public static final boolean DEFAULT_PASSWORD_FIELD

Default value of property passwordField.

DEFAULT_READ_ONLY

public static final boolean DEFAULT_READ_ONLY

Default value of property readOnly.

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.

Method Detail

getOnEnter

public IWDAction getOnEnter()

Returns the action to which the event onEnter is mapped. The action performed when enter is pressed

Returns:

the action to which the event is mapped

See Also:

mappingOfOnEnter()

setOnEnter

public void setOnEnter(IWDAction action)

Maps the event onEnter to the given action.

Parameters:

action - the action for the event

See Also:

getOnEnter()

mappingOfOnEnter

public IWDParameterMapping mappingOfOnEnter()

Returns the parameter mapping of event onEnter.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• none

Returns:

parameter mapping list.

See Also:

getOnEnter()

bindAlignment

public void bindAlignment(java.lang.String path)

Binds property alignment to the context attribute specified by path.

Parameters:

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

bindAlignment

public void bindAlignment(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfAlignment

public java.lang.String bindingOfAlignment()

Binding path of property alignment.

Returns:

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

getAlignment

public WDInputFieldAlignment getAlignment()

Returns the value of the alignment property. The initial value is WDInputFieldAlignment.AUTO. The alignment of the input field text.

Returns:

the current value of the alignment property

See Also:

setAlignment(WDInputFieldAlignment)

setAlignment

public void setAlignment(WDInputFieldAlignment value)

Sets property alignment to the new value.

Parameters:

value - the new value of the alignment property

See Also:

getAlignment()

bindLength

public void bindLength(java.lang.String path)

Binds property length to the context attribute specified by path.

Parameters:

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

bindLength

public void bindLength(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfLength

public java.lang.String bindingOfLength()

Binding path of property length.

Returns:

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

getLength

public int getLength()

Returns the value of the length property. The initial value is null. Determines the length of this input field in characters.

Returns:

the current value of the length property

See Also:

setLength(int)

setLength

public void setLength(int value)

Sets property length to the new value.

Parameters:

value - the new value of the length property

See Also:

getLength()

bindPasswordField

public void bindPasswordField(java.lang.String path)

Binds property passwordField to the context attribute specified by path.

Parameters:

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

bindPasswordField

public void bindPasswordField(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfPasswordField

public java.lang.String bindingOfPasswordField()

Binding path of property passwordField.

Returns:

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

getPasswordField

public boolean getPasswordField()

Returns the value of the passwordField property. The initial value is false. If set to true, the entered characters are not echoed in the field.

Returns:

the current value of the passwordField property

See Also:

setPasswordField(boolean)

setPasswordField

public void setPasswordField(boolean value)

Sets property passwordField to the new value.

Parameters:

value - the new value of the passwordField property

See Also:

getPasswordField()

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 input field is editable or not.

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

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 state of the input field. This is only a hint used by the renderer. For example, if the input field state is set to required, this is not tested by the framework, but has to be checked by the application.

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 edited data value.

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 a InputField.

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