Strict Standards: Only variables should be passed by reference in /home/webperfect/sfdocmaker/phpdoc/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Strict Standards: Only variables should be passed by reference in /home/webperfect/sfdocmaker/phpdoc/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Strict Standards: Only variables should be passed by reference in /home/webperfect/sfdocmaker/phpdoc/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Strict Standards: Only variables should be passed by reference in /home/webperfect/sfdocmaker/phpdoc/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Strict Standards: Only variables should be passed by reference in /home/webperfect/sfdocmaker/phpdoc/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Strict Standards: Only variables should be passed by reference in /home/webperfect/sfdocmaker/phpdoc/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Strict Standards: Only variables should be passed by reference in /home/webperfect/sfdocmaker/phpdoc/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Strict Standards: Only variables should be passed by reference in /home/webperfect/sfdocmaker/phpdoc/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Strict Standards: Only variables should be passed by reference in /home/webperfect/sfdocmaker/phpdoc/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Strict Standards: Only variables should be passed by reference in /home/webperfect/sfdocmaker/phpdoc/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Strict Standards: Only variables should be passed by reference in /home/webperfect/sfdocmaker/phpdoc/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 Docs For Class BranchNode - SiteFusion

Class: BranchNode

Source Location: /sys/branchNode.php.inc

Class Overview

Node
   |
   --BranchNode

This class represents all nodes that are capable of having childnodes

It adds methods for adding, inserting, removing and extracting nodes.




Variables

Methods

Inherited Variables

Class: Node

Node::$behavior
Node::$eventHandler
Node::$eventType
Node::$eventYielder
Node::$handlerFor
Node::$id
Node::$isChild
Node::$isRegistered
Node::$observerTopics
Node::$parent
Node::$rootApplication
Node::$rootWindow
Node::$yielderFor

Inherited Methods

Class: Node

Node::__construct()
Dynamic Constructor
Node::accessKey()
Set the accessKey attribute for this element
Node::addBehavior()
Add a behavior class
Node::addObserver()
Add an observer to this Node
Node::align()
Set the align attribute for this element
Node::attach()
[INTERNAL FUNCTION] Default attach method
Node::attributeMethod()
Convenient attribute setter
Node::backgroundColor()
Set the background color for the element
Node::backgroundImage()
Set the background of a node using CSS background-image property
Node::BehaviorCreateClass()
Constructs a Behavior class from a string classname and a settings array.
Node::BehaviorSetClassSettings()
Automatically initializes Behavior object
Node::blur()
Make this node loose focus
Node::callMethod()
Call a JavaScript method on the client-side node
Node::callMethodDelayed()
Call a JavaScript method on the client-side node in a delayed fashion
Node::className()
Set the CSS classname for the element
Node::commandHandler()
[INTERNAL FUNCTION] Handles an incoming event for this node
Node::context()
Set a contextmenu to show when clicking the context (right) mouse or keyboard button on this element
Node::createClientEvent()
Creates a new event on the client side
Node::createRemoteObject()
[INTERNAL FUNCTION] Calls the remote constructor of this class
Node::crop()
Set the crop attribute for this element
Node::detach()
[INTERNAL FUNCTION] Default detach method
Node::disableBehavior()
Disable behavior
Node::disabled()
Set the disabled attribute for this element
Node::enableBehavior()
Enable behavior
Node::equalsize()
Set the equalsize attribute for this element
Node::extractNode()
Extracts this node and its childnodes
Node::findAncestor()
Return the first ancestor of a certain class of this node
Node::fireClientEvent()
Fires a remote (client) event
Node::fireLocalEvent()
Fires a local (server) event
Node::flex()
Set the flex attribute for this element
Node::focus()
Give this node focus
Node::getBehavior()
Get a behavior class.
Node::height()
Set the height of the element
Node::hidden()
Set the hidden attribute for this element
Node::initNodeLayout()
[INTERNAL FUNCTION] Initializes the attributes of a node when it is registered
Node::insertElement()
[INTERNAL FUNCTION] Inserts the newly constructed node's element into the DOM tree on the client side
Node::label()
Set the label attribute for this element
Node::margin()
Set the margin of the element
Node::marginBottom()
Set the bottom margin of the element
Node::marginLeft()
Set the left margin of the element
Node::marginRight()
Set the right margin of the element
Node::marginTop()
Set the top margin of the element
Node::mousethrough()
Indicate whether mouse events should pass through this node onto its parent
Node::orient()
Set the orient attribute for this element
Node::pack()
Set the pack attribute for this element
Node::padding()
Set the padding of the element
Node::paddingBottom()
Set the bottom padding of the element
Node::paddingLeft()
Set the left padding of the element
Node::paddingRight()
Set the right padding of the element
Node::paddingTop()
Set the top padding of the element
Node::popup()
Set a popup menu to show when clicking on this element
Node::removeAttribute()
Remove an attribute on the client-side XUL node
Node::removeBehavior()
Delete behavior
Node::removeElement()
[INTERNAL FUNCTION] Removes the node's element from the client DOM tree
Node::removeEventHandler()
Removes an event handler
Node::removeEventReflex()
Removes a previously set reflex for a certain event
Node::removeEventYielder()
Removed a node this is yielded when an event on this node fires
Node::removeNode()
Removes and unregisters this node and its childnodes
Node::removeObserver()
Remove an observer from this Node
Node::removeObservers()
Remove all observers from this Node
Node::setAttribute()
Set an attribute on the client-side XUL node
Node::setDraggable()
Set this element as draggable
Node::setDroppable()
Set this element as a dropzone
Node::setEvent()
Shorthand version for setEventType, setEventHandler and setEventYielder
Node::setEventBlocking()
Sets whether the event should block (be synchronous)
Node::setEventHandler()
Sets an event handler
Node::setEventReflex()
Sets a reflex for a certain event
Node::setEventType()
Sets the event type for a certain event
Node::setEventYielder()
Sets a node to yield when an event on this node fires
Node::setMethod()
Set a JavaScript method on the client-side node
Node::setProperty()
Set a JavaScript property on the client-side node
Node::setStyle()
Set a CSS style property on the client-side XUL node
Node::size()
Set the size of the element
Node::textColor()
Set the text color for the element
Node::textSize()
Set the text size for the element
Node::textStyle()
Set the text style for the element
Node::tooltip()
Set a tooltip to show when hovering over this element
Node::tooltiptext()
Set the tooltiptext attribute for this element
Node::unbind()
[INTERNAL FUNCTION] Removes links to child and parent nodes
Node::unlink()
[INTERNAL FUNCTION] Removes event handler and yielder links to other nodes
Node::unRegister()
[INTERNAL FUNCTION] Removes this node from the client registry
Node::value()
Set the value attribute for this element
Node::width()
Set the width of the element
Node::yield()
Manually yield this node
Node::_dropHandler()
Node::__call()
PHP Magic function: Behavior pattern handler.

Class Variables

$children = array()

access:  public
Type:   mixed



Class Methods


method addChild() [line 50]

mixed addChild( mixed $nodes)

Add one or more nodes to this node's child collection

return:  Returns a reference to self ($this) for easy chaining of method calls
access:  public

Parameters:

mixed   $nodes   One or more nodes or array(s) of nodes to add

[ Top ]

method addChildAfter() [line 136]

mixed addChildAfter( Node $node, Node $childnode)

Add a new childnode after an existing one

return:  Returns a reference to self ($this) for easy chaining of method calls
access:  public

Parameters:

Node   $node   New node
Node   $childnode   Existing node after which to insert the new node

[ Top ]

method addChildBefore() [line 97]

mixed addChildBefore( Node $node, Node $childnode)

Add a new childnode before an existing one

return:  Returns a reference to self ($this) for easy chaining of method calls
access:  public

Parameters:

Node   $node   New node
Node   $childnode   Existing node before which to insert the new node

[ Top ]

method addChildFirst() [line 161]

mixed addChildFirst( mixed $nodes)

Adds one or more new childnodes in front of all existing childnodes

return:  Returns a reference to self ($this) for easy chaining of method calls
access:  public

Parameters:

mixed   $nodes   One or more nodes or array(s) of nodes to add

[ Top ]

method extractChild() [line 257]

Node|array extractChild( mixed $nodes)

Extracts one or more childnodes from this node's child collection

Use this method if you intend to reuse the node(s), this will unset every event handler bound to the node(s)


return:  The removed node or array of nodes
see:  Node::extractNode()
access:  public

Parameters:

mixed   $nodes   One or more nodes or array(s) of nodes to remove

[ Top ]

method extractChildren() [line 330]

Node|array extractChildren( )

Extracts all childnodes from this node's child collection

Use this method if you intend to reuse the nodes


return:  The removed node or array of nodes
see:  Node::extractNode()
access:  public

[ Top ]

method findChild() [line 342]

int|NULL findChild( $child)

Get the index of a child node

Returns the index of the given childnode (as in the $children array) or NULL if not found


return:  The index of the childnode or NULL if not found
access:  public

Parameters:

   $child  

[ Top ]

method getDescendants() [line 372]

void getDescendants( [string|array $className = NULL], [array $properties = NULL], [bool $strict = FALSE])

Recursively collects all nodes under this node

Examples:

Return all nodes under $node: $node->getDescendants();

Return all nodes of class XULTextBox: $node->getDescendants( 'XULTextBox' );

Return all nodes of either the XULTextBox or XULCheckbox: $node->getDescendants( array('XULTextBox','XULCheckbox') );

Return all checkboxes that are checked: $node->getDescendants( 'XULCheckbox', array( 'checked' => TRUE ) );


access:  public

Parameters:

string|array   $className   When supplied, only nodes of the given class(es) are returned
array   $properties   Optional associative array of property names and values that nodes are checked against
bool   $strict   Apply strict comparison (===) of the given properties

[ Top ]

method registerChildren() [line 185]

void registerChildren( )

[INTERNAL FUNCTION] Registers childnodes, called when this node is registered

access:  public

[ Top ]

method removeChild() [line 212]

bool removeChild( mixed $nodes)

Removes one or more childnodes from this node's child collection

Use this method if you don't intend to reuse the node(s)


return:  Whether the operation was successful
see:  Node::removeNode()
access:  public

Parameters:

mixed   $nodes   One or more nodes or array(s) of nodes to remove

[ Top ]

method removeChildren() [line 317]

bool removeChildren( )

Removes all childnodes from this node's child collection

Use this method if you don't intend to reuse the removed nodes


return:  Whether the operation was successful
see:  Node::removeNode()
access:  public

[ Top ]

method unregisterChildren() [line 297]

void unregisterChildren( )

[INTERNAL FUNCTION] Registers childnodes, called when this node is registered

access:  public

[ Top ]


Child classes:

XULTabBox
Tabbox element
XULTabs
Tabs element
XULTab
Tab element
XULTabPanels
Tabpanels element
XULTabPanel
Tabpanel element
XULGroupBox
Groupbox element
XULCaption
Caption element
XULTree
Tree element
XULTreeCols
Treecols element
XULTreeCol
Treecol element
XULTreeChildren
Treechildren element
XULTreeItem
Treeitem element
XULTreeRow
Treerow element
XULTreeCell
Treecell element
XULToolBox
Toolbox element
XULToolBar
Toolbar element
XULToolBarButton
Toolbarbutton element
XULListBox
Listbox element
XULListItem
Listitem element
XULListCols
Listcols element
XULListCol
Listcol element
XULListHead
Listhead element
XULListHeader
Listheader element
XULListCell
Listcell element
XULStatusbar
Statusbar element
XULStatusbarPanel
StatusbarPanel element
XULDialogHeader
Dialog header element
XULMenuBar
Menubar element
XULMenuPopup
Menupopup element
XULMenu
Menu element
XULMenuItem
Menuitem element
XULPopupSet
Popupset element
XULPopup
Popup element
XULToolTip
Tooltip element
XULPanel
Panel element
XULArrowScrollBox
Arrowscrollbox element
XULBasicWindow
Basic window functionality
XULPrefPane
PrefPane element
XULKeySet
Keyset element
XULEditor
XULBox
Box element
XULStack
Stack element
XULDeck
Deck element
XULGrid
Grid element
XULColumns
Columns element
XULRows
Rows element
XULColumn
Column element
XULRow
Row element
XULDescription
Description element
XULButton
Button element
XULSplitter
Splitter element
XULTextBox
Textbox element
XULCheckBox
Checkbox element
XULRadioGroup
Radiogroup element
XULRadio
Radio element
XULMenuList
Menulist element
XULSourceEditor
This class controls the client component SourceEditor

Documentation generated on Mon, 07 Apr 2014 00:50:46 +0200 by phpDocumentor 1.4.3