NAME

IWL::Druid::Page - a page in a druid

INHERITANCE

IWL::Error -> IWL::Object -> IWL::Widget -> IWL::Container -> IWL::Druid::Page

DESCRIPTION

The druid page widget is a helper widget used by the IWL::Druid

CONSTRUCTOR

IWL::Druid::Page->new ([%ARGS])

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

SIGNALS

select

Fires when the page is selected

unselect

Fires when the page is unselected

remove

Fires when the page is removed

EVENTS

IWL-Druid-Page-next

Emitted when the next druid page has been requested. A custom event handler is used. The perl callback for it has to return an arrayref of IWL::Widgets. As a second return parameter, the perl callback can return the following parameters in the hash reference:

newId => STRING

The ID of the newly created page.

deter

If true, the user should be stopped from proceeding to the next page.

expression => EXPRESSION

If deter is true, the javascript expression will be evaluated.

next => {url => URL, params => HASH, options => HASH}

Registers an IWL-Druid-Page-next event for the new page.

previous => {url => URL, params => HASH, options => HASH}

Registers an IWL-Druid-Page-previous event for the new page.

final => {url => URL, params => HASH, options => HASH}

Registers an IWL-Druid-Page-final event for the new page.

IWL-Druid-Page-previous

Emitted when the previous druid page has been requested. A custom event handler is used. The perl callback for it has to return an arrayref of IWL::Widgets. The paramaters hashref contains are the same as in IWL-Druid-Page-next

IWL-Druid-Page-final

Emitted when the previous druid page has been requested. The default event handler is used. See IWL::RPC::handleEvent for more details.

METHODS

setFinal (BOOL)

Makes the page the final one, thus changing the 'next' button to a 'finish'

isFinal

Returns true if the page is the final page in the druid

setSelected (BOOL)

Sets whether the page is the currently selected page

Parameters: BOOL - true if the page should be the currently selected one

isSelected

Returns true if the page is the currently selected one

setCheckCB (CALLBACK, PARAM, COLLECT)

Sets the check callback for the page

Parameters: CALLBACK - the function to be called when pressing the NEXT button (if it returns true, the druid will proceed to the next page), PARAM the parameter of the callback, COLLECT - if true, collects all the control elements inside the page, and converts their names and values into a hash

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.