jFormsControlGroup

Extends \jFormsControlGroups

group control

Contains a list of controls. If it has a checkbox, child controls can be disabled by the user. The "value" of the group is then the status of the checkbox "on" or "". if the group is in readonly mode or is deactivated, every children are readonly or deactivated

package	jelix
subpackage	forms

Methods

__construct

__construct(string $ref)

inherited

Arguments

$ref

string

the identifiant of the control

addChildControl

addChildControl( $control,  $itemName = '')

inherited

Arguments

$control

$itemName

check and filter the value of the control.

check() : integer|null

inherited

It is the responsability of the implementation to fill the "errors" or "data" properties of the container.

Response

integer|null

null if it is ok, or one of jForms::ERRDATA_* constants when there is an error

deactivate

deactivate( $deactivation = true)

inherited

Arguments

$deactivation

getAttribute

getAttribute( $name)

inherited

Arguments

$name

getChildControls

getChildControls()

inherited

getDisplayValue

getDisplayValue( $value)

inherited

Arguments

$value

getWidgetType

getWidgetType() : string

inherited

since	1.6.14

Response

string

the default widget type to use to render the control

check if the control is activated

isActivated() : boolean

inherited

Response

boolean

true if it is activated

says if the control can have multiple values

isContainer()

inherited

says if the content is html or not

isHtmlContent()

inherited

since	1.2

check if the control is readonly

isReadOnly() : boolean

inherited

Response

boolean

true if it is readonly

setAttribute

setAttribute( $name,  $value)

inherited

Arguments

$name

$value

setData

setData( $value)

inherited

Arguments

$value

setDataFromDao

setDataFromDao( $value,  $daoDatatype)

inherited

Arguments

$value

$daoDatatype

setForm

setForm(\jFormsBase $form)

inherited

Arguments

$form

\jFormsBase

setReadOnly

setReadOnly( $r = true)

inherited

Arguments

$r

setValueFromRequest

setValueFromRequest(\jRequest $request)

inherited

Arguments

$request

\jRequest

Properties

a type name that identify the control type

type : string

inherited

var	a type name that identify the control type

Type(s)

string

indicates if the group has a checkbox to enable/disable its child controls

hasCheckbox :

since

Type(s)

value that is stored when the checkbox is checked

valueOnCheck :

since

Type(s)

value that is stored when the checkbox is unchecked

valueOnUncheck :

since

Type(s)

If the group has a checkbox, label that is displayed when the value has to be displayed, when the checkbox is checked.

valueLabelOnCheck :

If empty, the value of valueOnCheck is displayed.

since

Type(s)

If the group has a checkbox, label that is displayed when the value has to be displayed, when the checkbox is unchecked.

valueLabelOnUncheck :

If empty, the value of valueOnUncheck is displayed.

since

Type(s)

all child controls of the group

childControls :

inherited

Type(s)

the identifiant of the control

ref : string

inherited

var	the identifiant of the control

Type(s)

string

the object that manage constraints on the value

datatype : \jDatatype

inherited

var	the object that manage constraints on the value

Type(s)

\jDatatype

true if the control should be filled by the user

required : boolean

inherited

var	true if the control should be filled by the user

Type(s)

boolean

the label

label : string

inherited

var	the label

Type(s)

string

the value when the form is created (and not initialized by a data source

defaultValue : mixed

inherited

var	the value when the form is created (and not initialized by a data source

Type(s)

mixed

the message for the help on the control (typically help displayed in a popup)

help : string

inherited

var	the message for the help on the control (typically help displayed in a popup)

Type(s)

string

the message for tips on the control (typically the tooltip value)

hint : string

inherited

var	the message for tips on the control (typically the tooltip value)

Type(s)

string

the message when the value is invalid

alertInvalid : string

inherited

var	the message when the value is invalid

Type(s)

string

the message when there is no value and it is required

alertRequired : string

inherited

var	the message when there is no value and it is required

Type(s)

string

indicate if the control is in read only mode

initialReadOnly : boolean

inherited

var	indicate if the control is in read only mode

Type(s)

boolean

initialActivation

initialActivation : boolean

inherited

var

Type(s)

boolean

label displayed when only values are displayed, and when there is no value

emptyValueLabel : string

inherited

var	label displayed when only values are displayed, and when there is no value

Type(s)

string

the form object

form : \jFormsBase

inherited

var	the form object

Type(s)

\jFormsBase

content all values of the form

container : \jFormsDataContainer

inherited

var	content all values of the form

Type(s)

\jFormsDataContainer

miscellaneous values attached to the control

attributes : array

inherited

var	miscellaneous values attached to the control

Type(s)

array