SYNOPSIS
Do not use directly, instead derive a classDESCRIPTION
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.METHODS
new
Create a new controlinit
Init the new controlnoframe
Do not draw frame border if this is the only controlis_disabled
Do not display this control at all.is_readonly
Could value of this control be changed ?label_text
Returns the text of the labelshow
Output the controlget_on_show_code
Returns JavaScript code that should be executed when the form becomes visibleget_active_id
Get the id of the value which is currently activeform
Return the form object of this controlshow_sub_begin
Output begin of sub formshow_sub_end
Output end of sub formshow_label
Output the label of the controlshow_label_icon
Output the icon after the labelshow_label_cell
Output the table cell in which the label will be displayedMust return the columns it spans (default: 1)
show_control
Output the control itselfshow_control_readonly
Output the control itself as readonlyshow_control_addons
output additional things after the controlshow_control_cell
Output the table cell in which the control will be displayedGets the x position as argument
PARAMETERS
nameSpecifies the name of the control
text
Will be used as label for the control, if not given 'name' is used as default.
Normaly 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".
labelnowrap
If set, the text label will not be line wrapped.labelclass
If set, will be used as additional CSS classes for the label text cell.readonly
If set, displays a readonly version of the control.disable
If set, the control will not be displayed at all.newline
If set to 1, forces a new line before the control. If set to -1, forces a new line after the control.width
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.width_percent
With this parameter you can also specify the width of the control in percent. This parameter take precedence over "width"default
Default value of the controlimagedir
Basepath where to find images, in case the control uses images. Default value is /imagestrigger
When set will trigger state changes of other controls. See ``state''.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