NativeMenu

Pacote	flash.display
Classe	public class NativeMenu
Herança	NativeMenu EventDispatcher Object
Subclasses	ContextMenu

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

A classe NativeMenu contém métodos e propriedades para definir menus nativos.

Suporte a perfil do AIR: este recurso conta com suporte em todos os sistemas operacionais para desktop, mas não é compatível com dispositivos móveis nem com dispositivos AIR for TV. Você pode testar o suporte que em tempo de execução utilizando a propriedadeNativeMenu.isSupported. Consulte Suporte a perfil do AIR para obter mais informações sobre o suporte de API através de múltiplos perfis.

Um menu nativo é um menu que é controlado e desenhado pelo sistema operacional em vez de ser pelo seu aplicativo. O AIR oferece suporte aos seguintes tipos de menus:

Menus do aplicativo são suportados pelo OS X. Use a propriedade NativeApplication.supportsMenu para testar se os menus do aplicativo são suportados no sistema operacional de host. Um menu do aplicativo é exibido no Barra de menus no topo da área de trabalho do Mac. O OS X fornece um menu padrão para cada aplicativo, mas muitos dos comandos do menu não são funcionais. Você pode adicionar ouvintes de evento aos itens padrão, substituir menus individuais e itens ou até substituir o menu padrão inteiramente. Acesse o objeto de menu do aplicativo utilizando a propriedade menu do NativeApplication.
Menus da janela são suportados no Windows e Linux. Use a propriedade NativeWindow.supportsMenu para testar se os menus da janela são suportados pelo sistema operacional de host. Um menu de janela é exibido em baixo do barra de títulos de título da janela. A área ocupada pelo menu não é parte do área da janela. Os aplicativos não podem ocupar esta área. Atribua um menu a uma janela utilizando a propriedade menu do NativeWindow.
Dock icon menus são suportados no OS X. Use a propriedade NativeApplication.supportsDockIcon para testar se os ícones de encaixe são suportados no sistema operacional de host. Os itens em um menu de ícone de encaixe são exibidos acima dos itens padrão fornecidos pelo sistema operacional. Os itens padrão não podem ser acessados pelo código de aplicativo. Atribua um menu à propriedade menu do objeto DockIcon do aplicativo.
System tray icon menus são suportados pelo Windows e a maior parte de sistemas operacionais Linux. Use a propriedade NativeApplication.supportsSystemTrayIcon para testar se os ícones de bandeja do sistema são suportados no sistema operacional de host. Um menu de ícone de bandeja do sistema é exibido em resposta a um clique com o botão direito do mouse no ícone, da mesma maneira que um menu de contexto. Atribua um menu à propriedade menu do objeto SystemTrayIcon do aplicativo.
Context menus são suportados em todos os sistemas operacionais. Os menus de contexto são exibidos em resposta a um evento de interface do usuário, como clicar com o botão direito do mouse ou um clique com a tecla Command em um InteractiveObject exibido no aplicativo. O mecanismo de IU para mostrar o menu varia de sistema operacional de host e hardware. Atribua um menu à propriedade contextMenu de um InteractiveObject. No AIR, um menu de contexto pode ser criado com a classe NativeMenu ou ContextMenu. No Flash Player, só a classe ContextMenu pode ser usada. ContextMenus no AIR não têm itens embutidos; um menu de contexto padrão não é exibido.
Pop-up menus são suportados em todos os sistemas operacionais. Os Pop-up menus são funcionalmente os mesmos que os menus de contexto, mas são exibidos usando o método display() do menu em vez de ser como uma resposta a um evento de interface do usuário. Um Pop-up menus não é anexado a nenhum outro objeto. Simplesmente crie o menu nativo e chame o método display().

Um objeto de menu contém itens de menu. O item de menu pode ser um comando, um submenu ou uma linha separadora. Adicione itens de menu a um menu que utiliza o método addItem() ou addItemAt(). A ordem de exibição de um item do menu corresponde à ordem dos itens da matriz de itens do menu.

Para criar um submenu, adicione um item de menu ao objeto de menu de pai. Atribua o objeto de menu que representa o submenu à propriedade submenu do item de menu correspondente no menu de pais.

Observação: O menu raiz dos menus de janela e aplicativo deve conter apenas os itens de submenu; os itens sem submenus não podem ser exibidos e são contrários à expectativa do usuário para esses tipos de menus.

Os menus despacham os eventos select quando um item de comando no menu ou um dos respectivos submenus é selecionado. (Os itens de submenu e separador não são selecionáveis.) A propriedade target do objeto de evento faz referência ao item selecionado.

Os menus despacham eventos preparing pouco antes de o menu ser exibido e quando um equivalente de tecla vinculado a um dos itens do menu é pressionado. Você pode usar este evento para atualizar o conteúdo do menu com base no estado atual do aplicativo.

Observação: Se você estiver usando o Flex Framework, considere a utilização da classe FlexNativeMenu. Normalmente é mais fácil definir menus declarativamente em MXML do que é gravar o código de ActionScript para criar a estrutura de menu o item por item.

Elementos da API relacionados

flash.display.InteractiveObject.contextMenu
flash.display.NativeMenuItem
flash.display.NativeWindow.menu
flash.desktop.DockIcon
flash.desktop.SystemTrayIcon
flash.desktop.NativeApplication.menu
flash.desktop.NativeApplication.icon
mx.controls.FlexNativeMenu

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		constructor : Object Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.	Object
		isSupported : Boolean [estático] [somente leitura] Indica se alguma forma do menu nativo é suportada no sistema cliente.	NativeMenu
		items : Array A matriz dos objetos NativeMenuItem neste menu.	NativeMenu
		numItems : int [somente leitura] O número de objetos NativeMenuItems neste menu.	NativeMenu
		parent : NativeMenu [somente leitura] O menu pai.	NativeMenu

Métodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	Método		Definido por
		NativeMenu() Cria um novo objeto NativeMenu.	NativeMenu
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.	EventDispatcher
		addItem(item:NativeMenuItem):NativeMenuItem Adiciona um item de menu à parte inferior do menu.	NativeMenu
		addItemAt(item:NativeMenuItem, index:int):NativeMenuItem Insere um item de menu na posição especificada.	NativeMenu
		addSubmenu(submenu:NativeMenu, label:String):NativeMenuItem Adiciona um submenu ao menu inserindo um novo item de menu.	NativeMenu
		addSubmenuAt(submenu:NativeMenu, index:int, label:String):NativeMenuItem Adiciona um submenu ao menu inserindo um novo item de menu na posição especificada.	NativeMenu
		clone():NativeMenu Cria uma cópia do menu e de todos os itens.	NativeMenu
		containsItem(item:NativeMenuItem):Boolean Reporta se este menu contém o item de menu especificado.	NativeMenu
		dispatchEvent(event:Event):Boolean Envia um evento para o fluxo de eventos.	EventDispatcher
		display(stage:Stage, stageX:Number, stageY:Number):void Ativa este menu no local especificado.	NativeMenu
		getItemAt(index:int):NativeMenuItem Obtém o item no índice especificado.	NativeMenu
		getItemByName(name:String):NativeMenuItem Obtém o item de menu com o nome especificado.	NativeMenu
		getItemIndex(item:NativeMenuItem):int Obtém a posição do item especificado.	NativeMenu
		hasEventListener(type:String):Boolean Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica se um objeto tem uma propriedade especificada definida.	Object
		isPrototypeOf(theClass:Object):Boolean Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica se a propriedade especificada existe e é enumerável.	Object
		removeAllItems():void Remove todos os itens do menu.	NativeMenu
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Remove um ouvinte do objeto EventDispatcher.	EventDispatcher
		removeItem(item:NativeMenuItem):NativeMenuItem Remove o item de menu especificado.	NativeMenu
		removeItemAt(index:int):NativeMenuItem Remove e retorna o item de menu no índice especificado.	NativeMenu
		setItemIndex(item:NativeMenuItem, index:int):void Move um item de menu para a posição especificada.	NativeMenu
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Define a disponibilidade de uma propriedade dinâmica para operações de repetição.	Object
		toLocaleString():String Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.	Object
		toString():String Retorna a representação de string do objeto especificado.	Object
		valueOf():Object Retorna o valor primitivo do objeto especificado.	Object
		willTrigger(type:String):Boolean Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.	EventDispatcher

Eventos

Clique para obter mais informações sobre eventos

Ocultar eventos herdados

Mostrar eventos herdados

	Resumo	Definido por
activate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo.	EventDispatcher
deactivate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo.	EventDispatcher
displaying	Despachado por este objeto NativeMenu imediatamente antes de o menu ser exibido.	NativeMenu
preparing	Despachado pelo objeto NativeMenu quando um equivalente de tecla é pressionado e imediatamente antes de o menu ser exibido.	NativeMenu
select	Despachado por este objeto NativeMenu quando um dos respectivos itens de menu ou um item em um dos respectivos submenus descendentes for selecionado.	NativeMenu

Detalhes da propriedade

isSupported

propriedade

isSupported:Boolean [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 2.0

Indica se alguma forma do menu nativo é suportada no sistema cliente.

Implementação
public static function get isSupported():Boolean

Elementos da API relacionados

flash.display.NativeWindow.supportsMenu
flash.desktop.NativeApplication

items

propriedade

items:Array

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

A matriz dos objetos NativeMenuItem neste menu.

A matriz é classificada por ordem de exibição.

Observação: Essa propriedade é somente leitura no AIR 1.0. Ela se torna leitura/gravação no AIR 1.1.

Implementação
public function get items():Array
public function set items(value:Array):void

numItems

propriedade

numItems:int [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

O número de objetos NativeMenuItems neste menu.

Implementação
public function get numItems():int

parent

propriedade

parent:NativeMenu [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

O menu pai.

O parent do objeto de menu raiz (nível superior) é null.

Implementação
public function get parent():NativeMenu

Detalhes do construtor

()

Construtor

public function NativeMenu()

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Cria um novo objeto NativeMenu.

Detalhes do método

addItem

()

método

public function addItem(item:NativeMenuItem):NativeMenuItem

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Adiciona um item de menu à parte inferior do menu.

Ao criar um menu de contexto, você pode adicionar objetos NativeMenuItem ou ContextMenuItem. No entanto, é recomendável usar apenas um tipo de objeto em um menu de contexto de forma que todos os itens do menu tenham as mesmas propriedades.

Observação: Adicionar um item a um menu pode fazer com que um aplicativo seja desativado se o submenu do item for definido para o próprio menu (causando uma referência circular).

Parâmetros

item:NativeMenuItem — O objeto NativeMenuItem para adicionar à parte inferior do menu.

Retorna

NativeMenuItem

Lança

	`ArgumentError` — Se o `item` for `null`.

	`ArgumentError` — Caso `item` seja um membro de outro menu.

addItemAt

()

método

public function addItemAt(item:NativeMenuItem, index:int):NativeMenuItem

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Insere um item de menu na posição especificada. A posição é indexada a partir do topo. Defina o parâmetro index como zero para inserir o item no topo do menu. Todos os tipos de menus - janelas, aplicativos, ícones de bandeja do sistema, ícones de encaixe, contexto e pop-up - indexam a posição do menu a partir do topo.

Parâmetros

	`item:NativeMenuItem` — O objeto NativeMenuItem a ser inserido.

	`index:int` — A posição (com base em zero) no menu na qual o item de menu deve ser inserido Observação: Adicionar um item a um menu pode fazer com que um aplicativo seja desativado se o submenu do item for definido para o próprio menu (causando uma referência circular).

Retorna

NativeMenuItem

Lança

	`ArgumentError` — Se o `item` for `null`.

	`ArgumentError` — Caso `item` seja um membro de outro menu.

	`RangeError` — Se o índice estiver fora dos limites da matriz `items` do menu.

addSubmenu

()

método

public function addSubmenu(submenu:NativeMenu, label:String):NativeMenuItem

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Adiciona um submenu ao menu inserindo um novo item de menu.

A chamada ao método addSubMenuAt() equivale a criar um item de menu, adicionando-o ao menu e atribuindo um objeto NativeMenu à propriedade submenu do item.

Observação: Adicionar um menu como um submenu de si mesmo (em uma referência circular) pode fazer com que um aplicativo seja desligado.

Parâmetros

	`submenu:NativeMenu` — O objeto NativeMenu que define o submenu que deve ser adicionado.

	`label:String` — O rótulo de exibição do item de menu que deve ser adicionado.

Retorna

NativeMenuItem — O objeto NativeMenuItem criado para o submenu.

addSubmenuAt

()

método

public function addSubmenuAt(submenu:NativeMenu, index:int, label:String):NativeMenuItem

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Adiciona um submenu ao menu inserindo um novo item de menu na posição especificada.

A chamada ao método addSubMenuAt() equivale a criar um novo item de menu, inserindo-o na posição desejada no menu e atribuindo um objeto NativeMenu à propriedade submenu do item.

Observação: Adicionar um menu como um submenu de si mesmo (em uma referência circular) pode fazer com que um aplicativo seja desligado.

Parâmetros

	`submenu:NativeMenu` — O objeto NativeMenu que define o submenu que deve ser adicionado.

	`index:int` — A posição na matriz `items` deste menu no qual inserir o item de menu que deve ser adicionado.

	`label:String` — O rótulo de exibição do item de menu que deve ser adicionado.

Retorna

NativeMenuItem — O objeto NativeMenuItem criado para o submenu.

clone

()

método

public function clone():NativeMenu

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Cria uma cópia do menu e de todos os itens.

Retorna

NativeMenu

containsItem

()

método

public function containsItem(item:NativeMenuItem):Boolean

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Reporta se este menu contém o item de menu especificado.

Parâmetros

item:NativeMenuItem — O objeto NativeMenuItem a ser pesquisado.

Retorna

Boolean — true se o item estiver neste menu.

display

()

método

public function display(stage:Stage, stageX:Number, stageY:Number):void

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Ativa este menu no local especificado.

Parâmetros

	`stage:Stage` — O objeto Stage no qual o menu é exibido.

	`stageX:Number` — O número de pixels horizontais, relativos à origem do palco, o qual exibe seu menu.

	`stageY:Number` — O número de pixels verticais, relativos à origem do palco, o qual exibe seu menu.

getItemAt

()

método

public function getItemAt(index:int):NativeMenuItem

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Obtém o item no índice especificado.

Parâmetros

index:int — A posição (com base em zero) do item a ser retornado.

Retorna

NativeMenuItem — O objeto NativeMenuItem na posição especificada no menu.

Lança

RangeError — Se o index estiver fora dos limites da matriz items do menu.

getItemByName

()

método

public function getItemByName(name:String):NativeMenuItem

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Obtém o item de menu com o nome especificado.

Observação: A propriedade name de itens de menu, por padrão, não é atribuída.

Parâmetros

name:String — A string a ser pesquisada.

Retorna

NativeMenuItem — O objeto NativeMenuItem com o nome especificado ou null se esse item não existir no menu.

getItemIndex

()

método

public function getItemIndex(item:NativeMenuItem):int

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Obtém a posição do item especificado.

Parâmetros

item:NativeMenuItem — O objeto NativeMenuItem a ser pesquisado.

Retorna

int — A posição (com base em zero) do item especificado neste menu ou -1, se o item não estiver neste menu.

removeAllItems

()

método

public function removeAllItems():void

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Remove todos os itens do menu.

removeItem

()

método

public function removeItem(item:NativeMenuItem):NativeMenuItem

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Remove o item de menu especificado.

Parâmetros

item:NativeMenuItem — O objeto NativeMenuItem para remover desse menu.

Retorna

NativeMenuItem

Lança

RangeError — Se o item não estiver neste menu

removeItemAt

()

método

public function removeItemAt(index:int):NativeMenuItem

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Remove e retorna o item de menu no índice especificado.

Parâmetros

index:int — A posição (com base em zero) do item a ser removida.

Retorna

NativeMenuItem — O objeto NativeMenuItem removido.

Lança

RangeError — Se o index estiver fora dos limites da matriz items do menu.

setItemIndex

()

método

public function setItemIndex(item:NativeMenuItem, index:int):void

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Move um item de menu para a posição especificada. Se o item não estiver já no menu, chamar este método para adicionar o item ao menu.

Parâmetros

	`item:NativeMenuItem` — O objeto NativeMenuItem a ser movido.

	`index:int` — A posição (com base em zero) no menu para o qual o `item` deve ser movido.

Lança

RangeError — Se o index estiver fora dos limites da matriz items do menu.

Detalhe do evento

displaying

Evento

Tipo do objeto de evento: flash.events.Event
propriedade Event.type = flash.events.Event.DISPLAYING

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Despachado por este objeto NativeMenu imediatamente antes de o menu ser exibido.

Monitore este evento para atualizar o menu antes que ele seja exibido. O evento displaying também é despachado pelos itens de um menu.

O evento preparing excede o evento displaying e fornece funcionalidade adicional. Escute o evento preparing ou o evento displaying, mas não ambos.

Nota:No Mac OS X, anterior ao AIR 2.6, os menus e os itens de menu despachavam um evento displaying quando o usuário pressionava um equivalente de tecla. (Este evento não foi despachado para a interação de equivalente de tecla em outros sistemas operacionais.) A partir do AIR 2.6, os eventos displaying não são mais despachados quando o usuário pressiona um equivalente de tecla. Em vez disso, use o evento preparing.

A constante Event.DISPLAYING define o valor da propriedade type de um objeto de evento displaying.

Observação: Este evento não passa por uma "fase de captura" e é despachado diretamente ao destino, quer o destino esteja na exibição ou não.

Esse evento tem as seguintes propriedades:

Propriedade	Valor
`bubbles`	`false`
`cancelable`	`false`
`currentTarget`	O objeto que está processando ativamente o objeto Event com um ouvinte de evento.
`target`	O objeto que está prestes a ser exibido.

preparing

Evento

Tipo do objeto de evento: flash.events.Event
propriedade Event.type = flash.events.Event.PREPARING

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 2.6

Despachado pelo objeto NativeMenu quando um equivalente de tecla é pressionado e imediatamente antes de o menu ser exibido.

Escute este evento para atualizar o menu antes que ele seja exibido ou quando um equivalente de tecla for pressionado pelo usuário. O evento preparing é despachado antes que o equivalente de tecla seja avaliado por completo. Você pode ativar, desativar, adicionar ou remover itens do menu no manipulador de eventos preparing, e essas modificações serão efetivas quando o equivalente de chave for processado. Por exemplo, se você remover ou desativar o item de menu atribuído a um equivalente de tecla de acionamento, então a sequência de eventos será efetivamente cancelada e nenhum evento select será despachado. O evento preparing também é despachado pelos itens de um menu.

O evento preparing excede o evento displaying e fornece funcionalidade adicional. Escute o evento preparing ou o evento displaying, mas não ambos.

A constante Event.PREPARING define o valor da propriedade type de um objeto de eventopreparing.

Observação: Este evento não passa por uma "fase de captura" e é despachado diretamente ao destino, quer o destino esteja na exibição ou não.

Esse evento tem as seguintes propriedades:

Propriedade	Valor
`bubbles`	`false`
`cancelable`	`false`
`currentTarget`	O objeto que despachou este evento.
`target`	O objeto que despachou este evento.

select

Evento

Tipo do objeto de evento: flash.events.Event
propriedade Event.type = flash.events.Event.SELECT

Versão da linguagem:

ActionScript 3.0

Versões de runtime:

AIR 1.0

Despachado por este objeto NativeMenu quando um dos respectivos itens de menu ou um item em um dos respectivos submenus descendentes for selecionado.

Um evento selectforma (bolhas) de um item para o menu que o contém através da cadeia de menu pai, até o objeto de menu raiz. A propriedade target do objeto de evento faz referência ao objeto NativeMenuItem selecionado; a propriedade currentTarget faz referência a esse objeto NativeMenu.

A constante Event.SELECT define o valor da propriedade type de um objeto de evento select.

Esse evento tem as seguintes propriedades:

Propriedade	Valor
`bubbles`	`false`
`cancelable`	`false`; não há comportamento padrão a ser cancelado.
`currentTarget`	O objeto que está processando ativamente o objeto Event com um ouvinte de evento.
`target`	O objeto no qual um item foi selecionado.

Aspectos jurídicos | Política de privacidade on-line

NativeMenu - AS3

Pacotesx

Elementos de linguagem

Apêndices

Pacote flash.display

isSupported

items

numItems

parent

NativeMenu

addItem

addItemAt

addSubmenu

addSubmenuAt

clone

containsItem

display

getItemAt

getItemByName

getItemIndex

removeAllItems

removeItem

removeItemAt

setItemIndex

displaying

preparing

select