flash.ui.ContextMenuItem (ActionScript 3.0)

Paquete	flash.ui
Clase	public final class ContextMenuItem
Herencia	ContextMenuItem EventDispatcher Object

Versión del lenguaje:

ActionScript 3.0

Versión del reproductor:

Flash Player 9

La clase ContextMenuItem se utiliza para crear elementos de menú personalizados que deben aparecer en el menú contextual de Flash Player. Cada objeto ContextMenuItem tiene un texto que aparece en el menú contextual. Para añadir un nuevo elemento a un menú contextual, debe añadirse a la matriz customItems de un objeto ContextMenu.

Con las propiedades de la clase ContextMenuItem se pueden activar o desactivar elementos de menú específicos, así como hacerlos visibles o invisibles.

Escriba un controlador de eventos para el evento menuItemSelect a fin de añadir funcionalidad al elemento de menú cuando lo seleccione el usuario.

Los elementos de menú personalizados aparecen en la parte superior del menú contextual, por encima de los elementos de menú incorporados. Una barra separadora siempre divide los elementos de menú incorporados y los personalizados.

Restricciones:

Puede añadir un máximo de 15 elementos personalizados a un menú contextual.
Cada texto debe contener, al menos, un carácter visible.
No se tienen en cuenta los caracteres de control, las nuevas líneas y otros caracteres de espacio en blanco.
Ningún texto puede exceder los 100 caracteres de longitud.
No se tienen en cuenta los textos que coincidan exactamente con algún elemento de menú incorporado o con otros elementos personalizados, sea visible o no el elemento coincidente. Los textos del menú se comparan con los textos incorporados o con los personalizados ya existentes, independientemente del uso de mayúsculas, puntuación o espacios en blanco.

No están permitidos los textos siguientes, pero las palabras se pueden utilizar en combinación con otras palabras para crear un texto personalizado (por ejemplo, aunque no está permitido utilizar "Pegar", sí se puede emplear la frase "Pegar no está bien"):

 Guardar
 Aumentar
 Reducir
 100%
 Mostrar todo
 Calidad
 Reproducir
 Reproducir indefinidamente
 Rebobinar
 Avanzar
 Atrás
 No se cargó la película
 Acerca de
 Imprimir
 Mostrar regiones de redibujo
 Depurador
 Deshacer
 Cortar
 Copiar
 Pegar
 Eliminar
 Seleccionar todo
 Abrir
 Abrir en nueva ventana
 Copiar vínculo

Ninguna de las palabras siguientes puede aparecer en un texto personalizado, ni solas ni combinadas con otras palabras:
```
 Configuración de Adobe Macromedia Flash Player
 
```

Nota: si el reproductor se ejecuta en un sistema no inglés, las cadenas de los textos se comparan tanto con la lista inglesa como con las equivalencias traducidas.

Ver los ejemplos

Véase también

ContextMenu
ContextMenuBuiltInItems

	Propiedad	Definido por
		caption : String Especifica el texto del elemento de menú que se muestra en el menú contextual.	ContextMenuItem
		constructor : Object Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada.	Object
		enabled : Boolean Indica si el elemento de menú especificado está activado o desactivado.	ContextMenuItem
		prototype : Object [static] Una referencia al objeto prototipo de una clase u objeto de función.	Object
		separatorBefore : Boolean Indica si debe aparecer una barra separadora por encima del elemento de menú especificado.	ContextMenuItem
		visible : Boolean Indica si el elemento de menú especificado estará visible cuando se muestre el menú contextual de Flash Player.	ContextMenuItem

	Método	Definido por
		ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true) Crea un nuevo objeto ContextMenuItem que puede añadirse a la matriz ContextMenu.customItems.	ContextMenuItem
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento.	EventDispatcher
		clone():ContextMenuItem Crea y devuelve una copia del objeto ContextMenuItem especificado.	ContextMenuItem
		dispatchEvent(event:Event):Boolean Distribuye un evento en el flujo del evento.	EventDispatcher
		hasEventListener(type:String):Boolean Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica si un objeto tiene definida una propiedad especificada.	Object
		isPrototypeOf(theClass:Object):Boolean Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica si existe la propiedad especificada y si es enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Elimina un detector del objeto EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Establece la disponibilidad de una propiedad dinámica para operaciones de bucle.	Object
		toString():String Devuelve la representación de cadena del objeto especificado.	Object
		valueOf():Object Devuelve el valor simple del objeto especificado.	Object
		willTrigger(type:String):Boolean Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto.	EventDispatcher

Resumen	Definido por
activate	Se distribuye cuando Flash Player queda seleccionado por el sistema operativo y pasa a estar activo.	EventDispatcher
deactivate	Se distribuye cuando Flash Player deja de estar seleccionado por el sistema operativo y pasa a estar inactivo.	EventDispatcher
menuItemSelect	Se distribuye cuando el usuario selecciona un elemento del menú contextual.	ContextMenuItem

Información sobre propiedades

caption

propiedad

caption:String [read-write]

Versión del lenguaje:

ActionScript 3.0

Versión del reproductor:

Flash Player 9

Especifica el texto del elemento de menú que se muestra en el menú contextual. Consulte la información general de la clase ContextMenuItem para conocer las restricciones del valor caption.

Implementación
public function get caption():String
public function set caption(value:String):void

enabled

propiedad

enabled:Boolean [read-write]

Versión del lenguaje:

ActionScript 3.0

Versión del reproductor:

Flash Player 9

Indica si el elemento de menú especificado está activado o desactivado.

El valor predeterminado es true.

Implementación
public function get enabled():Boolean
public function set enabled(value:Boolean):void

separatorBefore

propiedad

separatorBefore:Boolean [read-write]

Versión del lenguaje:

ActionScript 3.0

Versión del reproductor:

Flash Player 9

Indica si debe aparecer una barra separadora por encima del elemento de menú especificado.

Nota: siempre se muestra una barra separadora entre los elementos de menú personalizados y los elementos de menú incorporados.

El valor predeterminado es false.

Implementación
public function get separatorBefore():Boolean
public function set separatorBefore(value:Boolean):void

visible

propiedad

visible:Boolean [read-write]

Versión del lenguaje:

ActionScript 3.0

Versión del reproductor:

Flash Player 9

Indica si el elemento de menú especificado estará visible cuando se muestre el menú contextual de Flash Player.

El valor predeterminado es true.

Implementación
public function get visible():Boolean
public function set visible(value:Boolean):void

Información sobre constructores

ContextMenuItem

()

constructor

public function ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true)

Versión del lenguaje:

ActionScript 3.0

Versión del reproductor:

Flash Player 9

Crea un nuevo objeto ContextMenuItem que puede añadirse a la matriz ContextMenu.customItems.

Parámetros

	`caption:String` — Especifica el texto asociado al elemento de menú. Consulte la información general de la clase ContextMenuItem para conocer las restricciones del valor `caption`.

	`separatorBefore:Boolean` (default = `false`) — Especifica si aparece una barra de separación encima del elemento de menú del menú contextual. El valor predeterminado es `false`.

	`enabled:Boolean` (default = `true`) — Especifica si el elemento de menú aparece activado o desactivado en el menú contextual. El valor predeterminado es `true` (activado). Este parámetro es opcional.

	`visible:Boolean` (default = `true`) — Especifica si el elemento de menú es visible o invisible. El valor predeterminado es `true` (visible).

Información sobre métodos

clone

()

método

public function clone():ContextMenuItem

Versión del lenguaje:

ActionScript 3.0

Versión del reproductor:

Flash Player 9

Crea y devuelve una copia del objeto ContextMenuItem especificado. La copia incluye todas las propiedades del objeto original.

Valor devuelto

ContextMenuItem — Un objeto ContextMenuItem que contiene todas las propiedades del objeto original.

Información sobre eventos

menuItemSelect

Evento

Tipo de objeto de evento: flash.events.ContextMenuEvent
ContextMenuEvent.type property = flash.events.ContextMenuEvent.MENU_ITEM_SELECT

Versión del lenguaje:

ActionScript 3.0

Versión del reproductor:

Flash Player 9

Se distribuye cuando el usuario selecciona un elemento del menú contextual. El usuario genera el menú contextual al hacer clic con el botón derecho del dispositivo de señalización.

Define el valor de la propiedad type de un objeto de evento menuItemSelect.

Este evento tiene las propiedades siguientes:

Propiedad	Valor
`bubbles`	`false`
`cancelable`	`false`; no hay ningún comportamiento predeterminado que cancelar.
`contextMenuOwner`	El objeto de la lista de visualización al que se asocia el menú.
`currentTarget`	El objeto que procesa de forma activa el objeto de evento con un detector de eventos.
`mouseTarget`	El objeto de la lista de visualización en el que el usuario hace clic con el botón derecho para mostrar el menú contextual.
`target`	El objeto ContextMenuItem seleccionado. El destino no siempre es el objeto de la lista de visualización que registró el detector de eventos. Utilice la propiedad `currentTarget` para acceder al objeto de la lista de visualización que está procesando el evento actualmente.

Ejemplos Cómo utilizar los ejemplos

ContextMenuItemExample.as

En el ejemplo siguiente, se utiliza la clase ContextMenuBuiltInItemsExample para eliminar del escenario los elementos predeterminados del menú contextual y añadir un nuevo elemento de menú. Esto se consigue con los pasos siguientes:

Se declara una propiedad myContextMenu y, a continuación, se asigna a un nuevo objeto ContextMenu.
Se llama al método removeDefaultItems(), que elimina todos los elementos incorporados en el menú contextual salvo Print.
Se llama al método addCustomMenuItems(), que coloca el elemento de menú Hello World en la matriz customItems a través del método push() de la clase Array.
A continuación, el elemento de menú contextual Hello World se añade a la lista de elementos del menú contextual del escenario.
Se añade al escenario un objeto TextField con el texto "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;
        }
    }
}

Página actual: http://livedocs.adobe.com/flash/9.0_es/ActionScriptLangRefV3/flash/ui/ContextMenuItem.html

Referencia del lenguaje y componentes ActionScript 3.0		Todos los paquetes \| Todas las clases \| Elementos del lenguaje \| Índice \| Apéndices \| Convenciones \| Marcos Quitar marcos
ContextMenuItem	Propiedades \| Métodos \| Eventos \| Ejemplos