topical media & game development

topical media & game development

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

student-ar-fl-accessibility-AccImpl.ax

student-ar-fl-accessibility-AccImpl.ax [swf] flex


  // Copyright 2007. Adobe Systems Incorporated. All Rights Reserved.
  package fl.accessibility {
          
          import flash.accessibility.Accessibility;
          import flash.accessibility.AccessibilityImplementation;
          import flash.accessibility.AccessibilityProperties;
          import flash.events.Event;
          import fl.core.UIComponent;
          import flash.display.MovieClip;
          import flash.text.TextField;

The @ax-student-ar-fl-accessibility-AccImpl class, also called the Accessibility Implementation class, is the base class for the implementation of accessibility in components. This class enables communication between a component and a screen reader. Screen readers are used to translate screen content into synthesized speech or braille for visually impaired users. @langversion 3.0 @playerversion Flash 9.0.28.0


   
          public class @ax-student-ar-fl-accessibility-AccImpl extends AccessibilityImplementation {
                  //--------------------------------------------------------------------------
                  //  Class constants
                  //--------------------------------------------------------------------------

@private Default state for all the components. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private static const STATE_SYSTEM_NORMAL:uint = 0x00000000;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private static const STATE_SYSTEM_FOCUSABLE:uint = 0x00100000;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private static const STATE_SYSTEM_FOCUSED:uint = 0x00000004;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private static const STATE_SYSTEM_UNAVAILABLE:uint = 0x00000001;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private static const EVENT_OBJECT_NAMECHANGE:uint = 0x800C;
  
                  //--------------------------------------------------------------------------
                  //  Variables
                  //--------------------------------------------------------------------------

@private (protected) A reference to the UIComponent instance that this @ax-student-ar-fl-accessibility-AccImpl instance is making accessible. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var master:UIComponent;

@private (protected) Accessibility Role of the component being made accessible. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var role:uint;
  
                  //--------------------------------------------------------------------------
                  //  Properties
                  //--------------------------------------------------------------------------

@private (protected) All subclasses must override this property by returning an array of strings that contains the events for which to listen. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function get eventsToHandle():Array {
                          return [];
                  }
  
                  //--------------------------------------------------------------------------
                  //  Class methods
                  //--------------------------------------------------------------------------

@private All subclasses must implement this function.
parameter: component The UIComponent instance that this @ax-student-ar-fl-accessibility-AccImpl instance is making accessible. @langversion 3.0 @playerversion Flash 9.0.28.0


          
                  public static function createAccessibilityImplementation(component:UIComponent):void {
                  }

Enables accessibility for a component. This method is required for the compiler to activate the accessibility classes for a component. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public static function enableAccessibility():void {
                  }        
          
                  //--------------------------------------------------------------------------
                  //  Constructor
                  //--------------------------------------------------------------------------

@private @internal Nivesh says: I don't think we should document the constructors for the accessibility classes. End-users just have to call the static enableAccessibility method. They don't really create an instance of the classes. Creates a new Accessibility Implementation instance for the specified component.
parameter: component The UIComponent instance that this @ax-student-ar-fl-accessibility-AccImpl instance makes accessible. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function @ax-student-ar-fl-accessibility-AccImpl(component:UIComponent) {
                          super();
                          stub = false;
                          master = component;
                          master.accessibilityProperties = new UIComponent@ax-student-ar-fl-accessibility-AccImpl(master);
                          // Hookup events to listen for
                          var events:Array = eventsToHandle;
                          if (events) {
                                  var n:int = events.length;
                                  for (var i:int = 0; i < n; i++) {
                                          master.addEventListener(events[i], eventHandler);
                                  }
                          }
                  }
  
                  
                  //--------------------------------------------------------------------------
                  //  Overridden methods: AccessibilityImplementation
                  //--------------------------------------------------------------------------

@private Returns the system role for the component.
parameter: childID The child id.
returns: Role associated with the component. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  override public function get_accRole(childID:uint):uint {
                          return role;
                  }

@private Returns the name of the component.
parameter: childID The child id.
returns: Name of the component. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  override public function get_accName(childID:uint):String {
                          var accName:String = "";
                          if (childID == 0
                                          && master.accessibilityProperties 
                                          && master.accessibilityProperties.name 
                                          && master.accessibilityProperties.name != "") {
                                  accName += master.accessibilityProperties.name + " ";
                          }
                          accName += getName(childID) + getStatusName();
                          return (accName != null && accName != "") ? accName : null;
                  }
  
                  //--------------------------------------------------------------------------
                  //  Methods
                  //--------------------------------------------------------------------------

@private (protected) Returns the name of the accessible component. All subclasses must implement this instead of implementing get_accName.
parameter: childID The child id.
returns: Name. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function getName(childID:uint):String {
                          return null;
                  }

@private (protected) Returns the state of the accessible component.
parameter: childID The child id.
returns: State. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function getState(childID:uint):uint {
                          var accState:uint = STATE_SYSTEM_NORMAL;
                          if (!UIComponent(master).enabled) {
                                  accState |= STATE_SYSTEM_UNAVAILABLE;
                          } else {
                                  accState |= STATE_SYSTEM_FOCUSABLE
                                  if (UIComponent(master) == UIComponent(master).getFocus()) {
                                          accState |= STATE_SYSTEM_FOCUSED;
                                  }
                          }
                          return accState;
                  }

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private function getStatusName():String {
                          return "";
                  }
  
                  //--------------------------------------------------------------------------
                  //  Event handlers
                  //--------------------------------------------------------------------------

@private (protected) Handles events from the master component. All @ax-student-ar-fl-accessibility-AccImpl subclasses must implement this to listen for events from its master component.
parameter: event The event object. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function eventHandler(event:Event):void
                  {
                  }
          }
  
  }

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.