NAME

IWL::Tree - a tree widget

INHERITANCE

IWL::Object -> IWL::Widget -> IWL::Table -> IWL::Tree

DESCRIPTION

The tree widget provides a container that holds cells arranged in a tree layout, with multiple rows. Inherits from IWL::Table(3pm)

CONSTRUCTOR

IWL::Tree->new ([%ARGS])

Where %ARGS is an optional hash parameter with with key-values:

list

Boolean. true if the tree is a list.

multipleSelect

True if the iconbox should be able to select multiple icons

scrollToSelection

True if the selected row should be scrolled into visibility

alternate

True if the tree should alternate

animate

True if the tree should animate the collapse of its rows

SIGNALS

select_all

Fires when all rows of the tree have been selected

unselect_all

Fires when all rows of the tree have been unselected

row_activate

Fires when a row has been activated by double-clicking on it, or pressing [Enter]

row_collapse

Fires when a row has collapsed

row_expand

Fires when a row has expanded

METHODS

getAllBodyRows

Returns an array of all the body rows of the tree

setList (BOOL)

Sets whether the tree is a list

Parameters: BOOL - a boolean value

isList

Returns true if the tree is a list

setSortableCallback (COL_INDEX, JS_CALLBACK)

Sets the callback to provide the sorting function for the tree/list, based on the column with index COL_NUM

Parameters: COL_INDEX - the column index, JS_CALLBACK - the javascript callback, which will receive the column index as a parameter, and must return a sorting function for the rows

appendRow (ROW)

Appends an array of rows to the body to the tree. An alias to the appendBody method.

Parameters: ROW - a row of IWL::Tree::Row(3pm)

prependRow (ROW)

Prepeds an array of rows to the body to the tree. An alias to the prependBody method.

Parameters: ROW - a row of IWL::Tree::Row(3pm)

LICENCE AND COPYRIGHT

Copyright (c) 2006-2007 Viktor Kojouharov. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perldoc perlartistic.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.