Class com.maheshj.UI.core.GenericMenu

Description

A generic class used to implement the core functionality of a single level menu. Extend this class to implement your own menus.

Field Index

hasDefault, isActive, itemGap

Inherited from DisplayObject

addEventListener, dispatchEvent, removeEventListener, scale, visible, xmlFile

Method Index

new GenericMenu()
enter(), getDefaultItem(), getLinkByID(), init(), registerListener()

Inherited from DisplayObject

destroy(), disable(), enable(), exit(), getDimensions(), loadXML(), resize()

Constructor Detail

GenericMenu

public function GenericMenu()

The constructor. Used to instantiate a GenericMenuManager object. Override this method if you have extended the GenericMenuManager and want to use that for your menu.

Field Detail

itemGap

public itemGap:Number

isActive

public isActive:Boolean

hasDefault

public hasDefault:Boolean [Read Only]

Method Detail

init

public function init()

Method used to initialize all the variables, functionality, etc.

enter

public function enter()

Call this function to make the menu appear.

getLinkByID

public function getLinkByID(str:String):Object

Use thie method to get an object containing the info for a given menu item based on the passed ID.

Parameters

str- the ID of the menu item

Return

- the object containing different menu item variables

registerListener

public function registerListener(mc:DisplayObject)

Use this method to register any movieclip as a listener to the events of this class.

Parameters

mc- the movieclip that is to be registered

getDefaultItem

public function getDefaultItem()

Use this method to tigger the default menu item.

as2api