DOKK / manpages / debian 12 / libembperl-perl / Embperl::Form::Control.3pm.en
Form::Control(3pm) User Contributed Perl Documentation Form::Control(3pm)

Embperl::Form::Control - Base class for controls inside an Embperl Form

Do not use directly, instead derive a class

This class is not used directly, it is used as a base class for all controls inside an Embperl Form. It provides a set of methods that could be overwritten to customize the behaviour of your controls.

Create a new control

Init the new control

Do not draw frame border if this is the only control

Do not display this control at all.

Could value of this control be changed ?

Returns the text of the label

Output the control

Returns JavaScript code that should be executed when the form becomes visible

Get the id of the value which is currently active

Return the form object of this control

Output begin of sub form

Output end of sub form

Output the label of the control

Output the icon after the label

Output the table cell in which the label will be displayed

Must return the columns it spans (default: 1)

Output the control itself

Output the control itself as readonly

output additional things after the control

Output the table cell in which the control will be displayed

Gets the x position as argument

name

Specifies the name of the control

text

Will be used as label for the control, if not given 'name' is used as default.

Normally the the name and text parameters are processed by the method "convert_label" of the "Embperl::Form" object. This method can be overwritten, to allow translation etc.

If the parameter "showtext" is given a true value, "convert_label" is not called and the text is displayed as it is.

showtext

Display label without passing it through "convert_label". See "text".

If set, the text label will not be line wrapped.

If set, will be used as additional CSS classes for the label text cell.

If set, displays a readonly version of the control.

If set, the control will not be displayed at all.

If set to 1, forces a new line before the control. If set to -1, forces a new line after the control.

Gives the widths of the control. The value is "1/width" of the the whole width of the form. So if you want to have four controls in one line set "width" to 4. The default value is 2.

With this parameter you can also specify the width of the control in percent. This parameter take precedence over "width"

Default value of the control

Basepath where to find images, in case the control uses images. Default value is /images

When set will trigger state changes of other controls. See "state".

Can be used to hide/show disable/enable the control trigger by other controls.

Checkbox define the following states:

  • <id-of-checkbox>-show

    Show control if checkbox checked

  • <id-of-checkbox>-hide

    Hide control if checkbox checked

  • <id-of-checkbox>-enable

    Enable control if checkbox checked

  • <id-of-checkbox>-disable

    Disable control if checkbox checked

G. Richter (richter at embperl dot org)

perl(1), Embperl, Embperl::Form

2023-01-22 perl v5.36.0