XWeb Toolbar API
The API documentation will be divided by the objects of the Toolbar system.
| XWeb_Toolbar |
| This object is used to initialize the system. |
| Constructor |
|
new XWeb_MouseMenu(iHeight); |
|
Parameters |
|
| iHeight |
Required. Sets the height of the Toolbar in pixels. |
|
| Properties |
|
| id |
Can be used to find the related HTMLElement. It can also be used the other way around.
If you know the id of the HTMLElement you can get the JS object by looking in the XWebToolbar.all or the XWebToolbar.toolBar.all collections. |
| toolBarItems |
An array of all Toolbar items. |
| buttonBars |
An array of all Buttonbars. |
| currentButtonBar |
Pointer to the active Buttonbar object. |
| currentButton |
Pointer to the active button object. |
|
| Methods |
|
add() |
|
Adds a Toolbar item and Buttonbar to the system. |
|
Syntax |
|
add(sText,sButtonBar[,sIcon]) |
|
Parameters |
|
| sText |
Required. The string of text for the Toolbar item |
| sButtonBar |
Required. A string containing the name of the Buttonbar object to be created. |
| sIcon |
Optional. The path to an image to be used as an icon. |
|
|
| XWeb_Toolbar_ButtonBar |
This object is used to create the Buttonbar. Remember: Buttonbar objects are automatically created from the add() method. There is no need to manually
create this object. |
| Constructor |
|
new XWeb_Toolbar_ButtonBar(); |
| Properties |
|
| id |
Can be used to find the related HTMLElement. It can also be used the other way around.
If you know the id of the HTMLElement you can get the JS object by looking in the XWebToolbar.all
or the XWebToolbar.buttonBar.all collections. |
| num |
An integer. Can be used to find the releated HTMLElement in conjunction with the XWebToolbar.buttonBar.all collection. |
| buttons |
An array of all buttons contained in the Buttonbar. |
|
| Methods |
|
add() |
|
Adds a button to the Buttonbar. |
|
Syntax |
|
add(sText,sIcon,sURL_JS[,bFunctionSwitch]) |
|
Parameters |
|
| sText |
Required. The string of text for the button. |
| sIcon |
Required. The path to an image to be used as an icon. |
sURL_JS |
Required. Can either be JavaScript code or an URL. |
| bFunctionSwitch |
Optional. By default, sURL_JS will be treated as a URL. If bFunctionSwitch is
false sURL_JS is treated as JavaScript. |
|
|
|
|
mouseHover() |
|
Shows the Buttonbar. |
|
Syntax |
|
mouseHover([bDoAnim]) |
|
Parameters |
|
| bDoAnim |
Optional. If true, the Buttonbar will slide out. If false, it will pop out with no animation. |
|
|
|
|
mouseOff() |
|
Hides a shown Buttonbar. |
|
Syntax |
|
mouseOff() |
|
Parameters |
|
No parameters. |
|
|
|