$afterCaptionSpan =
[line 240]
html code that's put inside a span tag and displayed after the caption text.
Tags:
$beforeCaptionSpan =
[line 232]
html code that's put inside a span tag and displayed before the caption text.
could also be named afterIconSpan. it's between the icon and the caption.
Tags:
$beforeIconSpan =
[line 223]
html code that's put inside a span tag and displayed before the "folder" icon.
Tags:
$caption =
[line 55]
the visible text.
use setCaption() to modify it if it's already outrendered.
Tags:
$checkboxName =
[line 138]
the name of the checkbox. not defined = don't use it.
gets set in this.initByArray().
Tags:
$dataContainer =
[line 261]
can be used to stick in any data.
this is useful if you want to init your tree with a data array, and on the click of a node something should happen. but then the node misses some related information.
hrm, let's give you an example: your tree looks like a directory tree, with dirs and files. when the user clicks on a file, you want to show in a div the size in kb of this file. but the tree does not know this. the tree just fires a registered function, and tells which node was clicked. but you don't have the nodeId-to-file relation. so what? well, much easier if you can stick in your data into the tree element directly, and later read that data. hrm, got the idea?
Tags:
$divStyle =
[line 83]
see Bs_Tree->divStyle, it's the same, you can simply overwrite it here.
then it will be used for this and everything beyond that (also see Bs_Tree->walkTree!).
Tags:
$icon =
[line 215]
if not set then the default icons will be used.
this means that both icons folderOpen.gif and folderClosed.gif have to exist in the image dir (see this.imageDir).
set to bool false if you don't want an icon.
set to a string for an image (in the same img dir as the others, see imageDir). use the file ending (.gif or so) as well. if your icon is in another dir, you can give the path also. but then it has to start with a slash / or http:// or https://.
examples: myIcon.gif myIcon.png /some/dir/myIcon.jpg http://www.blueshoes.org/_bsImages/buttons/globes/1.gif
Tags:
$id =
[line 33]
the unique identifier of this element.
for the built in auto-sequence (Bs_Tree.useAutoSequence) this is an int >0, but if you use your own handling it can be a string aswell.
Tags:
$imageDir =
[line 185]
see Bs_Tree->imageDir, it's the same, you can simply overwrite it here.
then it will be used for this and everything beyond that (also see Bs_Tree->walkTree!).
Tags:
$imageHeight =
[line 193]
see Bs_Tree->imageHeight, it's the same, you can simply overwrite it here.
then it will be used for this and everything beyond that (also see Bs_Tree->walkTree!).
Tags:
$isChecked = 0
[line 130]
used if the checkbox feature is used.
- = not checked
- = checked gray (part of the sub-elements are, part are not)
- = checked (this or everything below is checked)
now i think it's a dirty name. isChecked sounds like a function, not a var. but it's public, so i don't feel like renaming it and changing it everywhere. and checked sounds like boolean, not integer with 3 possibilities. (historic reasons when there was just true/false ...)
Tags:
$isOpen = false
[line 103]
stores if this tree node is open or not.
Tags:
$linkStyle =
[line 75]
see Bs_Tree->linkStyle, it's the same, you can simply overwrite it here.
then it will be used for this and everything beyond that (also see Bs_Tree->walkTree!).
Tags:
$onClick =
[line 96]
javascript code that fires on the onClick event.
can go together with an url, they don't byte each other.
special case: may use the string __this.id__ it will be replaced with the actual id. example: yourElement.onClick = "doThis(__this.id__, 'foobar');"
Tags:
$parent =
[line 39]
reference to the parent tree element object.
$radioButtonSelected =
[line 147]
if the radio button of this element should be selected by default. only one can be!
Tags:
$target =
[line 67]
Tags:
$url =
[line 61]
Tags:
$visible = true
[line 111]
if set to false then the element will be set to display:none.
it's still there (loaded) so you can use its methods etc.
Tags:
$_level = 0
[line 161]
the level this element is in. think about the identing.
Tags:
$_tree =
[line 46]
reference to the tree object.
Tags: