Whitebeam Library Definition

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Library Definition

Method Description

rbaddmenulist()

Adds a menu tree (new one or sub of an existing menu item) from a list of menu definitions.

See Also

rbaddmenutree()   

Syntax

menuinfo = rbaddmenulist(list)

Parameters

The 'rbaddmenulist' method takes 1 parameter:

Name Type/Value Range/Length Description
listarray of struct menuinfossee definition Required. Array of menu objects.

Results

The 'rbaddmenulist' method returns structure:

Type/Value Range/Length Description
struct menuinfo see definition Menu item corresponding to the first list item.

Remarks

This method is a simpler version of rbaddmenutree() and is complementary to <rbm:menuitem> tag.

For example, a new menu tree (with 4 levels) can be added as follows:

 var list = new Array;
 list.push({key:"1a", name="a - level 1", href:"/a1.rhtm", rlevel:1});
 list.push({key:"2a", name:"a - level 2", href:"/a2.rhtm", rlevel:2});
 list.push({key:"2b", name:"b - level 2", href:"/b2.rhtm", rlevel:2});
 list.push({key:"3a", name:"a - level 3", href:"/a3.rhtm", rlevel:3});
 list.push({key:"4a", name:"a - level 4", href:"/a4.rhtm", rlevel:4});
 list.push({key:"2c", name:"c - level 2", href:"/c2.rhtm", rlevel:2});
 list.push({key:"3b", name:"b - level 3", href:"/b3.rhtm", rlevel:3});

  rbaddmenulist(list);

Note that only the first list item should have rlevel set to 1. Also, rlevel should increase by a maximum of 1 between any two consecutive items in the list but can decrease by any amount down to a minimum value of 2.

The list of items should be ordered in the sequence of an equivalent definition with <rbm:menuitem> tags i.e.

<rbm:menuitem key="1a" name="a - Level 1" href="/a1.rhtm">
  <rbm:menuitem key="2a" name="a - level 2" href="/a2.rhtm"/>
  <rbm:menuitem key="2b" name="b - level 2" href="/b2.rhtm">
    <rbm:menuitem key="3a" name="a - level 3" href="/a3.rhtm">
      <rbm:menuitem key="4a", name="a - level 4" href="/a4.rhtm"/>
    </rbm:menuitem>
  </rbm:menuitem>
  <rbm:menuitem key="2c" name="c - level 2" href="/c2.rhtm">
    <rbm:menuitem key="3b" name="b - level 3" href="/b3.rhtm"/>
  </rbm:menuitem>
</rbm:menuitem>

Whitebeam release 1.3.36
(loadtime : 12ms)