++ed by:
AERO

1 PAUSE user

Tobias Oetiker
and 1 contributors

NAME

CallBackery::GuiPlugin::AbstractForm - form base class

SYNOPSIS

 use Mojo::Base 'CallBackery::GuiPlugin::AbstractForm';

DESCRIPTION

The base class for gui forms.

ATTRIBUTES

The attributes of the CallBackery::GuiPlugin::Abstract class plus:

screenCfg

Returns a configuration structure for the form. The output from this method is fed to the callbackery.ui.form.Auto object to build the Qooxdoo form.

screenOpts

Returns a hash of options for the screen Options

actionCfg

Returns a list of action buttons to place at the top of the form.

actionCfgMap

TODOC

formCfg

Returns the content of the form.

formCfg

TODOC

METHODS

All the methods of CallBackery::GuiPlugin::Abstract plus:

validateData(fieldName,formData)

If the given value is valid for the field, return undef else return an error message.

processData($args)

The default behavior of the method is to validate all the form fields and then store the data into the config database.

saveFormDataToConfig(data)

Save all the form fields for which is available to the config database. Keys will be prefixed by the plugin instance name (PluginInstance::keyName).

getFieldValue(field)

Fetch the current value of the field. This will either use the getter method supplied in the form config or try to fetch the value from the config database.

getAllFieldValues

Return all field values of the form.

getData (type,field)

Return the value of the given field. If no field name is specified return a hash with all the current data known to the plugin.

massageConfig

Function to integrate the plugin configuration recursively into the main config hash.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

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. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

COPYRIGHT

Copyright (c) 2013 by OETIKER+PARTNER AG. All rights reserved.

AUTHOR

Tobias Oetiker <tobi@oetiker.ch>

HISTORY

 2013-12-16 to 1.0 first version