OverviewSingleDeprecatedPropertiesEventsXSL Parameters

jsx3.amp.util

class Menu

Object
->jsx3.lang.Object
  ->jsx3.amp.util.MenuItem
    ->jsx3.amp.util.Menu
class Menu
extends jsx3.amp.util.MenuItem
A managed menu. Provided by the jsx3.amp.util.menumgr plug-in.

See Also:

jsx3.amp.util.MenuManager
Constructor Summary
void
init(objExt : jsx3.amp.Ext, objElm : jsx3.amp.XML)
The instance initializer.
Method Summary
void
addItem(objItem : jsx3.amp.util.MenuItem, strSection : String)
Adds an item to this menu.
void
addSection(strId : String, bDivider : boolean)
Adds a logical section to this menu.
String
getId()
Returns the ID of this menu.
jsx3.amp.util.MenuItem
getItem(id : String)
Returns the item in this menu whose ID is equal to id.
jsx3.$Array<jsx3.amp.util.MenuItem>
getItems()
Returns all items in this menu.
jsx3.gui.Menu
getNativeMenu()
Returns the native GI menu that was rendered for this AMP menu.
String
getPath()
Returns the path of this menu.
jsx3.xml.Document
getXML()
Returns the CDF data source for this menu.
void
onShow(objMenu : jsx3.gui.Menu, objElm : jsx3.xml.Entity)
Called just before this menu is expanded.
Methods Inherited From jsx3.amp.util.MenuItem
attr, execute, getExt, getHotKey, getImg, getLabel, getMenu, getRootMenu, getTip, isEnabled, isSelected
Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf, toString
Constructor Detail

init

void init(objExt : jsx3.amp.Ext, objElm : jsx3.amp.XML)
The instance initializer.

Parameters:

objExt –
objElm –
Method Detail

addItem

void addItem(objItem : jsx3.amp.util.MenuItem, strSection : String)
Adds an item to this menu.

Parameters:

objItem – the item to add.
strSection – the section ID.

addSection

void addSection(strId : String, bDivider : boolean)
Adds a logical section to this menu.

Parameters:

strId – the section ID.
bDivider – whether the section begins with a visual dividing line.

getId

String getId()
Returns the ID of this menu.

Returns:

 

Overrides:

getId in jsx3.amp.util.MenuItem

getItem

jsx3.amp.util.MenuItem getItem(id : String)
Returns the item in this menu whose ID is equal to id.

Parameters:

id –

Returns:

 

getItems

jsx3.$Array<jsx3.amp.util.MenuItem> getItems()
Returns all items in this menu.

Returns:

 

getNativeMenu

jsx3.gui.Menu getNativeMenu()
Returns the native GI menu that was rendered for this AMP menu.

Returns:

 

getPath

String getPath()
Returns the path of this menu.

Returns:

 

Overrides:

getPath in jsx3.amp.util.MenuItem

getXML

jsx3.xml.Document getXML()
Returns the CDF data source for this menu. If this is a nested menu then this XML will be inserted into the XML document of the base GI Menu.

This method is the bridge between the object-oriented AMP definition of a menu and the XML-based GI definition of a menu.

Returns:

 

onShow

void onShow(objMenu : jsx3.gui.Menu, objElm : jsx3.xml.Entity)
Called just before this menu is expanded. This method may modify any of the XML inside objElm, for example by enabling or selecting menu items or generating menu items on the fly.

Parameters:

objMenu –
objElm –
Copyright © 2001-2011, TIBCO Software Inc.