Главная / Action Script 3
Пакетflash.ui
Классpublic final class ContextMenuItem
НаследованиеContextMenuItem Inheritance EventDispatcher Inheritance Object

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Класс ContextMenuItem используется для создания пользовательских элементов меню, отображаемых в контекстном меню проигрывателя Flash Player. Каждый объект ContextMenuItem имеет подпись (текст), который отображается в контекстом меню. Чтобы добавить новый элемент в контекстное меню, его нужно добавить в массив customItems объекта ContextMenu.

С помощью свойств класса ContextMenuItem можно включать или выключать определенные элементы меню, а также делать их видимыми или невидимыми.

Нужно записать обработчик для события menuItemSelect, чтобы добавить функцию для элемента меню, когда он выбирается пользователем.

Пользовательские элементы меню показываются в начале контекстного меню, над встроенными элементами. Разделительная полоса отделяет пользовательские элементы меню от встроенных.

Ограничения

Примечание. Когда проигрыватель работает не в англоязычной системе, строки подписей сравниваются и с английским списком и с локализованными эквивалентами.

Посмотреть примеры

См. также

Класс ContextMenu
Класс ContextMenuBuiltInItems


Общедоступные свойства
 СвойствоОпределено
  caption : String
Задает подпись (текст) элемента меню, отображаемую в контекстном меню.
ContextMenuItem
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
  enabled : Boolean
Показывает, включен или выключен заданный элемент меню.
ContextMenuItem
 Inheritedprototype : Object
[статические] Ссылка на модель объекта класса или функции.
Object
  separatorBefore : Boolean
Показывает, должен ли отображаться разделитель над заданным элементом меню.
ContextMenuItem
  visible : Boolean
Показывает, виден ли заданный элемент меню при отображении контекстного меню проигрывателя Flash Player.
ContextMenuItem
Общедоступные методы
 МетодОпределено
  
ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true)
Создает новый объект ContextMenuItem, который можно добавить в массив ContextMenu.customItems.
ContextMenuItem
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события в объекте EventDispatcher, в результате чего прослушиватель будет получать уведомления о событиях.
EventDispatcher
  
Создает и возвращает копию заданного объекта ContextMenuItem.
ContextMenuItem
 Inherited
Передает событие в поток событий.
EventDispatcher
 Inherited
Проверяет наличие у объекта EventDispatcher прослушивателей событий, которые зарегистрированы для получения уведомлений о событиях определенного типа.
EventDispatcher
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Удаляет прослушиватель из объекта EventDispatcher.
EventDispatcher
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
 Inherited
Возвращает строковое представление заданного объекта.
Object
 Inherited
Возвращает элементарное значение заданного объекта.
Object
 Inherited
Проверяет, зарегистрирован ли прослушиватель событий в объекте EventDispatcher или в любом из его предков для получения уведомлений о событиях определенного типа.
EventDispatcher
События
 Событие Сводка Определено
 Inherited[многоадресное событие] Отправляется, когда проигрыватель Flash Player перемещается в фокус операционной системы и становится активным.EventDispatcher
 Inherited[многоадресное событие] Отправляется, когда проигрыватель Flash Player покидает фокус операционной системы и становится неактивным.EventDispatcher
  Отправляется, когда пользователь выбирает элемент из контекстного меню.ContextMenuItem
Сведения о свойстве
captionсвойство
caption:String  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Задает подпись (текст) элемента меню, отображаемую в контекстном меню. Ограничения значений caption см. в описании класса ContextMenuItem.



Реализация
    public function get caption():String
    public function set caption(value:String):void
enabledсвойство 
enabled:Boolean  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Показывает, включен или выключен заданный элемент меню.

Значение по умолчанию true



Реализация
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
separatorBeforeсвойство 
separatorBefore:Boolean  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Показывает, должен ли отображаться разделитель над заданным элементом меню.

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

Значение по умолчанию false



Реализация
    public function get separatorBefore():Boolean
    public function set separatorBefore(value:Boolean):void
visibleсвойство 
visible:Boolean  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Показывает, виден ли заданный элемент меню при отображении контекстного меню проигрывателя Flash Player.

Значение по умолчанию true



Реализация
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Сведения о конструкторе
ContextMenuItem()Конструктор
public function ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true)

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Создает новый объект ContextMenuItem, который можно добавить в массив ContextMenu.customItems.

Параметры
caption:String — Задает текст, связанный с элементом меню. Ограничения значений caption см. в описании класса ContextMenuItem.
 
separatorBefore:Boolean (default = false) — Указывает, появляется ли разделитель над элементом контекстного меню. Значение по умолчанию равно false.
 
enabled:Boolean (default = true) — Указывает, включен или выключен элемент контекстного меню. Значение по умолчанию — true (включен). Этот параметр является необязательным.
 
visible:Boolean (default = true) — Указывает, является элемент меню видимым или невидимым. Значение по умолчанию — true (видимый).
Сведения о методе
clone()метод
public function clone():ContextMenuItem

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Создает и возвращает копию заданного объекта ContextMenuItem. Копия содержит все свойства исходного объекта.

Возвращает
ContextMenuItem — Объект ContextMenuItem, содержащий все свойства исходного объекта.
Сведения о событии
menuItemSelect Событие
Тип объекта события: flash.events.ContextMenuEvent
свойство ContextMenuEvent.type = flash.events.ContextMenuEvent.MENU_ITEM_SELECT

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Отправляется, когда пользователь выбирает элемент из контекстного меню. Пользователь генерирует контекстное меню, щелкнув второстепенной кнопкой указывающего устройства.

Определяет значение свойства type объекта события menuItemSelect.

Данное событие имеет следующие свойства.

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
contextMenuOwnerОбъект списка отображения, к которому присоединено меню.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
mouseTargetОбъект списка отображения, который пользователь щелкает правой кнопкой мыши для отображения контекстного меню.
targetВыбранный объект ContextMenuItem. Цель не всегда является объектом из списка отображения, для которого зарегистрирован прослушиватель событий. Используйте свойство currentTarget, чтобы обратиться к объекту в списке отображения, обрабатывающему событие в данный момент.
Примеры Как пользоваться примерами
ContextMenuItemExample.as

В следующем примере класс ContextMenuBuiltInItemsExample используется для удаления из рабочей области элементов контекстного меню по умолчанию и добавления нового элемента меню. Это можно сделать, выполнив следующие действия:
  1. Объявляется свойство myContextMenu, а затем назначается объекту ContextMenu.
  2. Вызывается метод removeDefaultItems(), который удаляет все встроенные элементы контекстного меню, кроме "Печать".
  3. Вызывается метод addCustomMenuItems(), который помещает элемент меню Hello World "Здравствуй мир!" в массив customItems с помощью метода push() объекта Array.
  4. Элемент контекстного меню Hello World добавляется в список элементов контекстного меню рабочей области.
  5. В рабочую область добавляется объект TextField с текстом "Right Click Here" (Щелкни здесь правой кнопкой).
package {
    import flash.ui.ContextMenu;
    import flash.ui.ContextMenuItem;
    import flash.ui.ContextMenuBuiltInItems;
    import flash.display.Sprite;
    import flash.text.TextField;

    public class ContextMenuItemExample extends Sprite {
        private var myContextMenu:ContextMenu;

        public function ContextMenuItemExample() {
            myContextMenu = new ContextMenu();
            removeDefaultItems();
            addCustomMenuItems();
            this.contextMenu = myContextMenu;
            addChild(createLabel());
        }

        private function removeDefaultItems():void {
            myContextMenu.hideBuiltInItems();

            var defaultItems:ContextMenuBuiltInItems = myContextMenu.builtInItems;
            defaultItems.print = true;
        }

        private function addCustomMenuItems():void {
            var item:ContextMenuItem = new ContextMenuItem("Hello World");
            myContextMenu.customItems.push(item);
        }
        
        private function createLabel():TextField {
            var txtField:TextField = new TextField();
            txtField.text = "Right Click Here";
            return txtField;
        }
    }
}