cpr.controls.ListBoxAccessibility

Class that manages accessibility of ListBox Provides a two-level structure of listbox (root) and item. You can set each individual item through forItem().
Hierarchy

Index

Properties
Name Type Description
item ItemsAccessibility item Returns the default accessibility settings for all items.
Methods
Name Return Type Description
aria String Get the corresponding ARIA attribute value.
bind IBindFactory Bind to a specific ARIA property.
dispose
getBindContext BindContext
removeAria Removes set accessibility properties.
unbind Unbinds to a specific ARIA property.

Properties

item
type ItemsAccessibility
readonly
item Returns the default accessibility settings for all items. You can set each individual item through forItem().

Methods

aria(property)
declaring typeAccessibility
Get the corresponding ARIA attribute value.
Parameters
name type description
property String ARIA attribute name from which to get the value. The "aria-" prefix can be omitted.
return String The corresponding ARIA attribute value.
aria(property, value)
declaring typeAccessibility
Specifies the value of a specific ARIA attribute.
Parameters
name type description
property String The ARIA attribute name to assign a value to. The "aria-" prefix can be omitted.
value String The attribute value to specify.
aria(property, value)
declaring typeAccessibility
Specifies specific ARIA attribute values. If you specify an Accessibility object, that object's reference ID is used as the property value. You can assign an Accessibility object to a property that references another element, such as aria-labelledby, aria-describedby, etc.
Parameters
name type description
property String The ARIA attribute name to assign a value to. The "aria-" prefix can be omitted.
value Accessibility The attribute value to specify.
aria(property, value)
declaring typeAccessibility
Specifies specific ARIA attribute values. When specifying an array, the value of each element is used as the property value. Used for properties that can refer to multiple elements, such as aria-labelledby, aria-describedby, etc. For arrays containing Accessibility objects, the reference ID of each object is used.
Parameters
name type description
property String The ARIA attribute name to assign a value to. The "aria-" prefix can be omitted.
value Accessibility[] An array of property values ​​to specify.
aria()
declaring typeAccessibility
Get all specified ARIA properties in JSON format.
return AriaSet
aria(set)
declaring typeAccessibility
Specify multiple ARIA properties at once.
Parameters
name type description
set AriaSet A JSON object with the property name keys and values ​​to specify.
bind(propertyName)
declaring typeAccessibility
Bind to a specific ARIA property.
Parameters
name type description
propertyName String The name of the property to bind to. The "aria-" prefix can be omitted.
return IBindFactory A binding factory for that attribute.
dispose()
declaring typeAccessibility
getBindContext()
declaring typeAccessibility
return BindContext
removeAria(propertyName)
declaring typeAccessibility
Removes set accessibility properties.
Parameters
name type description
propertyName String property name
unbind(propertyName)
declaring typeAccessibility
Unbinds to a specific ARIA property.
Parameters
name type description
propertyName String The name of the property to unbind. The "aria-" prefix can be omitted.