| javascript_components

# Class: Bs_ButtonBar Source Location: /components/toolbar/Bs_ButtonBar.class.js.php
### Class Overview
a button bar (aka toolbar). #### Author(s): andrej arn <at blueshoes dot org> #### Copyright: blueshoes.org | ### Variables $alignment $helpBarStyle $ignoreEvents $imgPath $useHelpBar $_buttons $_constructor | ### Methods addButton drawInto drawOut newGroup render
### Inherited Variables | ### Inherited Methods
### Class Details [line 14] a button bar (aka toolbar). #### Tags:
license: | developer
copyright: | blueshoes.org
author: | andrej arn <at blueshoes dot org>
[ Top ] ### Class Variables #### $alignment = 'hor' [line 66] how the toolbar shoud be aligned. hor => horizontally (default) vert => vertically
Type: | mixed
[ Top ] #### $helpBarStyle = "font-family:arial; font-size:11px; height:16px;" [line 84] css style (not class name) for the help bar. #### Tags:
var: | helpBarStyle
see: | var this.useHelpBar
access: | public
Type: | string
[ Top ] #### $ignoreEvents = false [line 76] all mouse events (mouse-over, out, click) are ignored. but the buttons are not set to inactive. it is used when a children bar waits for input. #### Tags:
var: | ignoreEvents
todo: | all
access: | public
Type: | bool
[ Top ] #### $imgPath = '/_bsImages/buttons/' [line 44] the path to the buttons (images). note that each button can overwrite this setting with Bs_Button.imgPath. #### Tags:
var: | imgPath
access: | public
Type: | string
[ Top ] #### $useHelpBar = [line 59] if and how the helpbar should be used. not set or false means => don't use it. bool true => use it int 2 => use it, and show the ? icon. looks nice. string element id => use the element specified for the helpbar. if you want the ? icon, place it somewhere yourself. #### Tags:
var: | useHelpBar (bool, int or string, see above.)
see: | var this.helpBarStyle
access: | public
Type: | mixed
[ Top ] #### $_buttons = array() [line 97] references to the button objects. data structure: vector, for buttons: holding vectors with 2 elements, the btn and the helpBarText. for separators: string '|' (pipe) #### Tags:
var: | _buttons (see above)
see: | this.addButton()
access: | protected
Type: | array
[ Top ] #### $_constructor = [line 241]
Type: | mixed
[ Top ] ### Class Methods ### method addButton [line 124]
`void addButton( object btn btn, mixed helpBarText)`
#### Tags:
access: | public
#### Parameters:
object btn | btn |
[ Top ] ### method drawInto [line 218]
`void drawInto( mixed elm)`
renders this into the element specified. #### Tags:
access: | public
#### Parameters:
mixed | elm | elm (string name of element, or object reference to element)
[ Top ] ### method drawOut [line 207]
`void drawOut( )`
renders this using writeln(). #### Tags:
access: | public
[ Top ] ### method newGroup [line 134]
`void newGroup( )`
adds a group separator. #### Tags:
access: | public
[ Top ] ### method render [line 144]
`string render( )`
renders the button bar and returns it. #### Tags:
return: | (html code)
access: | public
[ Top ] Documentation generated on Mon, 29 Dec 2003 22:18:15 +0100 by phpDocumentor 1.2.3