contenido\classes\widgets\class.widgets.treeview.php

Show:

inherited

Constants
Functions
Classes
- \cWidgetTreeView

Table of Contents

Constants

 
                TREEVIEW_GRIDLINE_SOLID
                = "solid"

 
                TREEVIEW_GRIDLINE_DASHED
                = "dashed"

 
                TREEVIEW_GRIDLINE_DOTTED
                = "dotted"

 
                TREEVIEW_GRIDLINE_NONE
                = "none"

 
                TREEVIEW_BACKGROUND_NONE
                = "none"

 
                TREEVIEW_BACKGROUND_SHADED
                = "shaded"

 
                TREEVIEW_MOUSEOVER_NONE
                = "none"

 
                TREEVIEW_MOUSEOVER_MARK
                = "mark"

\cWidgetTreeView
jump to top

Package: Default

class cWidgetTreeView cWidgetTreeView is a visual representation of a cTree.

It supports folding, optional gridline marks and item icons.

Parent(s): \cTree < \cTreeItem

Properties

array $_attributes

inherited

Contains custom entries

Inherited from: \cTreeItem::$$_attributes \cTree::$$_attributes

Details

Type: array
Inherited_from: \cTreeItem::$$_attributes
Inherited_from: \cTree::$$_attributes

$_baseLink

Details

Type: n/a

boolean $_collapsed

inherited

Determinates if this tree item is collapsed

Inherited from: \cTreeItem::$$_collapsed \cTree::$$_collapsed

Details

Type: boolean
Inherited_from: \cTreeItem::$$_collapsed
Inherited_from: \cTree::$$_collapsed

$_globalActions

Details

Type: n/a
Access: private

string $_id

inherited

ID for this item

Inherited from: \cTreeItem::$$_id \cTree::$$_id

Details

Type: string
Inherited_from: \cTreeItem::$$_id
Inherited_from: \cTree::$$_id

integer $_level

inherited

Contains the level of this item

Inherited from: \cTreeItem::$$_level \cTree::$$_level

Details

Type: integer
Inherited_from: \cTreeItem::$$_level
Inherited_from: \cTree::$$_level

string $_name

inherited

Name for this item

Inherited from: \cTreeItem::$$_name \cTree::$$_name

Details

Type: string
Inherited_from: \cTreeItem::$$_name
Inherited_from: \cTree::$$_name

array $_next

inherited

Contains the next item

Inherited from: \cTreeItem::$$_next \cTree::$$_next

Details

Type: array
Inherited_from: \cTreeItem::$$_next
Inherited_from: \cTree::$$_next

array $_parent

inherited

Contains the parent of this item

Inherited from: \cTreeItem::$$_parent \cTree::$$_parent

Details

Type: array
Inherited_from: \cTreeItem::$$_parent
Inherited_from: \cTree::$$_parent

array $_previous

inherited

Contains the previous item

Inherited from: \cTreeItem::$$_previous \cTree::$$_previous

Details

Type: array
Inherited_from: \cTreeItem::$$_previous
Inherited_from: \cTree::$$_previous

$_setAttributeActions

Details

Type: n/a
Access: private

$_setItemActions

Details

Type: n/a
Access: private

array $_subitems

inherited

Sub Items for this tree item

Inherited from: \cTreeItem::$$_subitems \cTree::$$_subitems

Details

Type: array
Inherited_from: \cTreeItem::$$_subitems
Inherited_from: \cTree::$$_subitems

$_treeIcon

inheritedInherited from: \cTree::$$_treeIcon

Details

Type: n/a
Inherited_from: \cTree::$$_treeIcon

$_unsetAttributeActions

Details

Type: n/a
Access: private

$_unsetItemActions

Details

Type: n/a
Access: private

Methods

_buildImagePath( $image) : void

Parameters

Name	Type	Description
$image

_flattenArray( $sourcearray, $destarray, $lastid, $level) : void

inherited

Inherited from: \cTreeItem::_flattenArray()\cTree::_flattenArray()

Parameters

Name	Type	Description
$sourcearray
$destarray
$lastid
$level

_getExpandCollapseIcon( $object) : void

Parameters

Name	Type	Description
$object

_setExpandCollapseLink( $link, $object) : void

Parameters

Name	Type	Description
$link
$object

addItem(\cTreeItem $item) : void

inherited

adds an item as a subitem to the current item

Inherited from: \cTreeItem::addItem()\cTree::addItem()

Parameters

Name	Type	Description
$item	\cTreeItem	item item object to add

Details

Access: public

addItemToID(string $id, \cTreeItem $item) : void

inherited

adds an item to a specific ID

Inherited from: \cTreeItem::addItemToID()\cTree::addItemToID()

Parameters

Name	Type	Description
$id	string	id ID to add the item to
$item	\cTreeItem	item Item to add

Details

Access: public

applyActionByItemAttribute(array $attributes, \cApiClickableAction $action) : void

Applies an action to all items with a certain attribute set.

Parameters

Name	Type	Description
$attributes	array	attributes Values which need to match. The array key is the attribute name. Multiple array entries are connected with "AND".
$action	\cApiClickableAction	action Action to apply

Details

Access: public

applyGlobalAction(\cApiClickableAction $action) : void

applies an action to all items in the tree.

Parameters

Name	Type	Description
$action	\cApiClickableAction	action action object

Details

Access: public

applyItemAction(mixed $item, \cApiClickableAction $action) : void

sets an action to a specific item.

Parameters

Name	Type	Description
$item	mixed	item cTreeItem-Object or an id of a TreeItem-Object
$action	\cApiClickableAction	action

Details

Access: public

cTree( $name = "") : void

inherited

Inherited from: \cTree::cTree()

Parameters

Name	Type	Description
$name

cTreeItem( $id = "", $name = "", $collapsed = false) : void

inherited

Inherited from: \cTreeItem::cTreeItem()\cTree::cTreeItem()

Parameters

Name	Type	Description
$id
$name
$collapsed

cWidgetTreeView( $uuid, $treename = false) : void

Parameters

Name	Type	Description
$uuid
$treename

collapseBelowID(int $id, $found = false) : void

inherited

Inherited from: \cTreeItem::collapseBelowID()\cTree::collapseBelowID()

Parameters

Name	Type	Description
$id	int	leveloffset Level offset. Ignores all expand operations below the offset.
$found

Details

Access: public

collapseBelowLevel(int $leveloffset) : void

inherited

Inherited from: \cTreeItem::collapseBelowLevel()\cTree::collapseBelowLevel()

Parameters

Name	Type	Description
$leveloffset	int	leveloffset Level offset. Ignores all expand operations below the offset.

Details

Access: public

deleteAttribute(string $attributeName) : void

inherited

deletes an attribute

Inherited from: \cTreeItem::deleteAttribute()\cTree::deleteAttribute()

Parameters

Name	Type	Description
$attributeName	string	attributeName

Details

Access: public

deleteItem(mixed $id) : \deleted

inherited

deletes a subitem

Inherited from: \cTreeItem::deleteItem()\cTree::deleteItem()

Parameters

Name	Type	Description
$id	mixed	item object or ID to delete

Returns

Type	Description
\deleted	object

Details

Access: public

expandBelowID(int $id, $found = false) : void

inherited

Inherited from: \cTreeItem::expandBelowID()\cTree::expandBelowID()

Parameters

Name	Type	Description
$id	int	leveloffset Level offset. Ignores all expand operations below the offset.
$found

Details

Access: public

expandBelowLevel(int $leveloffset) : void

inherited

Inherited from: \cTreeItem::expandBelowLevel()\cTree::expandBelowLevel()

Parameters

Name	Type	Description
$leveloffset	int	leveloffset Level offset. Ignores all expand operations below the offset.

Details

Access: public

exportTree() : array

inherited

Exports a tree as an array of arrays.

Inherited from: \cTreeItem::exportTree()\cTree::exportTree()

Array format: array( array("id" => "Item ID", "name" => "Item name", "level" => 1, "attributes" => array("attr_name" => "attr_value")) );

Returns

Type	Description
array

Details

Access: public

flatTraverse(integer $level = 0) : void

inherited

flatTraverse traverses the tree starting from this item, and returning all objects as $objects in a flat array.

Inherited from: \cTreeItem::flatTraverse()\cTree::flatTraverse()

Parameters

Name	Type	Description
$level	integer	Level to start on

flushActionByItemAttribute(array $attributes) : void

Removes all actions for items with specific attributes

Parameters

Name	Type	Description
$attributes	array	attributes Values which need to match. The array key is the attribute name. Multiple array entries are connected with "AND".

Details

Access: public

flushGlobalActions() : void

flushes all actions

Details

Access: public

flushItemActions(mixed $item) : void

flushes all actions for a specific item

Parameters

Name	Type	Description
$item	mixed	item cTreeItem-Object or an id of a TreeItem-Object

Details

Access: public

getAttribute(string $attributeName) : mixed

inherited

returns an attribute

Inherited from: \cTreeItem::getAttribute()\cTree::getAttribute()

Parameters

Name	Type	Description
$attributeName	string	attributeName

Returns

Type	Description
mixed

Details

Access: public

getCollapsedList(array $list) : void

inherited

getCollapsedList Returns all items (as ID array) which are collapsed.

Inherited from: \cTreeItem::getCollapsedList()\cTree::getCollapsedList()

Parameters

Name	Type	Description
$list	array	Contains the list with all collapsed items

getExpandedList(array $list) : void

inherited

getExpandedList Returns all items (as ID array) which are expanded.

Inherited from: \cTreeItem::getExpandedList()\cTree::getExpandedList()

Parameters

Name	Type	Description
$list	array	Contains the list with all expanded items

getItemByID(string $id) : \cTreeItem

inherited

Retrieves a specific item by its ID.

Inherited from: \cTreeItem::getItemByID()\cTree::getItemByID()

Note that this function traverses all subitems to find the correct item.

Parameters

Name	Type	Description
$id	string	id ID to retrieve

Returns

Type	Description
\cTreeItem

Details

Access: public

hasAttribute( $attributeName, $bRecursive = false) : void

inherited

Inherited from: \cTreeItem::hasAttribute()\cTree::hasAttribute()

Parameters

Name	Type	Description
$attributeName
$bRecursive

importStructuredArray( $array) : void

inherited

Inherited from: \cTreeItem::importStructuredArray()\cTree::importStructuredArray()

Parameters

Name	Type	Description
$array

importTable(array $flat_array) : void

inherited

Imports a table from an array of arrays.

Inherited from: \cTreeItem::importTable()\cTree::importTable()

Array format: array( array("id" => "Item ID", "name" => "Item name", "level" => 1, "collapsed" => true|false, "attributes" => array("attr_name" => "attr_value")) );

The entries "collapsed" and "attributes" are optional!

Parameters

Name	Type	Description
$flat_array	array	flat_array See above

Details

Access: public

moveItem(\cTreeItem $targetItem, mixed $itemToMove) : void

inherited

moves an item to another object

Inherited from: \cTreeItem::moveItem()\cTree::moveItem()

Parameters

Name	Type	Description
$targetItem	\cTreeItem	targetItem Item to move the subitem to
$itemToMove	mixed	itemToMove cTreeItem-Object or id of object to move

Details

Access: public

processParameters() : void

removeActionByItemAttribute(array $attributes, \cApiClickableAction $action) : void

Removes an action from all items with a certain attribute set.

Parameters

Name	Type	Description
$attributes	array	attributes Values which need to match. The array key is the attribute name. Multiple array entries are connected with "AND".
$action	\cApiClickableAction	action Action to remove

Details

Access: public

removeGlobalAction(\cApiClickableAction $action) : void

removes the action from all treeitems.

Parameters

Name	Type	Description
$action	\cApiClickableAction	action Removes the action from the global context.

Details

Access: public

removeItemAction(mixed $item, \cApiClickableAction $action) : void

unsets an action from a specific item.

Note that you can unset global actions using this method!

Parameters

Name	Type	Description
$item	mixed	item cTreeItem-Object or an id of a TreeItem-Object
$action	\cApiClickableAction	action Action to unset

Details

Access: public

render( $with_root = true) : void

Parameters

Name	Type	Description
$with_root

Details

Access: public

setAttribute(string $attributeName, array $attributeValue) : void

inherited

sets a custom attribute for this TreeItem

Inherited from: \cTreeItem::setAttribute()\cTree::setAttribute()

Parameters

Name	Type	Description
$attributeName	string	attributeName
$attributeValue	array	attributeValue The value(s) of the attribute

Details

Access: public

setAttributes(string $aAttributeArray) : void

inherited

sets a bunch of attributes

Inherited from: \cTreeItem::setAttributes()\cTree::setAttributes()

Parameters

Name	Type	Description
$aAttributeArray	string	attributeName

Details

Access: public

setBackgroundColors( $colors) : void

Parameters

Name	Type	Description
$colors

setBackgroundMode( $mode) : void

Parameters

Name	Type	Description
$mode

setBaseLink( $link) : void

Parameters

Name	Type	Description
$link

setCollapsed(mixed $id) : void

inherited

Inherited from: \cTreeItem::setCollapsed()\cTree::setCollapsed()

Parameters

Name	Type	Description
$id	mixed	collapse ID to collapse or an array with items to collapse

Details

Access: public

setExpanded(mixed $id) : void

inherited

Inherited from: \cTreeItem::setExpanded()\cTree::setExpanded()

Parameters

Name	Type	Description
$id	mixed	expand ID of item to expand or array of item ID's to expand

Details

Access: public

setGridlineMode(int $mode) : void

Parameters

Name	Type	Description
$mode	int	mode Sets the gridline mode to one of the following values: TREEVIEW_GRIDLINE_SOLID TREEVIEW_GRIDLINE_DASHED TREEVIEW_GRIDLINE_DOTTED TREEVIEW_GRIDLINE_NONE

Details

Access: public

setIcon( $path) : void

inherited

Inherited from: \cTree::setIcon()

Parameters

Name	Type	Description
$path

setMouseoverMode( $mode) : void

Parameters

Name	Type	Description
$mode

setName(string $name) : \none

inherited

setName sets the Name for this item.

Inherited from: \cTreeItem::setName()\cTree::setName()

Parameters

Name	Type	Description
$name	string	New name for this item

Returns

Type	Description
\none

setPayloadObject(object $payload) : void

inherited

sets a payload object for later reference

Inherited from: \cTreeItem::setPayloadObject()\cTree::setPayloadObject()

Parameters

Name	Type	Description
$payload	object	payload The object to payload

Details

Access: public

setTreeName(string $name) : void

inherited

sets a new name for the tree.

Inherited from: \cTree::setTreeName()

Parameters

Name	Type	Description
$name	string	name Name of the tree

Details

Access: public

traverse(object $objects, integer $level = 0) : void

inherited

traverse traverses the tree starting from this item, and returning all objects as $objects in a nested array.

Inherited from: \cTreeItem::traverse()\cTree::traverse()

Parameters

Name	Type	Description
$objects	object	all found objects
$level	integer	Level to start on

unsetPayloadObject() : object

inherited

unsets a payload object

Inherited from: \cTreeItem::unsetPayloadObject()\cTree::unsetPayloadObject()

Returns

Type	Description
object

Details

Access: public

contenido\classes\widgets\class.widgets.treeview.php

Constants

\cWidgetTreeViewjump to top

Properties

Methods

\cWidgetTreeView
jump to top