HTML::GUI::screen - Create and control a whole screen for web application
Version 0.01
Manage a screen : it loads its definition with a YAML file and create all the widgets it contains. It can generate javascript code to check constraints on the web page. It can test if constraints of each widget are OK. It can generate the HTML of each widget for use with HTML::Template.
create a new screen
Description : specialized version of widget::setProp for managing functions associated with the screen
Parameters : Return : string Description : Return the javascript code to enforce the constraints of the widgets (describe each constraint for each widget); this code must be inserted in the header of the HTML page.
Description: Retrieve from the http form data the data describing the current screen Parameters : params : the hash containing the params retrieve from the HTTP form submit Return : a hash ref containing the description data (screen name...)
Return : a string containing the html of the hidden fields containing usefull data for describing the screen (for example, the name of the screen) To generate a valid Html document, we insert the the hidden field into an invisible div.
Return : a string containing the html of the webpage for the screen.
Return : return 1 if no field of the screen break no constraint return 0 if one or more field break constraint
Returns : propHash : hash : a hash containing the value '1' pour each public propertie
Parameters : - $actionFunction : the function to execute - $session : a hash ref to the session Description : Execute the function $actionFunction with the values of the screen Returns :
Parameters : - $params : hash ref containing the POST data Description : - do all the stuff when a user press a buton Returns : - the screen to display to the user ; it can be a new one if needed
Description - execute the handler whose name is $handlerName on the $newScreen object if the handle is defined. When the handler is called, it is called with $params as parameters
Description : - determine what is the next screen to display to the user and populate it with the messages and user data Returns : - the screen to display to the user ; it can be a new one if needed
Parameters : - $path : the path of the next screen - $params : hash ref containing the optional params to call the next screen (for example imagine the next screen is customer_info and the param is {customer_id => 254412} - $values : you can specify all the values you want to feed your screen (in the way you get the values from getValueHash() ) Description : - determine what is the next screen to display to the user and populate it with the messages and user data Returns : - the screen to display to the user ; it can be a new one if needed
Description : - define the next dialog to show to the end user. The difference between a dialog and a screen is that a dialog can be closed (like a popup window). Parameters : - $path : the path of the next screen - $params : hash ref containing the optional params to call the next screen (for example imagine the next screen is customer_info and the param is {customer_id => 254412} - $values : you can specify all the values you want to feed your screen (in the way you get the values from getValueHash() )
Description : - close the current dialog. MUST only be called on an dialog screen. Parameters : - $params : hash ref containing the optional params that will be used as parameters for the dialogCallBack function.
Description : - Specialization of the error function for all generic messages for the end user parameters : - $message : the message to display to the end user Returns : - nothing
This method is the specialisation of the widget.pm method, refer to the widget.pm manual for more information.
Jean-Christian Hassler, <jhassler at free.fr>
<jhassler at free.fr>
Please report any bugs or feature requests to bug-gui-libhtml-screen at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=HTML-GUI-widget. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-gui-libhtml-screen at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc HTML::GUI::widget
You can also look for information at:
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/HTML-GUI-widget
CPAN Ratings
http://cpanratings.perl.org/d/HTML-GUI-widget
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=HTML-GUI-widget
Search CPAN
http://search.cpan.org/dist/HTML-GUI-widget
Copyright 2007 Jean-Christian Hassler, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install HTML::GUI::br, copy and paste the appropriate command in to your terminal.
cpanm
cpanm HTML::GUI::br
CPAN shell
perl -MCPAN -e shell install HTML::GUI::br
For more information on module installation, please visit the detailed CPAN module installation guide.