NAME

IWL::Accordion - an accordion widget

INHERITANCE

IWL::Error -> IWL::Object -> IWL::Widget -> IWL::Container -> IWL::Accordion

DESCRIPTION

The accordion widget provided a way to stack content into an expandable container

CONSTRUCTOR

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

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

horizontal

True if the accordion should have a horizontal orientation. Note that a horizontal accordion must have a height style set

resizeSpeed

The speed (0 - 10), at which the pages change. Set to 11 have an instant change. Defaults to 8

eventActivation

The event, which will trigger the page change. Example events are click, mouseover, mouseout, ... Defaults to click

defaultSize

The default size of the accordion pages. A hashref with the optional keys width and height, and numeric values.

METHODS

appendPage (TEXT, [OBJECT, SELECTED])

Appends a new page and adds the object to the page

Parameter: OBJECT - the IWL::Object to be appended, TEXT - the text for the page title, SELECTED - true if the page should be the selected one

Returns: the newly created page

prependPage (TEXT, [OBJECT, SELECTED])

Prepends a new page and adds the object to the page

Parameter: OBJECT - the IWL::Object to be prepended, TEXT - the text for the page title, SELECTED - true if the page should be the selected one

Returns: the newly created page

setOrientation (ORIENTATION)

Sets the orientation of the accordion

Parameters: ORIENTATION - the orientation, can be either vertical or horizontal

Note: if the orientation is horizontal, the accordion must have a height style. Also, it is preferrable if some width is set through the "setDefaultSize" method

getOrientation

Returns the orientation of the accordion

setResizeSpeed (SPEED)

Sets the resize speed of the accordion

Parameters: SPEED - the resize speed, between 0 and 10, and 11 for instant

getResizeSpeed

Returns the resize speed of the accordion

setEventActivation (EVENT)

Sets the event, which will trigger the page change.

Parameters: EVENT - the event, which will trigger the page change. Example events are click, mouseover, mouseout, .... Defaults to click

getEventActivation

Returns the event, which will trigger the page change

setDefaultSize (%SIZE)

Sets the default size of the accordion pages

Parameters: %SIZE - the size hash, with optional width and height keys, and numeric values, representing the size in pixels

getDefaultSize

Returns the default size of the accordion pages

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.