Menu Interface |
Open Client Administration |
Menu Interface
The constructor function returns an object that is used by the OpenClient to control the menu. This interface object must have the following functions:
destroy
|
|
Purpose |
Remove the menu from the environment and free up any resources used by the object instance. This function has no parameters and no return value. |
Parameters |
This function has no parameters. |
Remarks |
Return value: This function has no return value. |
Example |
|
setMenu
|
|
Purpose |
Sets the menu. |
Parameters |
menuObject is an object containing the menu structure (see below for full details of this object). |
Remarks |
Return value: This function has no return value. |
Example |
|
setProperty
|
|
Purpose |
Sets a property. |
Parameters |
name is the property name. Value is the property value. |
Remarks |
Return value: This function has no return value. |
Example |
|
Show
|
|
Purpose |
Shows the menu. This function has no parameters and no return value. |
Parameters |
This function has no parameters |
Remarks |
Return value: This function has no return value. |
Example |
|
Hide
|
|
Purpose |
Hides the menu. This function has no parameters and no return value. |
Parameters |
This function has no parameters. |
Remarks |
Return value: This function has no return value. |
Example |
|
Menu Structure
The menuObject passed as a parameter in the setMenu function is a collection of Menu objects each of which has properties.
menuObject
|
|
Purpose |
When passed as a parameter in the setMenu function, menuObject is a collection of menu objects with properties. |
Parameters |
name is the menu name. title is the menu title. actionId is the menu action ID. children is an array of child menu objects. |
Remarks |
|
Example |
menuObject = { name: ‘topmenu’, {name: ‘menu1’, {name: ‘action11’, {name: ‘action12’, {name: ‘action13’, ]}, {name: ‘menu2’, {name: ‘action21’, {name: ‘action22’, {name: ‘action23’, ]} ] } |
Topic ID: 800067