Class com.sekati.ui.ContextualMenu

Description

Extended Context Menu Management 

 Usage:
 	var cm:ContextualMenu = new ContextualMenu(_level0);
 	cm.addItem("Item One", Delegate.create(this, myFunction), true, true);
 	cm.addItem("Item Two");
 	cm.editItem("Item Two", "Item 2");
 	cm.removeItem("Item One"); // remove the first item
 	cm.enabled = false; // disable this menu

Field Index

builtInItems, enabled

Method Index

new ContextualMenu()
addItem(), disableItem(), editItem(), enableItem(), menuClick(), removeItem()

Inherited from CoreObject

destroy(), toString()

Constructor Detail

ContextualMenu

public function ContextualMenu(target:MovieClip)

Custom Context Menu Constructor

Parameters

target(MovieClip) object context menu should exist on

Return

Void

Throws

Errorif no target is provided and returns without proper instantiation.

Field Detail

enabled

public enabled:Boolean
Menu enabled getter

builtInItems

public builtInItems:Boolean
Menu builtInItems getter

Method Detail

addItem

public function addItem(caption:String, cb:Function, isDiv:Boolean, isEnabled:Boolean):Number

Add an item to the Context Menu

Parameters

caption(String) menu item text
cb(Function) delegated callback function [optional]
isDiv(Boolean) add a divider before the item [optional, default: true]
isEnabled(Boolean) item is enabled for selection [optional, default: true]

Return

Number - item id.

editItem

public function editItem(oldCaption:String, newCaption:String, cb:Function, isDiv:Boolean, isEnabled:Boolean):Boolean

Edit an added item in the Context Menu

Parameters

oldCaption(String) previous menu item text
newCaption(String) new menu item text
cb(Function) delegated callback function [optional, default: previous setting]
isDiv(Boolean) add a divider before the item [optional, default: previous setting]
isEnabled(Boolean) item is enabled for selection [optional, default: previous setting]

Return

Boolean - true if item was successfully found and changed, false if edit failed.

enableItem

public function enableItem(name:String):Void

Enable an existing item in the Context Menu

Parameters

name(String) the caption name of the item to be enabled.

Return

Void

disableItem

public function disableItem(name:String):Void

Disable an existing item in the Context Menu

Parameters

name(String) the caption name of the item to be disabled.

Return

Void

removeItem

public function removeItem(name:String):Boolean

Remove an item from the Context Menu

Parameters

name(String) the caption name of the item to be removed

Return

Boolean - true if item was sucessfully removed, false if removal failed.

menuClick

public function menuClick():Void

Void function to assign to items added without callback

Return

Void

as2api