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

pageatts

Default Whitebeam and HTML attributes for presentation pages in Whitebeam applications.

Elements

The pageatts struct has 10 elements:

Name Type/Value Range/Length Description
rbtopbarstringtext Optional. Identifier or rb:id attribute value of <rb:block/> tag that defines the top bar
rbleftbarstringtext Optional. Identifier of left bar (takes precedence over rbmenubar.
rbmenubarstringtext Optional. Identifier of left menu bar (implies rbleftbar identifying a block with attribute menubar="yes").
rbrightbarstringtext Optional. Identifier of right bar.
rbbottombarstringtext Optional. Identifier of bottom bar.
rbbodybarstringtext Optional. Identifier of body bar.
rbbodyonlystringyes Optional. Process only <body> tag but excluding background attribute (useful for printer-friendly view).
rbbacktotopstringyes Optional. Appends at the bottom of the body bar area a Back to Top hypertext link to an anchor named "top" that is added by default after the <body> tag of every presentation page.
rbselmenulinkstringyes Optional. Make the auto-selected menu item an active hypertext link.
...string... Optional. Any valid <body> tag attributes. By default, topmargin, leftmargin, marginwidth and marginheight attributes are set to 0.

Remarks

Default page attributes can be overridden and supplemented by <body> tag attributes of the Presentation Page. These are applied to the <body> tag of the presentation page which is generated as a main table with up to 3 rows and 3 columns made up of the page bars and the contents of the <body> tag in the Presentation Page.

The rbtopbar, rbleftbar, rbrightbar, rbbottombar and rbbodybar page attributes can each be assigned to rb:id attribute value of a <rb:block> tag. Each block tag, defined once only, can contain any valid XML in its body and can have the following optional attributes:

NameDescription
menubarIndicates a menu bar if value is "yes" i.e. displays, after the body of the block, a menu tree based on <rbm:menuitem> tags and equivalent methods.
This attribute is implied if the block is assigned to page attribute rbmenubar.
For specific menu positioning, content and format, <rbm:writemenu> tag(s) can be used in the body of page block tag(s).
totopStarts a left or right bar at the top of the page if value is "yes" instead of below (default) the top bar (if present).
tobottomFinishes a left or right bar at the bottom of the page if value is "yes". By default, vertical bars end above the bottom bar (if present).
widthMinimum width in pixels (may be affected by rendered content of this and other bars).
heightMinimum height in pixels (may be affected by rendered content of this and other bars).
alignHorizontal alignment of contents of bar (standard HTML).
valignVertical alignment of contents of bar (standard HTML).
bgcolorBackground colour of bar area (standard HTML).
backgroundPath name of background image of bar area (standard HTML).
cellspacingSpacing (on rbbodybar only) between its content and other bars (standard HTML). Default value is 3.

Whitebeam release 1.3.36
(loadtime : 11ms)