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

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDCheckBoxGroup

extends IWDUIElement

Web Dynpro CheckBoxGroup API. CheckBoxGroup represents a multiple selection visualized by a group of check boxes.

Data binding:
The context must provide a node X with X.cardinality = 0..n and X.selection = 0..n with an attribute y. The type of y must be a simple type like String. The number of check boxes is the number of node elements, their texts are the values of attribute y, and the selection of the check boxes is determined by the (multiple) selection of the node.

The property texts 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_ACCESSIBILITY_DESCRIPTION Default value of property accessibilityDescription.
static int	DEFAULT_COL_COUNT Default value of property colCount.
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	bindAccessibilityDescription(IWDAttributeInfo attributeInfo) Binds property accessibilityDescription to the context attribute specified by the given attribute info.
void	bindAccessibilityDescription(java.lang.String path) Binds property accessibilityDescription to the context attribute specified by path.
void	bindColCount(IWDAttributeInfo attributeInfo) Binds property colCount to the context attribute specified by the given attribute info.
void	bindColCount(java.lang.String path) Binds property colCount to the context attribute specified by path.
java.lang.String	bindingOfAccessibilityDescription() Binding path of property accessibilityDescription.
java.lang.String	bindingOfColCount() Binding path of property colCount.
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	bindingOfTexts() Note: This property must be bound to the context! Binding path of property texts.
java.lang.String	bindingOfWidth() Binding path of property width.
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	bindTexts(IWDAttributeInfo attributeInfo) Note: This property must be bound to the context! Binds property texts to the context attribute specified by the given attribute info.
void	bindTexts(java.lang.String path) Note: This property must be bound to the context! Binds property texts 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.
java.lang.String	getAccessibilityDescription() Returns the value of the accessibilityDescription property.
int	getColCount() Returns the value of the colCount 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.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
java.lang.String	getWidth() Returns the value of the width property.
IWDParameterMapping	mappingOfOnToggle() Returns the parameter mapping of event onToggle.
void	setAccessibilityDescription(java.lang.String value) Sets property accessibilityDescription to the new value.
void	setColCount(int value) Sets property colCount 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	setTextDirection(WDTextDirection value) Sets property textDirection 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_ACCESSIBILITY_DESCRIPTION

public static final java.lang.String DEFAULT_ACCESSIBILITY_DESCRIPTION

Default value of property accessibilityDescription.

DEFAULT_COL_COUNT

public static final int DEFAULT_COL_COUNT

Default value of property colCount.

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

getOnToggle

public IWDAction getOnToggle()

Returns the action to which the event onToggle is mapped. The action performed when a check box in this group is toggled. Event parameters are the new checked value and the zero based index of the toggled check box.

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 checked value of the toggled check box.
• int index - The zero based index of the toggled check box.

Returns:

parameter mapping list.

See Also:

getOnToggle()

bindAccessibilityDescription

public void bindAccessibilityDescription(java.lang.String path)

Binds property accessibilityDescription to the context attribute specified by path.

Parameters:

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

bindAccessibilityDescription

public void bindAccessibilityDescription(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfAccessibilityDescription

public java.lang.String bindingOfAccessibilityDescription()

Binding path of property accessibilityDescription.

Returns:

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

getAccessibilityDescription

public java.lang.String getAccessibilityDescription()

Returns the value of the accessibilityDescription property. The initial value is "". Short description for the CheckBoxGroup (it's like a title) in the accessibility mode. It is only used if accessibility mode (508) is switched on and will be included into the tooltip. Its read by the screen reader when the whole UI element gets the focus.

Returns:

the current value of the accessibilityDescription property

See Also:

setAccessibilityDescription(String)

setAccessibilityDescription

public void setAccessibilityDescription(java.lang.String value)

Sets property accessibilityDescription to the new value.

Parameters:

value - the new value of the accessibilityDescription property

See Also:

getAccessibilityDescription()

bindColCount

public void bindColCount(java.lang.String path)

Binds property colCount to the context attribute specified by path.

Parameters:

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

bindColCount

public void bindColCount(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfColCount

public java.lang.String bindingOfColCount()

Binding path of property colCount.

Returns:

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

getColCount

public int getColCount()

Returns the value of the colCount property. The initial value is 1. Determines the number of columns used to display the check boxes.

Returns:

the current value of the colCount property

See Also:

setColCount(int)

setColCount

public void setColCount(int value)

Sets property colCount to the new value.

Parameters:

value - the new value of the colCount property

See Also:

getColCount()

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 boxes in this group 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 group.

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

bindTexts

public void bindTexts(java.lang.String path)

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

Parameters:

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

bindTexts

public void bindTexts(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTexts

public java.lang.String bindingOfTexts()

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

Returns:

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

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 "". Determines the (minimal) width of the CheckBoxGroup specified as CSS size.

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