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!

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Nested Class Summary

static interface

IWDCheckBoxGroup.IWDOnToggle Interface defining the parameter names for event onToggle.

Field Summary

static String	DEFAULT_ACCESSIBILITY_DESCRIPTION Default value of the accessibilityDescription property is "".
static int	DEFAULT_COL_COUNT Default value of the colCount property is 1.
static boolean	DEFAULT_READ_ONLY Default value of the readOnly property is false.
static WDState	DEFAULT_STATE Default value of the state property is WDState.NORMAL.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of the textDirection property is WDTextDirection.INHERIT.
static String	DEFAULT_WIDTH Default value of the width property is "".

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindAccessibilityDescription(IWDAttributeInfo attributeInfo) Binds the accessibilityDescription property to the context attribute specified by the given attribute info.
void	bindAccessibilityDescription(String path) Binds the accessibilityDescription property to the context attribute specified by the given path.
void	bindColCount(IWDAttributeInfo attributeInfo) Binds the colCount property to the context attribute specified by the given attribute info.
void	bindColCount(String path) Binds the colCount property to the context attribute specified by the given path.
String	bindingOfAccessibilityDescription() Returns the binding path of the accessibilityDescription property.
String	bindingOfColCount() Returns the binding path of the colCount property.
String	bindingOfReadOnly() Returns the binding path of the readOnly property.
String	bindingOfState() Returns the binding path of the state property.
String	bindingOfTextDirection() Returns the binding path of the textDirection property.
String	bindingOfTexts() Returns the binding path of the texts property.
String	bindingOfWidth() Returns the binding path of the width property.
void	bindReadOnly(IWDAttributeInfo attributeInfo) Binds the readOnly property to the context attribute specified by the given attribute info.
void	bindReadOnly(String path) Binds the readOnly property to the context attribute specified by the given path.
void	bindState(IWDAttributeInfo attributeInfo) Binds the state property to the context attribute specified by the given attribute info.
void	bindState(String path) Binds the state property to the context attribute specified by the given path.
void	bindTextDirection(IWDAttributeInfo attributeInfo) Binds the textDirection property to the context attribute specified by the given attribute info.
void	bindTextDirection(String path) Binds the textDirection property to the context attribute specified by the given path.
void	bindTexts(IWDAttributeInfo attributeInfo) Binds the texts property to the context attribute specified by the given attribute info.
void	bindTexts(String path) Binds the texts property to the context attribute specified by the given path.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds the width property to the context attribute specified by the given attribute info.
void	bindWidth(String path) Binds the width property to the context attribute specified by the given path.
String	getAccessibilityDescription() Returns the value of the accessibilityDescription property.
int	getColCount() Returns the value of the colCount property.
IWDAction	getOnToggle() Returns the action assigned to event onToggle.
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.
String	getWidth() Returns the value of the width property.
IWDParameterMapping	mappingOfOnToggle() Returns the parameter mapping for event onToggle.
void	setAccessibilityDescription(String value) Sets the accessibilityDescription property to the given value.
void	setColCount(int value) Sets the colCount property to the given value.
void	setOnToggle(IWDAction action) Assigns the given action to event onToggle.
void	setReadOnly(boolean value) Sets the readOnly property to the given value.
void	setState(WDState value) Sets the state property to the given value.
void	setTextDirection(WDTextDirection value) Sets the textDirection property to the given value.
void	setWidth(String value) Sets the width property to the given 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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_ACCESSIBILITY_DESCRIPTION

public static final String DEFAULT_ACCESSIBILITY_DESCRIPTION

Default value of the accessibilityDescription property is "".

See Also:

Constant Field Values

DEFAULT_COL_COUNT

public static final int DEFAULT_COL_COUNT

Default value of the colCount property is 1.

See Also:

Constant Field Values

DEFAULT_READ_ONLY

public static final boolean DEFAULT_READ_ONLY

Default value of the readOnly property is false.

See Also:

Constant Field Values

DEFAULT_STATE

public static final WDState DEFAULT_STATE

Default value of the state property is WDState.NORMAL.

DEFAULT_TEXT_DIRECTION

public static final WDTextDirection DEFAULT_TEXT_DIRECTION

Default value of the textDirection property is WDTextDirection.INHERIT.

DEFAULT_WIDTH

public static final String DEFAULT_WIDTH

Default value of the width property is "".

See Also:

Constant Field Values

Method Detail

getOnToggle

public IWDAction getOnToggle()

Returns the action assigned to event onToggle. 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 assigned to event onToggle

See Also:

mappingOfOnToggle()

setOnToggle

public void setOnToggle(IWDAction action)

Assigns the given action to event onToggle.

Parameters:

action - the action assigned to the event

See Also:

getOnToggle()

mappingOfOnToggle

public IWDParameterMapping mappingOfOnToggle()

Returns the parameter mapping for event onToggle.

To pass UI element event parameter values into action handler parameters, a parameter mapping has to be defined. Add code like the following inside method wdDoModifyView() of the view controller:

 if (firstTime)
 {
   IWDCheckBoxGroup myCheckBoxGroup = (IWDCheckBoxGroup) view.getElement("ID-of-CheckBoxGroup");
   myCheckBoxGroup.mappingOfOnToggle().addSourceMapping
   (
     IWDCheckBoxGroup.IWDOnToggle.CHECKED, // event parameter name
     "name-of-action-parameter" // (type boolean)
   ); 
   myCheckBoxGroup.mappingOfOnToggle().addSourceMapping
   (
     IWDCheckBoxGroup.IWDOnToggle.INDEX, // event parameter name
     "name-of-action-parameter" // (type int)
   ); 
 }

 

Event onToggle has the following parameters:

• boolean checked
  The new checked value of the toggled check box.
• int index
  The zero based index of the toggled check box.

Returns:

the parameter mapping for event onToggle

See Also:

getOnToggle()

bindAccessibilityDescription

public void bindAccessibilityDescription(String path)

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

Parameters:

path - the context path of the attribute to which the accessibilityDescription property will be bound

bindAccessibilityDescription

public void bindAccessibilityDescription(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfAccessibilityDescription

public String bindingOfAccessibilityDescription()

Returns the binding path of the accessibilityDescription property.

Returns:

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

getAccessibilityDescription

public 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(String value)

Sets the accessibilityDescription property to the given value.

Parameters:

value - the new value of the accessibilityDescription property

See Also:

getAccessibilityDescription()

bindColCount

public void bindColCount(String path)

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

Parameters:

path - the context path of the attribute to which the colCount property will be bound

bindColCount

public void bindColCount(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfColCount

public String bindingOfColCount()

Returns the binding path of the colCount property.

Returns:

the path of the context attribute to which the colCount property 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 the colCount property to the given value.

Parameters:

value - the new value of the colCount property

See Also:

getColCount()

bindReadOnly

public void bindReadOnly(String path)

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

Parameters:

path - the context path of the attribute to which the readOnly property will be bound

bindReadOnly

public void bindReadOnly(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfReadOnly

public String bindingOfReadOnly()

Returns the binding path of the readOnly property.

Returns:

the path of the context attribute to which the readOnly property 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 the readOnly property to the given value.

Parameters:

value - the new value of the readOnly property

See Also:

getReadOnly()

bindState

public void bindState(String path)

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

Parameters:

path - the context path of the attribute to which the state property will be bound

bindState

public void bindState(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfState

public String bindingOfState()

Returns the binding path of the state property.

Returns:

the path of the context attribute to which the state property 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 the state property to the given value.

Parameters:

value - the new value of the state property

See Also:

getState()

bindTextDirection

public void bindTextDirection(String path)

Binds the textDirection property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the textDirection property will be bound

bindTextDirection

public void bindTextDirection(IWDAttributeInfo attributeInfo)

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

Parameters:

attributeInfo - the info of the context attribute to which the textDirection property will be bound

bindingOfTextDirection

public String bindingOfTextDirection()

Returns the binding path of the textDirection property.

Returns:

the path of the context attribute to which the textDirection property 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 the textDirection property to the given value.

Parameters:

value - the new value of the textDirection property

See Also:

getTextDirection()

bindTexts

public void bindTexts(String path)

Binds the texts property to the context attribute specified by the given path.

Note: This property must be bound to the context!

Parameters:

path - the context path of the attribute to which the texts property will be bound

bindTexts

public void bindTexts(IWDAttributeInfo attributeInfo)

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

Note: This property must be bound to the context!

Parameters:

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

bindingOfTexts

public String bindingOfTexts()

Returns the binding path of the texts property.

Note: This property must be bound to the context!

Returns:

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

bindWidth

public void bindWidth(String path)

Binds the width property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the width property will be bound

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

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

Parameters:

attributeInfo - the info of the context attribute to which the width property will be bound

bindingOfWidth

public String bindingOfWidth()

Returns the binding path of the width property.

Returns:

the path of the context attribute to which the width property is currently bound

getWidth

public 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(String value)

Sets the width property to the given value.

Parameters:

value - the new value of the width property

See Also:

getWidth()