| Package | mx.accessibility |
| Class | public class ButtonAccImpl |
| Inheritance | ButtonAccImpl  AccImpl AccessibilityImplementation |
| Subclasses | CheckBoxAccImpl, LinkButtonAccImpl |
The ButtonAccImpl class supports system roles, object-based events, and states.
A Button reports the role ROLE_SYSTEM_PUSHBUTTON (0x2B) to a screen reader.
A Button reports the following states to a screen reader:
STATE_SYSTEM_NORMAL (0x00000000)STATE_SYSTEM_UNAVAILABLE (0x00000001)STATE_SYSTEM_FOCUSED (0x00000004)STATE_SYSTEM_PRESSED (0x00000008)STATE_SYSTEM_FOCUSABLE (0x00100000)A Button dispatches the following events to a screen reader:
EVENT_OBJECT_STATECHANGE (0x800A)EVENT_OBJECT_NAMECHANGE (0x800C)The user of a screen reader can activate a button component by using the spacebar or the Enter key.
This AccImpl class is used in CheckBox and RadioButton, as these components extend the Button class.
See also
| Property | Defined by | ||
|---|---|---|---|
| eventsToHandle : Array [read-only]
All AccImpl subclasses must override this function by returning an
array of strings of the events for which the class should listen from its master component.
| ButtonAccImpl | ||
 | master : UIComponent
A reference to the UIComponent instance that this AccImpl instance
is making accessible.
| AccImpl | |
| role : uint
Accessibility Role of the component being made accessible.
| AccImpl | |
| Method | Defined by | ||
|---|---|---|---|
|
ButtonAccImpl(master:UIComponent)
Creates a new ButtonAccImpl instance for the specified Button component.
| ButtonAccImpl | ||
|
accDoDefaultAction(childID:uint):void
IAccessible method for performing the default action associated with Button, which is Press.
| ButtonAccImpl | ||
|
accLocation(childID:uint):*
IAccessible method for returning a
DisplayObject or Rectangle specifying the bounding box of a child element in the AccessibilityImplementation. | AccessibilityImplementation | |
|
accSelect(selFlag:uint, childID:uint):void
IAccessible method for altering the selection in the component that this AccessibilityImplementation represents.
| AccessibilityImplementation | |
|
enableAccessibility():void
[static]
Method call for enabling accessibility for a component.
| ButtonAccImpl | ||
|
get_accDefaultAction(childID:uint):String
IAccessible method for returning the default action of the Button, which is Press.
| ButtonAccImpl | ||
|
get_accFocus():uint
IAccessible method for returning the unsigned integer ID of the child element, if any,
that has child focus within the component.
| AccessibilityImplementation | |
|
get_accName(childID:uint):String
IAccessible method for returning the name for the component that this AccessibilityImplementation represents or for one of its child elements.
| AccImpl | |
|
get_accRole(childID:uint):uint
IAccessible method for returning the system role for the component that this AccessibilityImplementation represents or for one of its child elements.
| AccImpl | |
|
get_accSelection():Array
IAccessible method for returning an array containing the IDs of all child elements that are selected.
| AccessibilityImplementation | |
|
get_accState(childID:uint):uint
IAccessible method for returning the state of the Button.
| ButtonAccImpl | ||
|
get_accValue(childID:uint):String
IAccessible method for returning the runtime value of the component that this AccessibilityImplementation represents or of one of its child elements.
| AccessibilityImplementation | |
|
getChildIDArray():Array
Returns an array containing the unsigned integer IDs of all child elements in the AccessibilityImplementation.
| AccessibilityImplementation | |
| Method | Defined by | ||
|---|---|---|---|
|
eventHandler(event:Event):void
Override the generic event handler.
| ButtonAccImpl | ||
|
getName(childID:uint):String
Method for returning the name of the Button which is spoken out by the screen reader.
| ButtonAccImpl | ||
|
getState(childID:uint):uint
Returns the state of the accessible component.
| AccImpl | |
| eventsToHandle | property |
Hide Inherited Public Properties
Show Inherited Public PropertieseventsToHandle:Array [read-only]All AccImpl subclasses must override this function by returning an array of strings of the events for which the class should listen from its master component.
Implementation protected function get eventsToHandle():Array
| ButtonAccImpl | () | constructor |
public function ButtonAccImpl(master:UIComponent)Creates a new ButtonAccImpl instance for the specified Button component.
Direct calls to the AccImpl subclass constructors are unneccessary.
When a Flex project is compiled with Generate accessible SWF file set to true,
the compiler instantiates the accessibility implementations for the components used in the
project that have them by calling the the static enableAccessibility() method.
master:UIComponent — The UIComponent instance that this ButtonAccImpl instance is making accessible.
|
See also
| accDoDefaultAction | () | method |
public override function accDoDefaultAction(childID:uint):voidIAccessible method for performing the default action associated with Button, which is Press.
ParameterschildID:uint — An unsigned integer corresponding to one of the component's child elements as defined by getChildIDArray().
|
See also
| enableAccessibility | () | method |
public static function enableAccessibility():voidMethod call for enabling accessibility for a component. This method is required for the compiler to activate the accessibility classes for a component.
When a Flex project is compiled with the Generate accessible SWF file set to true, the Flex compiler
automatically enables accessibility implementations for the components used in the project that have them.
Accessible component classes should include the [AccessibilityClass]
meta tag to specify the appropriate AccImpl subclass or accessibility implementation and let the compiler know to call
enableAccessibility().
See also
[AccessibilityClass] meta tag specifies the appropriate AccImpl
subclass or accessibility implementation for the mx.accessibility.Button component.
[AccessibilityClass(implementation="mx.accessibility.ButtonAccImpl")]
| eventHandler | () | method |
protected override function eventHandler(event:Event):voidOverride the generic event handler. Each AccImpl subclass must implement this method to listen for events from its master component.
Parametersevent:Event — The event object.
|
See also
| get_accDefaultAction | () | method |
public override function get_accDefaultAction(childID:uint):StringIAccessible method for returning the default action of the Button, which is Press.
ParameterschildID:uint — An unsigned integer corresponding to one of the component's child elements as defined by getChildIDArray().
|
String — DefaultAction String
|
See also
| get_accState | () | method |
public override function get_accState(childID:uint):uintIAccessible method for returning the state of the Button. States are predefined for all the components in MSAA. Values are assigned to each state. Depending upon the button being pressed or released, a value is returned.
ParameterschildID:uint — An unsigned integer corresponding to one of the component's child elements as defined by
getChildIDArray().
|
uint — State indicating whether the Button is pressed or released.
|
See also
| getName | () | method |
protected override function getName(childID:uint):StringMethod for returning the name of the Button which is spoken out by the screen reader. The Button should return the label inside as the name of the Button.
ParameterschildID:uint — An unsigned integer corresponding to one of the component's child elements as defined by
getChildIDArray().
|
String — Name string corresponding to the Button label.
|