>Home
>Features
>How does it work?
>Documentation
>Tutorials
>Examples
>Help Forum
>Download
>Extensions
>GitHub Project

Class: TreeDataSet

Source Location: /class/customTree.php.inc

Class Overview

TreeDataSupports
   |
   --TreeDataSet




Variables

Methods

Inherited Variables

Class: TreeDataSupports

TreeDataSupports::$children
TreeDataSupports::$dataSet

Inherited Methods

Class: TreeDataSupports

TreeDataSupports::addRow()
TreeDataSupports::getColumnIndex()
TreeDataSupports::insertRow()
TreeDataSupports::insertRowAfter()
TreeDataSupports::insertRowBefore()
TreeDataSupports::removeRow()
TreeDataSupports::sort()

Class Variables

$colSortTypes = array()

access:  public
Type:   mixed

$colTypes = array()

access:  public
Type:   mixed

$columnProperties = array()

access:  public
Type:   mixed

$columns = array()

access:  public
Type:   mixed

$idToRow = array()

access:  public
Type:   mixed

$isSparse =  FALSE

access:  public
Type:   mixed

$nextIndex =  0

access:  public
Type:   mixed

$preventCircularHeritage =  TRUE

access:  public
Type:   mixed

$sortable =  FALSE

access:  public
Type:   mixed

$sortColumn =  NULL

access:  public
Type:   mixed

$sortDirection =  'asc'

access:  public
Type:   mixed

Class Methods

constructor __construct() [line 881]

TreeDataSet __construct( $tree, [ $sparse = FALSE])

access:  public

Parameters:

   $tree  
   $sparse  

[ Top ]

method allowDrop() [line 1013]

void allowDrop( bool $allow, [string $type = 'any'])

access:  public

Parameters:

bool   $allow   Allow or disallow dropping nodes
string   $type   Allow to drop on, between or any (Default is any)

[ Top ]

method allowFileDrop() [line 958]

void allowFileDrop( bool $allow)

access:  public

Parameters:

bool   $allow   Allow or disallow droppin of files

[ Top ]

method allowForeignDrop() [line 951]

void allowForeignDrop( bool $allow)

access:  public

Parameters:

bool   $allow   Allow or disallow the dropping of rows from other trees

[ Top ]

method createRow() [line 1030]

void createRow( [object/array $data = NULL], [boolean $container = FALSE])

access:  public

Parameters:

object/array   $data   Row data
boolean   $container   Row can function as container for childrows

[ Top ]

method createSeparator() [line 1034]

void createSeparator( )

access:  public

[ Top ]

method preventCircularHeritage() [line 909]

void preventCircularHeritage( boolean $state)

access:  public

Parameters:

boolean   $state   Allow of disallow protecting the tree from adding parent nodes to their own child nodes

[ Top ]

method setColumnProperties() [line 938]

void setColumnProperties( string $column, array $properties)

access:  public

Parameters:

string   $column   Column data id
array   $properties   Array of properties

[ Top ]

method setColumnSortType() [line 926]

void setColumnSortType( object $col, $type, string|array $method)

Sets the sorting type method for a column The sorting type may be a string ("natural", "alphanumeric", "numeric", "date") or a custom callback array in the form of an array($classOrObject, $methodName).

access:  public

Parameters:

object   $col   XULTreeCol node
string|array   $method   Sorting type method, a string or a callback array containing object/classname and handler method.
   $type  

[ Top ]

method setDraggable() [line 996]

void setDraggable( bool $allow, [string $type = 'move'])

access:  public

Parameters:

bool   $allow   Allow or disallow rows being dragged
string   $type   Type of moving cursor while dragging ( move , copy , link , moveOrCopy )( Default is move )

[ Top ]

method setSortable() [line 916]

void setSortable( boolean $state)

access:  public

Parameters:

boolean   $state   Allow of disallow sortable columns

[ Top ]

method sortColumn() [line 966]

void sortColumn( int $col, [mixed $dir = NULL])

access:  public

Parameters:

int   $col   Integer column index
mixed   $dir   Sort direction ( default is Ascending )

[ Top ]

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