The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

IWL::Tree::Row - a row widget

INHERITANCE

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

DESCRIPTION

The Row widget provides a row for IWL::Tree. It inherits from IWL::Table::Row.

CONSTRUCTOR

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

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

SIGNALS

select

Fires when the row is selected

unselect

Fires when the row is unselected

remove

Fires when the row is removed

activate

Fires when the row is activated

collapse

Fires when the row has collapsed

expand

Fires when the row has expanded

EVENTS

IWL-Tree-Row-expand

Emitted when a row is expanded. A custom event handler is used. The perl callback for it has to return an arrayref of IWL::Tree::Rows, which will be added as children of the row.

METHODS

appendRow (ROW)

Adds a row as a child of another row in the tree.

Parameters: ROW - the row to be appended

prependRow (ROW)

Prepends a row as a child of another row in the tree.

Parameters: ROW - the row to be prepended

getChildRows (FLAT)

Returns a list of the row objects appended or empty list if no rows have been appended.

Parameters: FLAT - false if the method should return all the subrows on all levels

expand (BOOL)

Expands or collapses the row

Parameters: BOOL - true if the row should be expanded

makeParent

Makes the row a parent row, even if it currently has no children

getPath

Returns the row's path. The path itself is set when the row is appended to the tree or to another row.

setPath

Sets the row's path explicitly. The path then can be used to append child rows.

getPrevRow

Returns the previous row on the same level.

getNextRow

Returns the next row on the same level.

setSelected (BOOL)

Sets whether the row is the currently selected row.

Parameters: BOOL - true if the row should be selected

isSelected

Returns true if the row is selected

METHODS

getParentRow

Returns the parent rows of the current row, if it has any

getFirstChildRow

Returns the first childr row of the current row.

getLastChildRow

Returns the last child row of the current row

getFromPath (PATH)

Returns a row from a given path

Parameters: PATH - the path array

setNavigation (BOOL)

setNavigation is used to enable or disable the naviagtion of the row. by default the navigation is enabled.

Parameters: BOOL - a boolean value, true if navigation should be enabled

makeSortable (COL_NUM, [CALLBACK, URL])

Sorts the tree when the column is clicked. Should only be used for header rows.

Parameters: COL_NUM - the column number, which will be used for sorting. CALLBACK - an optional callback to be called instead of the default, URL - URL of an ajax script to sort the tree and return the new content (with getContent()), CALLBACK has no effect if URL is set.

LICENCE AND COPYRIGHT

Copyright (c) 2006-2008 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.

2 POD Errors

The following errors were encountered while parsing the POD:

Around line 341:

You forgot a '=back' before '=head1'

Around line 560:

You forgot a '=back' before '=head1'