Пакет | mx.controls |
Класс | public class FlexNativeMenu |
Наследование | FlexNativeMenu EventDispatcher Object |
Реализует | ILayoutManagerClient, IFlexContextMenu, IAutomationObject |
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Как и в случае с другими компонентами меню Flex для определения структуры меню, представляемой компонентом FlexNativeMenu, создается поставщик данных, например иерархия XML или массив объектов, содержащий данные, которые будут использоваться для определения меню. Для определения метода интерпретации данных поставщика данных можно установить несколько свойств, например свойство labelField
, указывающее поле данных, используемое для метки элемента меню, свойство keyEquivalentField
, указывающее поле, которое позволяет определить сочетание клавиш, эквивалентное элементу меню, и свойство mnemonicIndexField
, позволяющее указать поле, определяющее позицию индекса символа в метке, используемого в качестве горячих клавиш элемента меню.
С помощью поставщика данных элементов FlexNativeMenu можно указать несколько атрибутов, определяющих способ отображения элемента и его поведение, представленных в примере для следующего поставщика данных XML:
<mx:XML format="e4x" id="myMenuData"> <root> <menuitem label="MenuItem A"> <menuitem label="SubMenuItem A-1" enabled="False"/> <menuitem label="SubMenuItem A-2"/> </menuitem> <menuitem label="MenuItem B" type="check" toggled="true"/> <menuitem label="MenuItem C" type="check" toggled="false"/> <menuitem type="separator"/> <menuitem label="MenuItem D"> <menuitem label="SubMenuItem D-1"/> <menuitem label="SubMenuItem D-2"/> <menuitem label="SubMenuItem D-3"/> </menuitem> </root> </mx:XML>
В следующей таблице приведены атрибуты, которые можно указать, типы их данных, их назначение, а также способ их отображения поставщиком данных при использовании класса DefaultDataDescriptor в меню для анализа поставщика данных:
Атрибут | Тип | Описание |
---|---|---|
altKey
| Логическое значение | Указывает, должна ли клавиша Alt являться частью сочетания клавиш для элемента. |
cmdKey
| Логическое значение |
Примечание. Обработка этого атрибута осуществляется, начиная с версии Flex 3.2. Вместо этого используйте commandKey . Указывает, должна ли клавиша Command являться частью сочетания клавиш для элемента. |
commandKey
| Логическое значение | Указывает, должна ли клавиша Command являться частью сочетания клавиш для элемента. |
controlKey
| Логическое значение | Указывает, должна ли клавиша Ctrl являться частью сочетания клавиш для элемента. |
ctrlKey
| Логическое значение |
Примечание. Обработка этого атрибута осуществляется, начиная с версии Flex 3.2. Вместо этого используйте controlKey . Указывает, должна ли клавиша Ctrl являться частью сочетания клавиш для элемента. |
включено
| Логическое значение | Указывает, может ли пункт меню быть выбран пользователем (true ) или нет (false ). Если значение не указано, элемент обрабатывается так, как если бы имел значение true . При применении дескриптора данных по умолчанию для указания этой характеристики поставщиками данных должен использоваться атрибут XML enabled или поле объекта. |
keyEquivalent
| Строка | Указывает символ на клавиатуре, при нажатии которого событие инициируется таким же образом, как если бы был выбран пункт меню. Свойство меню keyEquivalentField или keyEquivalentFunction определяет имя поля в составе данных, указывающего эквивалентную клавишу или функцию для определения эквивалентных клавиш. (Если поставщик данных имеет формат XML E4X, для присвоения эквивалентных клавиш необходимо задать одно из этих свойств.) |
label
| Строка | Задает текст, отображаемый в элементе управления. Этот элемент используется для всех типов пунктов меню, за исключением separator . Свойство меню labelField или labelFunction определяет имя поля в составе данных, указывающего метку или функцию для определения меток. (Если поставщик данных имеет формат XML E4X, для отображения метки необходимо задать одно из этих свойств.) Если поставщиком данных является массив из строк, в качестве метки используется строковое значение. |
mnemonicIndex
| Целое | Указывает позицию индекса для символа в метке, используемого в качестве горячей клавиши для элемента меню. Свойство меню mnemonicIndexField или mnemonicIndexFunction определяет имя поля в составе данных, указывающее мнемонический индекс или функцию для определения мнемонического индекса. (Если поставщик данных имеет формат XML E4X, для определения мнемонического индекса в данных необходимо задать одно из этих свойств.) В качестве альтернативы, для указания на то, что символ, входящий в состав метки, является горячей клавишей элемента меню, необходимо добавить знак подчеркивания слева от этого символа. |
shiftKey
| Логическое значение | Указывает, должна ли клавиша Shift являться частью сочетания клавиш для элемента. |
toggled
| Логическое значение | Указывает, был ли установлен флажок. Если значение не указано, элемент обрабатывается так, как если бы было установлено значение false и элемент не был выбран. При использовании дескриптора данных по умолчанию для указания этой характеристики в поставщиках данных необходимо применять атрибут XML toggled или поле объекта. |
type
| Строка | Указывает тип пункта меню. Допустимыми значениями являются separator и check . Все другие значения или узлы без указания типа обрабатываются как обычные пункты меню. При использовании дескриптора данных по умолчанию для указания этой характеристики в поставщиках данных необходимо применять атрибут XML type или поле объекта. |
Для создания меню окна установите FlexNativeMenu в качестве свойства menu
экземпляра Window или WindowedApplication, в котором должно появляться меню. Для создания меню приложения установите FlexNativeMenu в качестве свойства menu
приложения WindowedApplication. В целях присвоения объекта FlexNativeMenu в качестве контекстного меню для части пользовательского интерфейса вызовите метод setContextMenu()
для экземпляра FlexNativeMenu, передав объект пользовательского интерфейса в качестве аргумента. Вызовите метод display()
компонента FlexNativeMenu для отображения меню в качестве всплывающего меню в любой области одного из окон приложения.
Для обнаружения времени инициирования команд элементов меню зарегистрируйте прослушиватель для события itemClick
. Также можно зарегистрировать прослушиватель для события menuShow
, определяющего открытие любого меню или подменю.
The <mx:FlexNativeMenu>
tag supports the following tag attributes:
<mx:FlexNativeMenu Properties dataDescriptor="mx.controls.treeClasses.DefaultDataDescriptor" dataProvider="undefined" keyEquivalentField="keyEquivalent" keyEquivalentFunction="undefined" keyEquivalentModifiersFunction="undefined" labelField="label" labelFunction="undefined" mnemonicIndexField="mnemonicIndex" mnemonicIndexFunction="undefined" showRoot="true" Events itemClick="No default" menuShow="No default" />
Связанные элементы API
Свойство | Определено | ||
---|---|---|---|
automationDelegate : Object
Объект-делегат, выполняющий обработку функций, связанных с автоматизацией. | FlexNativeMenu | ||
automationEnabled : Boolean [только для чтения]
Значение true, если этот компонент доступен для автоматизации; в противном случае – false. | FlexNativeMenu | ||
automationName : String
Имя, которое можно использовать в качестве идентификатора этого объекта. | FlexNativeMenu | ||
automationOwner : DisplayObjectContainer
Владелец этого компонента в целях автоматизации. | FlexNativeMenu | ||
automationParent : DisplayObjectContainer
Вышестоящий элемент этого компонента в целях автоматизации. | FlexNativeMenu | ||
automationTabularData : Object [только для чтения]
Реализация интерфейса IAutomationTabularData, который можно использовать для извлечения данных. | FlexNativeMenu | ||
automationValue : Array [только для чтения]
Это значение, как правило, соответствует отображению объекта и может быть удобным для соотнесения идентификатора с объектом, поскольку отображено в приложении. | FlexNativeMenu | ||
automationVisible : Boolean [только для чтения]
Значение true, если этот компонент является видимым для автоматизации; в противном случае – false. | FlexNativeMenu | ||
constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | ||
dataDescriptor : IMenuDataDescriptor
Объект, обеспечивающий доступ к данным и управление ими в поставщике данных. | FlexNativeMenu | ||
dataProvider : Object
Иерархия объектов, используемых для определения структуры пунктов меню в NativeMenu. | FlexNativeMenu | ||
hasRoot : Boolean [только для чтения]
Флаг, который указывает, что текущий поставщик данных имеет корневой узел; например, отдельный узел верхнего уровня в иерархической структуре. | FlexNativeMenu | ||
initialized : Boolean
Флаг, определяющий, прошел ли объект все три фазы создания макета: обязательство, измерение и создание макета (при условии, что все они требовались). | FlexNativeMenu | ||
keyEquivalentField : String
Имя поля в поставщике данных, определяющее эквивалентную клавишу для каждого элемента меню. | FlexNativeMenu | ||
keyEquivalentFunction : Function
Функция, определяющая эквивалентные клавиши для каждого элемента меню. | FlexNativeMenu | ||
keyEquivalentModifiersFunction : Function
Функция, определяющая модификаторы эквивалентных клавиш для каждого пункта меню. | FlexNativeMenu | ||
labelField : String
Имя поля в поставщике данных, определяющего текст, который должен отображаться для каждого элемента меню. | FlexNativeMenu | ||
labelFunction : Function
Функция, определяющая текст, который должен отображаться для каждого пункта меню. | FlexNativeMenu | ||
mnemonicIndexField : String
Имя поля в поставщике данных, определяющее мнемонический индекс для каждого пункта меню. | FlexNativeMenu | ||
mnemonicIndexFunction : Function
Функция, определяющая мнемонический индекс для каждого элемента меню. | FlexNativeMenu | ||
nativeMenu : NativeMenu [только для чтения]
Возвращает элемент flash.display.NativeMenu, управляемый этим объектом, или null, если такой элемент отсутствует. | FlexNativeMenu | ||
nestLevel : int
Глубина этого объекта в иерархии включения. | FlexNativeMenu | ||
numAutomationChildren : int [только для чтения]
Число нижестоящих элементов автоматизации, содержащихся в этом контейнере. | FlexNativeMenu | ||
processedDescriptors : Boolean
Установлено на true после немедленного или отложенного создания нижестоящих элементов в зависимости от выполняемого действия. | FlexNativeMenu | ||
showInAutomationHierarchy : Boolean
Флаг, который определяет, показан ли объект автоматизации в иерархии автоматизации. | FlexNativeMenu | ||
showRoot : Boolean
Логический флаг, указывающий, отобразить ли корневой узел поставщика данных. | FlexNativeMenu | ||
updateCompletePendingFlag : Boolean
Флаг, определяющий, прошел ли объект все три фазы проверки макета (при условии, что все они требовались). | FlexNativeMenu |
Метод | Определено | ||
---|---|---|---|
Конструктор. | FlexNativeMenu | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | EventDispatcher | ||
Возвращает набор свойств, которые идентифицируют нижестоящий элемент в рамках этого контейнера. | FlexNativeMenu | ||
Возвращает набор свойств, которые идентифицируют нижестоящий элемент в рамках этого контейнера. | FlexNativeMenu | ||
Посылает событие в поток событий. | EventDispatcher | ||
Добавляет раскрывающееся меню в заданном положении. | FlexNativeMenu | ||
Предоставляет объект автоматизации с указанным индексом. | FlexNativeMenu | ||
Обеспечивает список объектов автоматизации. | FlexNativeMenu | ||
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | EventDispatcher | ||
Показывает, определено ли заданное свойство для объекта. | Object | ||
Отмечает компонент с целью вызова его метода commitProperties() во время последующего обновления экрана. | FlexNativeMenu | ||
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | ||
Показывает наличие заданного свойства и его перечисляемость. | Object | ||
Удаляет прослушиватель из объекта EventDispatcher. | EventDispatcher | ||
Воспроизводит указанное событие. | FlexNativeMenu | ||
Определяет нижестоящий элемент с помощью предоставленного идентификатора. | FlexNativeMenu | ||
Устанавливает контекстное меню элемента InteractiveObject для основного собственного меню. | FlexNativeMenu | ||
Задает доступность динамического свойства для операций цикла. | Object | ||
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | ||
Возвращает строковое представление заданного объекта. | Object | ||
Обеспечивает сброс контекстного меню элемента InteractiveObject, установленного для основного собственного меню. | FlexNativeMenu | ||
Проверяет правильность расположения и размера нижестоящих элементов и отображает различные визуальные эффекты. | FlexNativeMenu | ||
Проверяет и обновляет свойства и макет этого объекта, а также перерисовывает его в случае необходимости. | FlexNativeMenu | ||
Проверяет правильность свойств компонента. | FlexNativeMenu | ||
Проверяет правильность измеренного размера компонента. Если совместно с данным IlayoutManagerClient вызван метод LayoutManager.invalidateSize(), то при измерении будет вызван метод validateSize(). | FlexNativeMenu | ||
Возвращает элементарное значение заданного объекта. | Object | ||
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | EventDispatcher |
Метод | Определено | ||
---|---|---|---|
Обрабатывает свойства, установленные в компоненте. | FlexNativeMenu | ||
Возвращает эквивалентную клавишу для заданного объекта данных на основе свойств keyEquivalentField и keyEquivalentFunction. | FlexNativeMenu | ||
Возвращает модификаторы эквивалентных клавиш для заданного объекта данных на основе свойства keyEquivalentModifiersFunction. | FlexNativeMenu | ||
Возвращает строку, которая должна использоваться в качестве метки элемента меню для заданного объекта данных на основе свойств labelField и labelFunction. | FlexNativeMenu | ||
Возвращает мнемонический индекс для заданного объекта данных на основе свойств mnemonicIndexField и mnemonicIndexFunction. | FlexNativeMenu | ||
Обеспечивает извлечение мнемонического индекса из метки на основе наличия символа подчеркивания. | FlexNativeMenu | ||
Определяет фактическую метку, которая должна использоваться для элемента NativeMenuItem путем удаления символов подчеркивания и преобразования уцелевших символов подчеркивания, если таковые существуют. | FlexNativeMenu |
Событие | Сводка | Определено | ||
---|---|---|---|---|
[многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR перемещается в фокус операционной системы и становится активным. | EventDispatcher | |||
[многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR теряет фокус системы и становится неактивным. | EventDispatcher | |||
Передается при выборе пункта меню. | FlexNativeMenu | |||
Передается перед отображением меню или подменю. | FlexNativeMenu |
automationDelegate | свойство |
automationDelegate:Object
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Объект-делегат, выполняющий обработку функций, связанных с автоматизацией.
Реализация
public function get automationDelegate():Object
public function set automationDelegate(value:Object):void
automationEnabled | свойство |
automationName | свойство |
automationOwner | свойство |
automationOwner:DisplayObjectContainer
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Владелец этого компонента в целях автоматизации.
Реализация
public function get automationOwner():DisplayObjectContainer
public function set automationOwner(value:DisplayObjectContainer):void
automationParent | свойство |
automationParent:DisplayObjectContainer
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Вышестоящий элемент этого компонента в целях автоматизации.
Реализация
public function get automationParent():DisplayObjectContainer
public function set automationParent(value:DisplayObjectContainer):void
automationTabularData | свойство |
automationValue | свойство |
automationValue:Array
[только для чтения] Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Это значение, как правило, соответствует отображению объекта и может быть удобным для соотнесения идентификатора с объектом, поскольку отображено в приложении.
Реализация
public function get automationValue():Array
automationVisible | свойство |
dataDescriptor | свойство |
dataDescriptor:IMenuDataDescriptor
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Объект, обеспечивающий доступ к данным и управление ими в поставщике данных. Элемент управления FlexNativeMenu выполняет делегирование в дескриптор данных для получения информации о его данных. Затем эти данные используются для анализа и перемещения источника данных. Дескриптор данных, определенный для FlexNativeMenu, используется во всех нижестоящих меню и подменю.
При указании этого свойства в качестве атрибута в MXML необходимо использовать ссылку на дескриптор данных, а не на имя строки дескриптора. Для установки свойства применяйте следующий формат:
<mx:FlexNativeMenu id="flexNativeMenu" dataDescriptor="{new MyCustomDataDescriptor()}"/>
В качестве альтернативы, в MXML свойство может быть указано в качестве вложенного подтега, как представлено в примере:
<mx:FlexNativeMenu> <mx:dataDescriptor> <myCustomDataDescriptor> </mx:dataDescriptor> ...
Значением по умолчанию является внутренний экземпляр класса DefaultDataDescriptor.
Реализация
public function get dataDescriptor():IMenuDataDescriptor
public function set dataDescriptor(value:IMenuDataDescriptor):void
dataProvider | свойство |
dataProvider:Object
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Иерархия объектов, используемых для определения структуры пунктов меню в NativeMenu. Отдельные объекты данных, определяющие элементы меню, и элементы с нижестоящими элементами становятся меню и подменю.
Обработка исходного объекта данных элементом управления FlexNativeMenu осуществляется следующим образом:
- Строка, содержащая допустимый текст XML, преобразуется в объект XML.
- XMLNode преобразуется в объект XML.
- XMLList преобразуется в XMLListCollection.
- Любой объект, реализующий интерфейс ICollectionView, приводится к ICollectionView.
- Массив преобразуется в ArrayCollection.
- Объект другого типа включается в массив, причем объект становится единственной записью.
Значением по умолчанию является "undefined".
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие collectionChange
.
Реализация
public function get dataProvider():Object
public function set dataProvider(value:Object):void
hasRoot | свойство |
hasRoot:Boolean
[только для чтения] Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Флаг, который указывает, что текущий поставщик данных имеет корневой узел; например, отдельный узел верхнего уровня в иерархической структуре. XML и Object являются примерами типов, которые имеют корневой узел, тогда как списки и массивы – нет.
Реализация
public function get hasRoot():Boolean
initialized | свойство |
initialized:Boolean
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Флаг, определяющий, прошел ли объект все три фазы создания макета: обязательство, измерение и создание макета (при условии, что все они требовались).
Реализация
public function get initialized():Boolean
public function set initialized(value:Boolean):void
keyEquivalentField | свойство |
keyEquivalentField:String
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Имя поля в поставщике данных, определяющее эквивалентную клавишу для каждого элемента меню. Набор значений определяется в классе Keyboard, в константах KEYNAME_XXXX
. Обратитесь к списку значений управляющего символа, например Home, Insert и т. д.
Установка свойства keyEquivalentFunction
приведет к игнорированию данного свойства.
Значением по умолчанию является "keyEquivalent".
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие keyEquivalentChanged
.
Реализация
public function get keyEquivalentField():String
public function set keyEquivalentField(value:String):void
Связанные элементы API
keyEquivalentFunction | свойство |
keyEquivalentFunction:Function
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Функция, определяющая эквивалентные клавиши для каждого элемента меню. Если это свойство опускается, в программе Flex используется содержимое поля или атрибута, определенное при помощи свойства keyEquivalentField
. При указании данного свойства игнорируются все значения свойства keyEquivalentField
.
Свойство keyEquivalentFunction
подходит для обработки форматирования, локализации и независимости платформы.
Функция эквивалента клавиши должна принимать отдельный аргумент, являющийся элементом поставщика данных, и возвращать строку.
myKeyEquivalentFunction(item:Object):String
Значением по умолчанию является "undefined".
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие keyEquivalentFunctionChanged
.
Реализация
public function get keyEquivalentFunction():Function
public function set keyEquivalentFunction(value:Function):void
Связанные элементы API
keyEquivalentModifiersFunction | свойство |
keyEquivalentModifiersFunction:Function
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Функция, определяющая модификаторы эквивалентных клавиш для каждого пункта меню. Если это свойство опускается, в программе Flex применяется собственная функция по умолчанию, позволяющая определить массив модификаторов путем поиска данных в поставщике данных со следующими (логическими) полями: altKey
, commandKey
, controlKey
и shiftKey
.
Свойство keyEquivalentModifiersFunction
подходит для обработки форматирования, локализации и независимости платформы.
Функция модификаторов эквивалентных клавиш должна принимать отдельный аргумент, являющийся элементом поставщика данных, и возвращать массив имен модифицирующих клавиш.
myKeyEquivalentModifiersFunction(item:Object):Array
Значением по умолчанию является "undefined".
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие keyEquivalentModifiersFunctionChanged
.
Реализация
public function get keyEquivalentModifiersFunction():Function
public function set keyEquivalentModifiersFunction(value:Function):void
labelField | свойство |
labelField:String
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Имя поля в поставщике данных, определяющего текст, который должен отображаться для каждого элемента меню. Если поставщиком данных является массив строк, каждое строковое значение используется в качестве метки. Если поставщиком данных является объект XML E4X, необходимо явным образом установить это свойство. Например, если каждый элемент XML объекта XML E4X включает атрибут «метка», содержащий текст, который должен отображаться для каждого элемента меню, установите значение @label
для свойства labelField.
Для указания символа, который должен использоваться в качестве мнемонического индекса, в метке необходимо добавить знак подчеркивания перед ним. Например, значение метки C_ut
устанавливает мнемонический индекс 1. С этой целью используется только первый символ подчеркивания. Для отображения точного символа подчеркивания в метке этого можно избежать путем установки двойного подчеркивания. Например, установка значения метки C__u_t
приведет к созданию пункта меню с меткой C_ut и мнемоническим индексом 3 (символ t). Если поле, определенное в свойстве mnemonicIndexField
, существует и имеет значение, отличное от нуля, это значение имеет приоритет над любым значением мнемонического индекса, указанного с помощью знаков подчеркивания.
Установка свойства labelFunction
приводит к игнорированию этого свойства.
Значением по умолчанию является "label".
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие labelFieldChanged
.
Реализация
public function get labelField():String
public function set labelField(value:String):void
labelFunction | свойство |
labelFunction:Function
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Функция, определяющая текст, который должен отображаться для каждого пункта меню. Функция метки должна обеспечивать поиск соответствующего поля или полей в поставщике данных и возвращение отображаемой строки.
Если это свойство опускается, в программе Flex применяется содержимое поля или атрибута, определенное с помощью свойства labelField
. Установка данного свойства приводит к игнорированию любого значения свойства labelField.
Свойство labelFunction
может быть полезным при обработке форматирования, локализации и автономности платформы.
Функция метки должна принимать отдельный аргумент, являющийся элементом поставщика данных, и возвращать строку.
myLabelFunction(item:Object):String
Значением по умолчанию является "undefined".
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие labelFunctionChanged
.
Реализация
public function get labelFunction():Function
public function set labelFunction(value:Function):void
mnemonicIndexField | свойство |
mnemonicIndexField:String
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Имя поля в поставщике данных, определяющее мнемонический индекс для каждого пункта меню.
Если поле, определенное с помощью этого свойства, содержит положительное число, этот мнемонический индекс имеет приоритет над любым индексом, указанным с использованием символа подчеркивания.
Установка свойства mnemonicIndexFunction
приводит к игнорированию этого свойства.
Значением по умолчанию является "mnemonicIndex".
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие mnemonicIndexChanged
.
Реализация
public function get mnemonicIndexField():String
public function set mnemonicIndexField(value:String):void
Связанные элементы API
mnemonicIndexFunction | свойство |
mnemonicIndexFunction:Function
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Функция, определяющая мнемонический индекс для каждого элемента меню.
Если это свойство опускается, в программе Flex используется содержимое поля или атрибута, указанного в свойстве mnemonicIndexField
. Указание этого свойства приводит к игнорированию любого значения свойства mnemonicIndexField
.
Если это свойство определено и для элемента данных функция возвращает положительное число, возвращаемый мнемонический индекс имеет приоритет над любым индексом, определенным с помощью подчеркивания в метке.
Свойство mnemonicIndexFunction
подходит для обработки форматирования, локализации и независимости платформы.
Функция мнемонического индекса должна принимать отдельный аргумент, являющийся элементом поставщика данных, и возвращать целое число.
myMnemonicIndexFunction(item:Object):int
Значением по умолчанию является "undefined".
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие mnemonicIndexFunctionChanged
.
Реализация
public function get mnemonicIndexFunction():Function
public function set mnemonicIndexFunction(value:Function):void
nativeMenu | свойство |
nativeMenu:NativeMenu
[только для чтения] Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Возвращает элемент flash.display.NativeMenu, управляемый этим объектом, или null, если такой элемент отсутствует. Любые изменения, вносимые непосредственно в экземпляр NativeMenu, могут быть потеряны при внесении изменений в меню или основного поставщика данных.
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие nativeMenuUpdate
.
Реализация
public function get nativeMenu():NativeMenu
nestLevel | свойство |
nestLevel:int
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Глубина этого объекта в иерархии включения. Это число используется кодом макета и измерения. Значение – 0, если этот компонент не находится в DisplayList.
Реализация
public function get nestLevel():int
public function set nestLevel(value:int):void
numAutomationChildren | свойство |
numAutomationChildren:int
[только для чтения] Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Число нижестоящих элементов автоматизации, содержащихся в этом контейнере. Эта сумма не должна включать составных нижестоящих элементов, хотя включает нижестоящие элементы, незначительные в иерархии автоматизации.
Реализация
public function get numAutomationChildren():int
processedDescriptors | свойство |
processedDescriptors:Boolean
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Установлено на true
после немедленного или отложенного создания нижестоящих элементов в зависимости от выполняемого действия. Для контейнерного объекта значение устанавливается на true
в конце метода createComponentsFromDescriptors()
, что предполагает, что контейнерный объект создает нижестоящие записи из собственных нижестоящих дескрипторов.
Например, если контейнер Accordion использует отложенную реализацию, свойство processedDescriptors
для второй панели контейнера Accordion не приобретает значение true
до перехода пользователя к этой панели и создания нижестоящих элементов самой панелью. Однако если контейнером Accordion установлено свойство creationPolicy
на all
, свойство processedDescriptors
для второй панели устанавливается на true
в течение запуска приложения.
Для классов, которые не являются контейнерами, не имеющими дескрипторы, свойство устанавливается на true
после того, как метод createChildren()
создаст любые внутренние нижестоящие элементы компонента.
Реализация
public function get processedDescriptors():Boolean
public function set processedDescriptors(value:Boolean):void
showInAutomationHierarchy | свойство |
showInAutomationHierarchy:Boolean
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Флаг, который определяет, показан ли объект автоматизации в иерархии автоматизации. Нижестоящие элементы невидимых в иерархии контейнеров отображаются в качестве нижестоящих элементов следующего вышестоящего элемента. Обычно используемые для макета контейнеры, например поля и Canvas, не отображаются в иерархии.
Некоторые элементы управления при необходимости вызывают принудительное отображение нижестоящих элементов в иерархии. Например, для List в иерархии всегда будут принудительно отображаться средства визуализации элементов, в т.ч. поля. При реализации должно поддерживаться значение true
этого свойства.
Реализация
public function get showInAutomationHierarchy():Boolean
public function set showInAutomationHierarchy(value:Boolean):void
showRoot | свойство |
showRoot:Boolean
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Логический флаг, указывающий, отобразить ли корневой узел поставщика данных.
Если поставщик данных имеет корневой узел и свойство showRoot
имеет значение false
, элементы меню верхнего уровня, отображаемые при помощи элемента управления FlexNativeMenu, соответствуют непосредственным нижестоящим элементам корневого узла.
Этот флаг не влияет на источник без корневого узла, например на объекты списка или массива.
Значением по умолчанию является true.
Реализация
public function get showRoot():Boolean
public function set showRoot(value:Boolean):void
Связанные элементы API
updateCompletePendingFlag | свойство |
updateCompletePendingFlag:Boolean
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Флаг, определяющий, прошел ли объект все три фазы проверки макета (при условии, что все они требовались).
Реализация
public function get updateCompletePendingFlag():Boolean
public function set updateCompletePendingFlag(value:Boolean):void
FlexNativeMenu | () | Конструктор |
public function FlexNativeMenu()
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Конструктор.
commitProperties | () | метод |
protected function commitProperties():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Обрабатывает свойства, установленные в компоненте.
Связанные элементы API
createAutomationIDPart | () | метод |
public function createAutomationIDPart(child:IAutomationObject):Object
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Возвращает набор свойств, которые идентифицируют нижестоящий элемент в рамках этого контейнера. Эти значения не должны изменяться во время срока действия приложения.
Параметры
child:IAutomationObject — Нижестоящий элемент, для которого следует предоставить идентификатор.
|
Object — Наборы свойств, описывающих нижестоящий элемент, которые можно использовать в дальнейшем для определения компонента.
|
createAutomationIDPartWithRequiredProperties | () | метод |
public function createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Возвращает набор свойств, которые идентифицируют нижестоящий элемент в рамках этого контейнера. Эти значения не должны изменяться во время срока действия приложения.
Параметры
child:IAutomationObject — Нижестоящий элемент, для которого следует предоставить идентификатор.
| |
properties:Array |
Object — Наборы свойств, описывающих нижестоящий элемент, которые можно использовать в дальнейшем для определения компонента.
|
display | () | метод |
public function display(stage:Stage, x:int, y:int):void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Добавляет раскрывающееся меню в заданном положении.
Параметры
stage:Stage — Объект Stage, на котором будет отображаться данное меню.
| |
x:int — Число пикселей по горизонтали относительно начала рабочей области, на котором будет отображаться данное меню.
| |
y:int — Число пикселей по вертикали относительно начала рабочей области, на котором будет отображаться данное меню.
|
getAutomationChildAt | () | метод |
public function getAutomationChildAt(index:int):IAutomationObject
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Предоставляет объект автоматизации с указанным индексом. В этом списке не должно быть составных нижестоящих элементов.
Параметры
index:int — Индекс возвращаемого нижестоящего элемента.
|
IAutomationObject — Нижестоящий элемент с указанным индексом.
|
getAutomationChildren | () | метод |
invalidateProperties | () | метод |
public function invalidateProperties():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Отмечает компонент с целью вызова его метода commitProperties()
во время последующего обновления экрана.
Механизм недействительности позволяет исключить дублирование операций за счет задержки обработки изменений компонента до момента последующего обновления экрана. Например, при необходимости изменения цвета и размера текста нерационально обновлять цвет сразу после его изменения, а затем выполнять обновление размера после его установки. Более эффективным подходом является изменение обоих свойств с последующим выполнением визуализации текста с учетом изменений размера и текста.
Методы недействительности вызываются достаточно редко. Как правило, при установке свойств компонента задается автоматическое выполнение вызова соответствующего метода недействительности.
itemToKeyEquivalent | () | метод |
protected function itemToKeyEquivalent(data:Object):String
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Возвращает эквивалентную клавишу для заданного объекта данных на основе свойств keyEquivalentField
и keyEquivalentFunction
. Если методу не удается преобразовать параметр в строку, возвращается пустая строка.
Параметры
data:Object — Объект, который должен быть отображен.
|
String — Эквивалентная клавиша на основе данных.
|
itemToKeyEquivalentModifiers | () | метод |
protected function itemToKeyEquivalentModifiers(data:Object):Array
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Возвращает модификаторы эквивалентных клавиш для заданного объекта данных на основе свойства keyEquivalentModifiersFunction
. Если с помощью метода не удается преобразовать параметр в массив модификаторов, возвращается пустой массив.
Параметры
data:Object — Объект, который должен быть отображен.
|
Array — Массив модификаторов эквивалентных клавиш на основе данных.
|
itemToLabel | () | метод |
protected function itemToLabel(data:Object):String
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Возвращает строку, которая должна использоваться в качестве метки элемента меню для заданного объекта данных на основе свойств labelField
и labelFunction
. Если методу не удается преобразовать параметр в строку, возвращается одиночный знак пробела.
Параметры
data:Object — Объект, который должен быть отображен.
|
String — Строка, отображаемая в зависимости от данных.
|
itemToMnemonicIndex | () | метод |
protected function itemToMnemonicIndex(data:Object):int
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Возвращает мнемонический индекс для заданного объекта данных на основе свойств mnemonicIndexField
и mnemonicIndexFunction
. Если с помощью метода не удается преобразовать параметр в целое число, возвращается значение -1.
Параметры
data:Object — Объект, который должен быть отображен.
|
int — Мнемонический индекс на основе данных.
|
parseLabelToMnemonicIndex | () | метод |
protected function parseLabelToMnemonicIndex(data:String):int
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Обеспечивает извлечение мнемонического индекса из метки на основе наличия символа подчеркивания. Обеспечивает нахождение первого символа подчеркивания, если таковой существует, и его использование в качестве индекса.
Параметры
data:String — Анализируемые данные для индекса.
|
int — Индекс.
|
parseLabelToString | () | метод |
protected function parseLabelToString(data:String):String
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Определяет фактическую метку, которая должна использоваться для элемента NativeMenuItem путем удаления символов подчеркивания и преобразования уцелевших символов подчеркивания, если таковые существуют.
Параметры
data:String — Анализируемые данные для метки.
|
String — Метка.
|
replayAutomatableEvent | () | метод |
public function replayAutomatableEvent(event:Event):Boolean
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Воспроизводит указанное событие. Автор компонента должен вызвать super.replayAutomatableEvent в случае, если поведение воспроизведения по умолчанию определено в суперклассе.
Параметры
event:Event — Воспроизводимое событие.
|
Boolean — true при успешном воспроизведении.
|
resolveAutomationIDPart | () | метод |
public function resolveAutomationIDPart(criteria:Object):Array
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Определяет нижестоящий элемент с помощью предоставленного идентификатора. Этот идентификатор представляет собой набор свойств, предоставляемых методом createAutomationIDPart()
.
Параметры
criteria:Object — Набор свойств, описывающих нижестоящий элемент. Критерии могут содержать обычные значения выражений, которым могут соответствовать несколько нижестоящих элементов.
|
Array — Массив нижестоящих элементов, которые соответствуют критериям, или значение null , если соответствующие нижестоящие элементы не определены.
|
setContextMenu | () | метод |
public function setContextMenu(component:InteractiveObject):void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Устанавливает контекстное меню элемента InteractiveObject для основного собственного меню.
Параметры
component:InteractiveObject — Интерактивный объект.
|
unsetContextMenu | () | метод |
public function unsetContextMenu(component:InteractiveObject):void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Обеспечивает сброс контекстного меню элемента InteractiveObject, установленного для основного собственного меню.
Параметры
component:InteractiveObject — Интерактивный объект.
|
validateDisplayList | () | метод |
public function validateDisplayList():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Проверяет правильность расположения и размера нижестоящих элементов и отображает различные визуальные эффекты. Если совместно с ILayoutManagerClient вызван метод LayoutManager.invalidateDisplayList()
, то при обновлении списка отображения будет вызван методvalidateDisplayList()
.
validateNow | () | метод |
public function validateNow():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Проверяет и обновляет свойства и макет этого объекта, а также перерисовывает его в случае необходимости.
validateProperties | () | метод |
public function validateProperties():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Проверяет правильность свойств компонента. Если с данным IlayoutManagerClient вызван метод LayoutManager.invalidateProperties()
, то при отправке значений свойств будет вызван методvalidateProperties()
.
validateSize | () | метод |
public function validateSize(recursive:Boolean = false):void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Проверяет правильность измеренного размера компонента. Если совместно с данным IlayoutManagerClient вызван метод LayoutManager.invalidateSize()
, то при измерении будет вызван метод validateSize()
.
Параметры
recursive:Boolean (default = false ) — Если значение true , то необходимо вызвать этот метод для нижестоящих элементов объекта.
|
itemClick | Событие |
mx.events.FlexNativeMenuEvent
свойство FlexNativeMenuEvent.type =
mx.events.FlexNativeMenuEvent.ITEM_CLICK
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Передается при выборе пункта меню.
Константа типа события FlexNativeMenuEvent.ITEM_CLICK указывает на выбор пользователем какого-либо пункта меню.Свойства объекта события для этого типа события имеют следующие значения. Не все свойства являются значимыми для каждого из видов событий. Дополнительную информацию см. в подробных описаниях свойств.
Свойство | Значение |
---|---|
bubbles | false |
cancelable | true |
currentTarget | Объект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется myButton.addEventListener() для регистрации прослушивателя события, значением currentTarget является myButton. |
index | Индекс в меню для выбранного пункта меню. |
item | Выбранный элемент dataProvider. |
label | Текст метки для выбранного пункта меню. |
nativeMenu | Определенный экземпляр NativeMenu, связанный с этим событием. |
nativeMenuItem | Определенный экземпляр NativeMenuItem, связанный с этим событием. |
target | Объект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство currentTarget всегда используется для получения доступа к объекту, прослушивающему событие. |
type | FlexNativeMenuEvent.ITEM_CLICK |
menuShow | Событие |
mx.events.FlexNativeMenuEvent
свойство FlexNativeMenuEvent.type =
mx.events.FlexNativeMenuEvent.MENU_SHOW
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | AIR 1.1 |
Передается перед отображением меню или подменю.
Константа типа FlexNativeMenuEvent.MENU_SHOW указывает на использование указателя мыши для прокрутки меню или открытия подменю.Свойства объекта события для этого типа события имеют следующие значения. Не все свойства являются значимыми для каждого из видов событий. Дополнительную информацию см. в подробных описаниях свойств.
Свойство | Значение |
---|---|
bubbles | false |
cancelable | true |
currentTarget | Объект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется myButton.addEventListener() для регистрации прослушивателя события, значением currentTarget является myButton. |
index | -1. Данное свойство не устанавливается для этого типа события. |
item | null. Данное свойство не устанавливается для этого типа события. |
label | null. Данное свойство не устанавливается для этого типа события. |
nativeMenu | Определенный экземпляр NativeMenu, связанный с этим событием. |
nativeMenuItem | null. Данное свойство не устанавливается для этого типа события. |
target | Объект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство currentTarget всегда используется для получения доступа к объекту, прослушивающему событие. |
type | FlexNativeMenuEvent.MENU_SHOW |
Tue Jun 12 2018, 11:34 AM Z