NAME

Embperl::Form::Control::grid - A grid control inside an Embperl Form

SYNOPSIS

DESCRIPTION

Used to create a grid control inside an Embperl Form. See Embperl::Form on how to specify parameters.

PARAMETER

type

Needs to be 'grid'

fields

Array ref with field definitions. Should look like any normal field definition.

The following extra attributes are available:

col

Column number inside the @data array, which should be used for this cell

colval

If given this value is added to the column. This allows one to have multiple checkboxes all writing to the same column, each appending a character or string if set.

line2

field definition which is show in a second line, full width.

disable_controls

If true, controls for add, delete, up and down will not be shown

header_bottom

If grid has more rows as given in this parameter, a header line is also displayed at the bottom of the grid. Default is 10. Set to -1 to always get a header at the bottom.

order

Number of column to use as sort key

order_desc

Sort descending

coloffset

Offset added to column number. Default: 1 If > 1, column number will set to the rownumber

flat

This can be used for readonly view of grid. Normally readonly view will show the content as one large string. The flat attribute can contain a semicolon delimited list of fields that should be shown in readony view. That allows to selectively show fields in readonly view. This can be used to show a readonly view of a grid inside of another grid.

flatopt

Semikolon delimited list of tripels that add special options for flat view:

<name of fields>;<option name>;<option value>

Example

 {
 name => 'provider-path',
 text => 'Suchpfad',
 type => 'grid', 
 fields =>
    [
    { name => 'active', text => 'Aktiv', type => 'checkbox', width => '30' },
    { name => 'path',   text => 'Pfad' },
    ],
},

Author

G. Richter (richter at embperl dot org)

See Also

perl(1), Embperl, Embperl::Form