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

All Superinterfaces:

IWDTableCellEditor, IWDUIElement, IWDViewElement

public interface IWDCheckBox

extends IWDUIElement, IWDTableCellEditor

Web Dynpro CheckBox API. CheckBox displays a boolean value together with a text. By checking the box the boolean value is set to true. The property checked contains the value, text contains the displayed text.

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

Field Summary

static boolean	DEFAULT_READ_ONLY Default value of property readOnly.
static WDState	DEFAULT_STATE Default value of property state.
static java.lang.String	DEFAULT_TEXT Default value of property text.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of property textDirection.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindChecked(IWDAttributeInfo attributeInfo) Note: This property must be bound to the context! Binds property checked to the context attribute specified by the given attribute info.
void	bindChecked(java.lang.String path) Note: This property must be bound to the context! Binds property checked to the context attribute specified by path.
java.lang.String	bindingOfChecked() Note: This property must be bound to the context! Binding path of property checked.
java.lang.String	bindingOfReadOnly() Binding path of property readOnly.
java.lang.String	bindingOfState() Binding path of property state.
java.lang.String	bindingOfText() Binding path of property text.
java.lang.String	bindingOfTextDirection() Binding path of property textDirection.
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	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.
boolean	getChecked() Note: This property must be bound to the context! Returns the value of the checked property.
IWDAction	getOnToggle() Returns the action to which the event onToggle is mapped.
boolean	getReadOnly() Returns the value of the readOnly property.
WDState	getState() Returns the value of the state property.
java.lang.String	getText() Returns the value of the text property.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
IWDParameterMapping	mappingOfOnToggle() Returns the parameter mapping of event onToggle.
void	setChecked(boolean value) Note: This property must be bound to the context! Sets property checked to the new value.
void	setOnToggle(IWDAction action) Maps the event onToggle to the given action.
void	setReadOnly(boolean value) Sets property readOnly to the new value.
void	setState(WDState value) Sets property state 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.

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_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

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.

Method Detail

getOnToggle

public IWDAction getOnToggle()

Returns the action to which the event onToggle is mapped. The action performed when the check box is toggled. The event parameter is the new checked state.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnToggle()

setOnToggle

public void setOnToggle(IWDAction action)

Maps the event onToggle to the given action.

Parameters:

action - the action for the event

See Also:

getOnToggle()

mappingOfOnToggle

public IWDParameterMapping mappingOfOnToggle()

Returns the parameter mapping of event onToggle.

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:

• boolean checked - The new state of the check box, true if checked.

Returns:

parameter mapping list.

See Also:

getOnToggle()

bindChecked

public void bindChecked(java.lang.String path)

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

Parameters:

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

bindChecked

public void bindChecked(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfChecked

public java.lang.String bindingOfChecked()

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

Returns:

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

getChecked

public boolean getChecked()

Note: This property must be bound to the context! Returns the value of the checked property. The initial value is false. Determines if the check box is checked.

Returns:

the current value of the checked property

See Also:

setChecked(boolean)

setChecked

public void setChecked(boolean value)

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

Parameters:

value - the new value of the checked property

See Also:

getChecked()

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. Controls whether the check box may be toggled.

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 check box.

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

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 "". The text displayed in the check box.

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