Package | com.ericfeminella.system.contextmenu |
Class | public class ConfigurableContextMenu |
Implements | ICloneableContextMenu, IDynamicContextMenu, IInspectable |
Property | Defined by | ||
---|---|---|---|
itemsMap : HashMap | ConfigurableContextMenu | ||
menu : ContextMenu
Defines the parent in which the ConfigurableContextMenu is added
| ConfigurableContextMenu |
Method | Defined by | ||
---|---|---|---|
ConfigurableContextMenu(owner:InteractiveObject, menuSelectHandler:Function = null)
Instantiates a new instance of ConfigurableContextMenu
| ConfigurableContextMenu | ||
addContextMenuCaptionItem(caption:String, seperator:Boolean = false):void
Adds a ContextMenuItem to a ConfigurableContextMenu which contains
a caption only
| ConfigurableContextMenu | ||
addContextMenuCommandItem(caption:String, command:Function, seperator:Boolean = false, enabled:Boolean = true):void
Adds a ContextMenuItem to a ConfigurableContextMenu which
contains an associated command that handles the item when
selected
| ConfigurableContextMenu | ||
cloneContextMenu():ContextMenu
Clones the ContextMenu of an ConfigurableContextMenu instance
| ConfigurableContextMenu | ||
disableContextMenuItem(caption:String):void
Disables a ContextMenuItem in a ConfigurableContextMenu
| ConfigurableContextMenu | ||
enableContextMenuItem(caption:String):void
Enables a ContextMenuItem in a ConfigurableContextMenu
| ConfigurableContextMenu | ||
getContextMenuItem(caption:String):ContextMenuItem
Retrieves a ContextMenuItem from a ConfigurableContextMenu
| ConfigurableContextMenu | ||
getContextMenuItems():Array
Retrieves all ContextMenuItems for a ConfigurableContextMenu instance
| ConfigurableContextMenu | ||
info():XML
[static]
Provides introspective access on ConfigurableContextMenu
class object
| ConfigurableContextMenu | ||
removeContextMenuItem(caption:String):void
Removes a ContextMenuItem from a ConfigurableContextMenu
| ConfigurableContextMenu | ||
removeDefaultItems():void
Removes built-in ContextMenuItems from a ConfigurableContextMenu
| ConfigurableContextMenu |
itemsMap | property |
protected var itemsMap:HashMap
menu | property |
protected var menu:ContextMenu
Defines the parent in which the ConfigurableContextMenu is added
ConfigurableContextMenu | () | constructor |
public function ConfigurableContextMenu(owner:InteractiveObject, menuSelectHandler:Function = null)
Instantiates a new instance of ConfigurableContextMenu
Parametersowner:InteractiveObject — InteractiveObject owner in which to apply the context menu
|
|
menuSelectHandler:Function (default = null ) — method to invoke upon menu selection
|
addContextMenuCaptionItem | () | method |
public function addContextMenuCaptionItem(caption:String, seperator:Boolean = false):void
Adds a ContextMenuItem to a ConfigurableContextMenu which contains a caption only
Parameterscaption:String — caption of the item
|
|
seperator:Boolean (default = false ) — is an item seperator is to be added, the default is true
|
— |
addContextMenuCommandItem | () | method |
public function addContextMenuCommandItem(caption:String, command:Function, seperator:Boolean = false, enabled:Boolean = true):void
Adds a ContextMenuItem to a ConfigurableContextMenu which contains an associated command that handles the item when selected
Parameterscaption:String — caption of the item
|
|
command:Function — command associated with the item selection event
|
|
seperator:Boolean (default = false ) — if an item seperator is to be added, the default is false
|
|
enabled:Boolean (default = true ) — if the item is enabled or disabled, the default is enabled
|
— |
cloneContextMenu | () | method |
public function cloneContextMenu():ContextMenu
Clones the ContextMenu of an ConfigurableContextMenu instance
ReturnsContextMenu — a clone of the ConfigurableContextMenu ContextMenu
|
disableContextMenuItem | () | method |
public function disableContextMenuItem(caption:String):void
Disables a ContextMenuItem in a ConfigurableContextMenu
Parameterscaption:String — caption of the ContextMenuItem to disable
|
enableContextMenuItem | () | method |
public function enableContextMenuItem(caption:String):void
Enables a ContextMenuItem in a ConfigurableContextMenu
Parameterscaption:String — caption of the ContextMenuItem to enable
|
getContextMenuItem | () | method |
public function getContextMenuItem(caption:String):ContextMenuItem
Retrieves a ContextMenuItem from a ConfigurableContextMenu
Parameterscaption:String |
ContextMenuItem — a ContextMenuItem added to a ConfigurableContextMenu
|
getContextMenuItems | () | method |
public function getContextMenuItems():Array
Retrieves all ContextMenuItems for a ConfigurableContextMenu instance
ReturnsArray — an Array of ContextMenuItems
|
info | () | method |
public static function info():XML
Provides introspective access on ConfigurableContextMenu class object
ReturnsXML — a flash.utils.describeType XML object
|
removeContextMenuItem | () | method |
public function removeContextMenuItem(caption:String):void
Removes a ContextMenuItem from a ConfigurableContextMenu
Parameterscaption:String — caption of the ContextMenuItem to remove
|
removeDefaultItems | () | method |
public function removeDefaultItems():void
Removes built-in ContextMenuItems from a ConfigurableContextMenu