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

All Superinterfaces:

IWDTableCellEditor, IWDUIElement, IWDViewElement

public interface IWDRadioButton

extends IWDUIElement, IWDTableCellEditor

Web Dynpro RadioButton API. RadioButton represents a two-state button.

Data binding:
The button state is retrieved from a context. This context must provide a node X with an attribute y of type String. The key to select this radio button is specified by the property keyToSelect. The radio button is selected if and only if its selected key equals the value of the context attribute y.

The property selectedKey must be bound to the attribute y.

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

Field Summary

static java.lang.String	DEFAULT_KEY_TO_SELECT Default value of property keyToSelect.
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

java.lang.String	bindingOfKeyToSelect() Binding path of property keyToSelect.
java.lang.String	bindingOfReadOnly() Binding path of property readOnly.
java.lang.String	bindingOfSelectedKey() Note: This property must be bound to the context! Binding path of property selectedKey.
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	bindKeyToSelect(IWDAttributeInfo attributeInfo) Binds property keyToSelect to the context attribute specified by the given attribute info.
void	bindKeyToSelect(java.lang.String path) Binds property keyToSelect 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	bindSelectedKey(IWDAttributeInfo attributeInfo) Note: This property must be bound to the context! Binds property selectedKey to the context attribute specified by the given attribute info.
void	bindSelectedKey(java.lang.String path) Note: This property must be bound to the context! Binds property selectedKey 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.
java.lang.String	getKeyToSelect() Returns the value of the keyToSelect property.
IWDAction	getOnSelect() Returns the action to which the event onSelect is mapped.
boolean	getReadOnly() Returns the value of the readOnly property.
java.lang.String	getSelectedKey() Note: This property must be bound to the context! Returns the value of the selectedKey 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	mappingOfOnSelect() Returns the parameter mapping of event onSelect.
void	setKeyToSelect(java.lang.String value) Sets property keyToSelect to the new value.
void	setOnSelect(IWDAction action) Maps the event onSelect to the given action.
void	setReadOnly(boolean value) Sets property readOnly to the new value.
void	setSelectedKey(java.lang.String value) Note: This property must be bound to the context! Sets property selectedKey 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_KEY_TO_SELECT

public static final java.lang.String DEFAULT_KEY_TO_SELECT

Default value of property keyToSelect.

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

getOnSelect

public IWDAction getOnSelect()

Returns the action to which the event onSelect is mapped. The action performed when the radio button is selected. Event parameter is the key used to select the radio button.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnSelect()

setOnSelect

public void setOnSelect(IWDAction action)

Maps the event onSelect to the given action.

Parameters:

action - the action for the event

See Also:

getOnSelect()

mappingOfOnSelect

public IWDParameterMapping mappingOfOnSelect()

Returns the parameter mapping of event onSelect.

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:

• String key - The key used to select the radio button.

Returns:

parameter mapping list.

See Also:

getOnSelect()

bindKeyToSelect

public void bindKeyToSelect(java.lang.String path)

Binds property keyToSelect to the context attribute specified by path.

Parameters:

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

bindKeyToSelect

public void bindKeyToSelect(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfKeyToSelect

public java.lang.String bindingOfKeyToSelect()

Binding path of property keyToSelect.

Returns:

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

getKeyToSelect

public java.lang.String getKeyToSelect()

Returns the value of the keyToSelect property. The initial value is "". Determines the key used to select this radio button.

Returns:

the current value of the keyToSelect property

See Also:

setKeyToSelect(String)

setKeyToSelect

public void setKeyToSelect(java.lang.String value)

Sets property keyToSelect to the new value.

Parameters:

value - the new value of the keyToSelect property

See Also:

getKeyToSelect()

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

bindSelectedKey

public void bindSelectedKey(java.lang.String path)

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

Parameters:

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

bindSelectedKey

public void bindSelectedKey(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfSelectedKey

public java.lang.String bindingOfSelectedKey()

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

Returns:

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

getSelectedKey

public java.lang.String getSelectedKey()

Note: This property must be bound to the context! Returns the value of the selectedKey property. The initial value is "". Determines the context attribute from where this radio button gets its data.

Returns:

the current value of the selectedKey property

See Also:

setSelectedKey(String)

setSelectedKey

public void setSelectedKey(java.lang.String value)

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

Parameters:

value - the new value of the selectedKey property

See Also:

getSelectedKey()

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 this radio button.

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

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