Show TOC

TriStateCheckBoxLocate this document in the navigation structure

Use

This UI element is similar to a CheckBox , with the difference that the clicked on status is variable:

  • Option can be activated (selected)

  • Option cannot be activated (not selected)

  • Option is unspecified

Option Activated

Option Deactivated

Option Unspecified

Implementation Details

Runtime Class

CL_WD_TRI_STATE_CHECKBOX

Name

Type

Initial Value

Bindable

ID

STRING

(automatic)

No

activateAccessKey

WDY_BOOLEAN

false

No

checked

WDUI_TRI_STATE

true

Mandatory

contextMenuBehaviour

WDUI_CONTEXT_MENU_BEHAVIOUR

inherit

No

contextMenuId

WDY_MD_UI_ELEMENT_REFERENCE

 

No

enabled

WDY_BOOLEAN

true

Yes

explanation

Translatable text

 

No

readOnly

WDY_BOOLEAN

false

Yes

state

WDUI_STATE

normal

Yes

text

Translatable text

 

Yes

textDirection

WDUI_TEXT_DIRECTION

inherit

Yes

tooltip

Translatable text

 

Yes

visible

WDUI_VISIBILITY

visible

Yes

Name

onToggle

Other properties that can be inherited are defined in the related higher-level classes. The related UI elements are:

Accessibility

To enable the development of accessible applications, the tooltip property is checked during the syntax check if the text label properties are not set.

Dynamic Programming

For dynamic programming, the same properties, events and aggregations are available as in the View Designer. But note that the spelling format and use of upper/lower case is different.

View Designer Name

Runtime Name

Type

activateAccessKey

ACTIVATE_ACCESS_KEY

WDY_BOOLEAN

checked

CHECKED

WDUI_TRI_STATE

checked: false

CL_WD_TRI_STATE_CHECKBOX=>E_CHECKED-FALSE

checked: true

CL_WD_TRI_STATE_CHECKBOX=>E_CHECKED-TRUE

checked: undecided

CL_WD_TRI_STATE_CHECKBOX=>E_CHECKED-UNDECIDED

contextMenuBehaviour

CONTEXT_MENU_BEHAVIOUR

WDUI_CONTEXT_MENU_BEHAVIOUR

contextMenuBehaviour: inherit

CL_WD_TRI_STATE_CHECKBOX=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT

contextMenuBehaviour: provide

CL_WD_TRI_STATE_CHECKBOX=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE

contextMenuBehaviour: suppress

CL_WD_TRI_STATE_CHECKBOX=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS

contextMenuId

CONTEXT_MENU_ID

WDY_MD_UI_ELEMENT_REFERENCE

enabled

ENABLED

WDY_BOOLEAN

explanation

EXPLANATION

WDY_MD_TRANSLATABLE_TEX T

readOnly

READ_ONLY

WDY_BOOLEAN

state

STATE

WDUI_STATE

state: normal

CL_WD_TRI_STATE_CHECKBOX=>E_STATE-NORMAL

state: required

CL_WD_TRI_STATE_CHECKBOX=>E_STATE-REQUIRED

text

TEXT

WDY_MD_TRANSLATABLE_TEXT

textDirection

TEXT_DIRECTION

WDUI_TEXT_DIRECTION

textDirection: inherit

CL_WD_TRI_STATE_CHECKBOX=>E_TEXT_DIRECTION-INHERIT

textDirection: ltr

CL_WD_TRI_STATE_CHECKBOX=>E_TEXT_DIRECTION-LTR

textDirection: rtr

CL_WD_TRI_STATE_CHECKBOX=>E_TEXT_DIRECTION-RTL

tooltip

TOOLTIP

WDY_MD_TRANSLATABLE_TEXT

visible

VISIBLE

WDUI_VISIBILITY

visible: none

CL_WD_TRI_STATE_CHECKBOX=>E_VISIBLE-NONE

visible: visible

CL_WD_TRI_STATE_CHECKBOX=>E_VISIBLE-VISIBLE

View Designer Name

Runtime Name

onToggle

ON_TOGGLE

Example

You can find a test example of this UI element in the WDR_TEST_UI_ELEMENTS component.