AccessibilityImplementation  - AS3

Обозначает код ошибки. Ошибки отображаются не в значениях возвращаемых данных, а во внешнем канале. Для обозначения ошибки следует установить свойство errno для одного из кодов ошибок, перечисленных в приложении «Константы AccessibilityImplementation». При этом значение возвращаемых данных будет игнорироваться. Проигрыватель всегда отменяет (устанавливает на нуль) свойство errno пользовательского AccessibilityImplementation перед вызовом любого метода AccessibilityImplementation.

Связанные элементы API

Используется для создания подпрограммы специальных возможностей компонента. Если компонент выпущен без реализации специальных возможностей ActionScript, Adobe рекомендует добавить подпрограмму специальных возможностей компонента. В целях использования специальных возможностей с помощью этой заглушки Flash Player обрабатывает компонент как простой графический объект вместо предоставления внутренней структуры кнопок, текстовых полей и т. д. в компоненте.

Для создания подпрограммы специальных возможностей компонента следует создать подкласс класса AccImpl, заменив подпрограмму свойства на значение true.

Связанные элементы API

Статический конструктор. Не следует создавать экземпляр AccessibilityImplementation непосредственно путем вызова его конструктора. Вместо этого можно создать новые реализации расширенного доступа, расширив класс mx.accessibility.AccImpl для каждого нового компонента.

Связанные элементы API

Метод IAccessible, выполняющий действия по умолчанию, связанные с компонентом, представленным этим AccessibilityImplementation или являющимся одним из его дочерних элементов.

Этот метод следует реализовывать только в том случае, если AccessibilityImplementation представляет элемент пользовательского интерфейса, имеющий действие по умолчанию в модели MSAA.

При реализации accDoDefaultAction() только для AccessibilityImplementation или только для его дочерних элементов необходимо в некоторых случаях указать отсутствие действия по умолчанию для определенного childID, который был передан. Для этого следует задать свойству errno значение E_MEMBERNOTFOUND.

Параметры

     override public function accDoDefaultAction(childID:uint):void
     {
         if (childID > 0)
             ListBase(master).selectedIndex = childID - 1;
     }

Метод MSAA для возвращения DisplayObject или Rectangle с указанием ограничительной рамки дочернего элемента в AccessibilityImplementation.

Этот метод никогда не вызывается с childID равным нулю. Если AccessibilityImplementation никогда не будет содержать дочерние элементы, то не следует реализовывать этот метод. Если AccessibilityImplementation может содержать дочерние элементы, то этот метод обязателен.

Требования этого метода выполняются возвращением объекта, который непосредственно представляет дочерний элемент. Для этого дочерний элемент должен являться DisplayObject. В этом случае необходимо возвратить DisplayObject, соответствующий имени экземпляра, связанному с соответствующим визуальным объектом в списке отображения.

Если дочерний элемент не отвечает вышеизложенным требованиям, можно самостоятельно рассчитать значения ограничительной рамки и возвратить Rectangle со свойствами: x, y, width и height. Элементы x и y определяют верхний левый угол ограничительной рамки, в то время как элементы width и height определяют ее размер. Все четыре элемента должны измеряться в пикселях Stage и иметь отношение к источнику компонента, представляемого AccessibilityImplementation. Свойства x и y могут иметь отрицательные значения, так как источник DisplayObject не обязательно находится в левом верхнем углу.

Если дочерний элемент, указанный childID, не видим (т.е. get_accState для этого дочернего элемента возвратит значение, включающее STATE_SYSTEM_INVISIBLE), можно возвратить null из accLocation. Также можно возвратить Rectangle, представляющий координаты, где дочерний элемент появился бы в случае, если бы он был видимым.

Параметры

Дополнительно

Связанные элементы API

     override public function accLocation(childID:uint):*
     
     {
         var listBase:ListBase = ListBase(master);
     
         var index:uint = childID - 1;
         
         if (index < listBase.verticalScrollPosition ||
             index >= listBase.verticalScrollPosition + listBase.rowCount)
         {
             return null;
         }
         var item:Object = getItemAt(index);
     
         return listBase.itemToItemRenderer(item);
     }
     

Метод IAccessible для изменения выбора в компоненте, представленным этим AccessibilityImplementation.

Параметр childID всегда будет отличным от нуля. Этот метод всегда применяется к дочернему элементу, а не полному компоненту, выбором которого управляет Flash Player.

Параметр selFlag является битовым полем, состоящим из одной или более констант флага выбора, позволяющим клиенту MSAA указывать, как элемент, имеющий ссылку на childID, должен выбираться или получать фокус. Далее следуют описания констант флага выбора и информация, сообщаемая ими реализации специальных возможностей. На практике большинство реализаций этого метода в реализациях специальных возможностей, которые наследуются из класса Flex mx.accessibility.ListBaseAccImpl, игнорирует константу selFlag и вместо этого учитывает поведение компонента при выборе клавиатуры для обработки нескольких выборов.

Параметр selFlag может содержать или не содержать флаг SELFLAG_TAKEFOCUS. Если он содержит флаг, то необходимо установить фокус дочернего элемента на указанный childID и, если не присутствует также SELFLAG_EXTENDSELECTION, назначить этот дочерний элемент привязкой выбора. В противном случае фокус дочернего элемента и привязка выбора должны оставаться без изменений несмотря на то, что дополнительные флаги, представленные ниже, могут изменять выбор.

Параметр selFlag всегда будет содержать один из следующих четырех флажков, которые обозначают требуемый вид модификации выбора:

• SELFLAG_TAKESELECTION: Отмените любой существующий выбор и установите выбор для указанного childID.

• SELFLAG_EXTENDSELECTION: Вычислите диапазон дочерних элементов между (и включая) точкой привязки для выбора и указанным childID. Если SELFLAG_ADDSELECTION присутствует, добавьте все эти дочерние элементы к выбору. Если SELFLAG_REMOVESELECTION присутствует, удалите все эти дочерние элементы из выбора. Если отсутствует SELFLAG_ADDSELECTION или SELFLAG_REMOVESELECTION, все эти дочерние элементы должны принять состояние выбора точки привязки для выбора: если точка привязки для выбора выбрана, добавьте эти дочерние элементы к выбору, в противном случае удалите их из выбора.

• SELFLAG_ADDSELECTION (без SELFLAG_EXTENDSELECTION): Добавьте указанный childID к выбору.

• SELFLAG_REMOVESELECTION (без SELFLAG_EXTENDSELECTION): Удалите указанный childID из выбора.

Обратите внимание, что для не многократно выбираемого компонента, единственными действительными значениями параметра selFlag являются SELFLAG_TAKEFOCUS и SELFLAG_TAKESELECTION. Теоретически возможна поддержка SELFLAG_REMOVESELECTION для не многократно выбираемого компонента, позволяющего пользователю принудительно выбирать null, но на практике большинство не многократно выбираемых компонентов не действуют таким образом и клиенты MSAA не могут выполнить попытку этого типа операции.

При наличии флажков, которые кажутся недопустимыми, установите для errno значение E_INVALIDARG.

В заключение, учтите, что при вызове accSelect Flash Player обеспечивает для него наличие фокуса хоста (фокуса окна его приложения контейнера) и наличие фокуса у пользовательского компонента в Flash Player.

Параметры

Дополнительно

Связанные элементы API

override public function accSelect(selFlag:uint, childID:uint):void
     {
         
         var listBase:ListBase = ListBase(master);
         
         var index:uint = childID - 1;
         
         if (index >= 0 && index < listBase.dataProvider.length)
             listBase.selectedIndex = index;
     }
     

Метод MSAA для возвращения заданных по умолчанию действий компонента, представленного этим AccessibilityImplementation, или одного из его дочерних элементов.

Этот метод следует реализовывать только в том случае, если AccessibilityImplementation представляет элемент пользовательского интерфейса, имеющий действие по умолчанию в модели MSAA. Убедитесь, что возвращена именно та строка, которую указывает модель MSAA. Например, строкой действия по умолчанию для компонента Button является «Press».

При реализации get_accDefaultAction только для AccessibilityImplementation или только для его дочерних элементов необходимо в некоторых случаях указать отсутствие действия по умолчанию для определенного childID, который был передан. Это выполняется возвращением значения null.

Параметры

Дополнительно

Связанные элементы API

override public function get_accDefaultAction(childID:uint):String
     {
         if (childID == 0)
             return null;
     
         return "Double Click";
     }

Метод MSAA для возвращения идентификаторов целого числа без знака для дочернего элемента, при его наличии, имеющего дочерний фокус в компоненте. Если ни у одного дочернего элемента нет дочернего фокуса, метод возвращает нуль.

Дополнительно

Связанные элементы API

override public function get_accFocus():uint
     {
     var index:uint = ListBase(master).selectedIndex;
     
     return index >= 0 ? index + 1 : 0;
     }

Метод MSAA для возвращения имени компонента, представленного этим AccessibilityImplementation, или одного из его дочерних элементов.

В случае AccessibilityImplementation непосредственно (childID == 0), если этот метод не реализован или не возвращает значение, Flash Player использует значение свойства AccessibilityProperties.name при его наличии.

Для AccessibilityImplementation, у которого могут быть дочерние элементы, этот метод должен быть реализован и должен возвратить строковое значение при childID отличном от нуля.

В зависимости от типа элемента интерфейса пользователя имена в MSAA означают один из двух различных вариантов: назначенное автором имя или фактическое содержимое текста элемента. Обычно AccessibilityImplementation будет относиться к прежней категории. Его свойство name представляет имя, назначенное автором. Дочерние элементы всегда относятся ко второй категории. Их имена обозначают содержимое их текста.

Когда свойство name у AccessibilityImplementation имеет значение назначенного автором имени, компоненты могут получить имена от авторов двумя способами. Первый способ определяет имена, существующие непосредственно в компоненте; например, компонент флажка может включить метку текста в качестве имени. Второй способ, который является резервным для первого способа, определяет имена, указанные в пользовательском интерфейсе и заканчивающиеся в AccessibilityProperties.name. Этот резервный способ позволяет пользователям указывать имена аналогично тому, как они указываются для любого другого Sprite или MovieClip.

Таким образом, непосредственно для AccessibilityImplementation (childID == zero) существует три возможности:

• Назначенное автором имя в компоненте Метод get_accName должен быть реализован и должен возвратить строковое значение, которое содержит имя AccessibilityImplementation при childID равном нулю. Если childID равен нулю, но у AccessibilityImplementation отсутствует имя, get_accName должен возвратить пустую строку, чтобы предотвратить обращение проигрывателя к свойству AccessibilityProperties.name.

• Назначенное автором имя из пользовательского интерфейса Если у AccessibilityImplementation могут быть дочерние элементы, метод get_accName должен быть реализован, но не должен возвращать значение при childID равном нулю. Если AccessibilityImplementation никогда не будет содержать дочерние элементы, то не следует реализовывать метод get_accName.

• Имя, обозначающее содержимое Метод get_accName должен быть реализован и должен возвратить соответствующее строковое значение при childID равном нулю. Если childID равен нулю, но у AccessibilityImplementation отсутствует содержимое, get_accName должен возвратить пустую строку, чтобы предотвратить обращение проигрывателя к свойству AccessibilityProperties.name.

Обратите внимание, что для дочерних элементов (при их наличии у AccessibilityImplementation) всегда применяется третий способ. Метод get_accName должен быть реализован и должен возвратить соответствующее строковое значение при childID отличном от нуля.

Параметры

Дополнительно

Связанные элементы API

override public function get_accName(childID:uint):String
     {
         // Start with the name of the component's parent form 
          // if the component is contained within a form
         var accName:String = UIComponentAccImpl.getFormName(master);
     
         // If the element requested is the component itself, 
         // append the value of any assigned accessibilityProperties.name    
         if (childID == 0 && master.accessibilityProperties 
             && master.accessibilityProperties.name 
                 && master.accessibilityProperties.name != "")
             accName += master.accessibilityProperties.name + " ";
     
         // Append the value of the childIDs name 
     // returned by the component-specific override 
     // of the mx.accessibility.AccImpl.getName() utility function,
         // and append the component's status returned by the 
     // component-specific override of the 
     // mx.accessibility.AccImpl.getStatusName() utility function
         accName += getName(childID) + getStatusName();
     
     // Return the assembled String if it is neither empty nor null, 
     // otherwise return null
         return (accName != null && accName != "") ? accName : null;
     }

Метод MSAA для возвращения системной роли компонента, представленного этим AccessibilityImplementation, или одного из его дочерних элементов. Системные роли предопределены для всех компонентов в MSAA.

Параметры

Дополнительно

Связанные элементы API

Метод MSAA для возвращения массива, содержащего идентификаторы всех выбранных дочерних элементов. Возвращенный массив может содержать нуль, один или больше идентификаторов, все из которых являются целыми числами без знака.

Дополнительно

Связанные элементы API

     override public function get_accSelection():Array
     {
         var accSelection:Array = [];
     
         var selectedIndices:Array = ListBase(master).selectedIndices;
         
         var n:int = selectedIndices.length;
         for (var i:int = 0; i < n; i++)
         {
             accSelection[i] = selectedIndices[i] + 1;
         }
         
         return accSelection;
     }
     

Метод IAccessible для возвращения текущего состояния времени выполнения компонента, представленного этим AccessibilityImplementation, или одного из его дочерних элементов.

Этот метод должен возвратить сочетание нуля, одной или более предопределенных констант состояния объекта для компонентов в MSAA. При применении более одного состояния константы состояния должны быть объединены в битовое поле с использованием побитового оператора ИЛИ (|).

Для обозначения того, что ни одна из констант состояния в данное время не применяется, этот метод должен возвратить нуль.

Состояния STATE_SYSTEM_FOCUSABLE или STATE_SYSTEM_FOCUSED не требуется отслеживать или записывать. Flash Player обрабатывает эти состояния автоматически.

Параметры

Дополнительно

Связанные элементы API

     override public function get_accState(childID:uint):uint
     {
         var accState:uint = getState(childID);
     
         if (childID > 0) 
         {
             var listBase:ListBase = ListBase(master);
     
             var index:uint = childID - 1;
     
             // For returning states (OffScreen and Invisible)
             // when the list Item is not in the displayed rows.
             if (index < listBase.verticalScrollPosition ||
                 index >= listBase.verticalScrollPosition + listBase.rowCount)
             {
                 accState |= (STATE_SYSTEM_OFFSCREEN |
                              STATE_SYSTEM_INVISIBLE);
             }
             else
             {
                 accState |= STATE_SYSTEM_SELECTABLE;
     
                 var item:Object = getItemAt(index);
     
                 var renderer:IListItemRenderer =
                     listBase.itemToItemRenderer(item);
     
                 if (renderer != null && listBase.isItemSelected(renderer.data))
                     accState |= STATE_SYSTEM_SELECTED | STATE_SYSTEM_FOCUSED;
             }
         }
     
         return accState;
     }

Метод MSAA для возвращения значения времени выполнения компонента, представленного этим AccessibilityImplementation, или одного из его дочерних элементов.

Этот метод следует реализовывать только в том случае, если AccessibilityImplementation представляет элемент пользовательского интерфейса, имеющий значение в модели MSAA. Следует учесть, что некоторые элементы пользовательского интерфейса, имеющие очевидное «значение», предоставляют это значение различными средствами, такими как get_accName ( например, текст), get_accState (например, флажки) или get_accSelection (например, поля списка).

При реализации get_accValue только для AccessibilityImplementation или только для его дочерних элементов необходимо в некоторых случаях указать отсутствие понятие значения для определенного childID, который был передан. Это выполняется возвращением значения null.

Параметры

Дополнительно

Связанные элементы API

override public function get_accValue(childID:uint):String
     {
         var accValue:String;
         
         var listBase:ListBase = ListBase(master);
         
         var index:int = listBase.selectedIndex;
         if (childID == 0)
         {
             if (index > -1)
             {
                 var item:Object = getItemAt(index);
     
                 if (item is String)
                 {
                     accValue = item + " " + (index + 1) + " of " + listBase.dataProvider.length;
                 }
                 else
                 {
                     accValue = listBase.itemToLabel(item) + " " + (index + 1) +
                                " of " + listBase.dataProvider.length;
                 }
             }
         }
     
         return accValue;
     }

Возвращает массив, содержащий идентификаторы целого числа без знака для всех дочерних элементов в AccessibilityImplementation.

Длина массива может быть нулевой. Идентификаторы в массиве должны появляться в том же логическом порядке, что и представляемые ими дочерние элементы. Если AccessibilityImplementation может содержать дочерние элементы, то этот метод обязателен; в противном случае не следует его реализовывать.

При назначении дочерних идентификаторов пользовательским дочерним элементам используйте любую схему, которая сохраняет уникальность в пределах каждого экземпляра пользовательского AccessibilityImplementation. Дочерние идентификаторы не должны быть смежными, и для их упорядочения не требуется соответствие логическому упорядочению дочерних элементов. Дочерние идентификаторы не должны использоваться многократно: при удалении дочернего элемента его идентификатор никогда не должен использоваться снова в период существования этого экземпляра AccessibilityImplementation. Следует учесть, что ввиду различных вариантов реализации в коде Flash Player возможны нежелательные варианты поведения при использовании дочерних идентификаторов, число которых превышает один миллион.

     override public function getChildIDArray():Array
     {
         var childIDs:Array = [];
     
         if (ListBase(master).dataProvider)
         {
             var n:uint = ListBase(master).dataProvider.length;
             for (var i:int = 0; i < n; i++)
             {
                 childIDs[i] = i + 1;
             }
         }
         return childIDs;
     }
     

Возвращает значение true или false, чтобы указать, должен ли текстовый объект с ограничительной рамкой, определенной свойствами x, y, width и height, рассматриваться как метка для компонента, представленного данным экземпляром AccessibilityImplementation.

Координаты x и y определяются относительно верхнего левого угла компонента, к которому применяется экземпляр AccessibilityImplementation, и могут быть отрицательными. Все координаты находятся в пределах области uint пикселов рабочей области.

Этот метод позволяет сделать доступные компоненты пригодными для поиска отношений автоматической пометки во Flash Player, которые позволяют использовать внешний текст (по отношению к объекту) в качестве источника имени объекта. Данный метод необходим, потому что критерии распознавания меток могут варьироваться в зависимости от компонента. Если реализуется этот метод, необходимо ориентироваться на геометрические критерии, подобные используемым в коде проигрывателя для кнопок и текстовых полей. Эти критерии перечислены ниже.

• Для кнопок любой текст, который полностью помещается на кнопке, считается меткой.
• Для текстовых полей любой текст, который находится над текстовым полем и выровнен по левому краю или находится слева от него, считается меткой.

Если компонент, который представлен экземпляром AccessibilityImplementation, никогда не должен участвовать в автоматических отношениях пометки, для него не следует реализовывать isLabeledBy. Так как при этом всегда будет возвращаться значение false. Например, isLabeledBy не следует внедрять, когда экземпляр AccessibilityImplementation рассматривается как «назначенное автором имя в компоненте» (этот случай рассматривался в разделе get_accName выше.

Обратите внимание, что этот метод не основан на методах класса IAccessible и используется только для Flash.

Параметры