FieldSet
class FieldSet
This class allows the storage and retrieval of the attributes of a field set.
Fieldset makes it possible to group together fields of the same nature (logical or thematic) thus highlighting the structuring of the information.
The fields of a field set can be arranged conventionally, one below the other or in a grid in which case they are encapsulated in field rows. They can also be placed one after the other in order to form a sentence.
A field set is contained in a panel.
Properties
private Panel | $panel | ||
private int | $id | ||
private string | $legend | ||
private string | $disposition | ||
private string | $display | ||
private string | $popinLink | ||
private bool | $displayable | ||
private bool | $inputFields | ||
private array | $fields | ||
private array | $columns |
Methods
Returns the ID of this field set
Sets the ID of this field set
Returns the legend of this field set
Sets the legend of this field set
Returns the disposition of this field set
Sets the disposition of this field set
Returns the display mode of this field set
Sets the display mode of this field set
Sets the text of the link to display the pop-in (if display is "pop-in")
Returns the text of the link to display the pop-in (if display is "pop-in")
Returns the displayable attribute of this FieldSet object
Returns the displayable attribute of this FieldSet object
Determines whether this field set can be displayed or not
Returns the inputFields attribute of this FieldSet object
Returns the inputFields attribute of this FieldSet object
Determines whether this field set contains at least one field entered by the user or not.
Returns the list of fields or field rows of this field set
Sets the list of fields or field rows of this field set
Removes a Field or FieldRow object from the list of fields of this field set.
Retrieves a Field object by its position in the list of fields of this field set.
Retrieves a FieldRow object by this id.
Returns the list of columns (header of a grid) in this field set when the disposition is "grid"
Sets the list of columns (header of a grid) in this field set when the disposition is "grid"
Removes a Column object in the list of columns (header of a grid) in this field set.
Retrieves a Column object by this id.
Returns the class name of this FieldSet object
Details
at line 134
void
__construct(Panel $panel, int $id)
Constructor of class FieldSet
at line 146
Panel
getPanel()
Returns the Panel object that contains this field set
at line 157
int
getId()
Returns the ID of this field set
at line 169
void
setId(int $id)
Sets the ID of this field set
at line 180
string
getLegend()
Returns the legend of this field set
at line 192
void
setLegend(string $legend)
Sets the legend of this field set
at line 209
string
getDisposition()
Returns the disposition of this field set
The possible values are :
- classic: the elements of the form belonging to the field set are arranged in a conventional way, that is, a field preceded by its field label is placed on the line following that of the preceding field
- grid: form elements belonging to the field set are placed in a table
- inline: the elements of the form belonging to the field set are arranged on line to form a sentence
at line 227
void
setDisposition(string $disposition)
Sets the disposition of this field set
The possible values are :
- classic: the elements of the form belonging to the field set are arranged in a conventional way, that is, a field preceded by its field label is placed on the line following that of the preceding field
- grid: form elements belonging to the field set are placed in a table
- inline: the elements of the form belonging to the field set are arranged on line to form a sentence
at line 243
string
getDisplay()
Returns the display mode of this field set
The possible values are :
- inline: the fields of the field set are displayed "online" in the simulation page
- pop-in: the fields of the field set are displayed in a pop-in modal window.
at line 260
void
setDisplay(string $display)
Sets the display mode of this field set
The possible values are :
- inline: the fields of the field set are displayed "online" in the simulation page
- pop-in: the fields of the field set are displayed in a pop-in modal window.
at line 271
string
getPopinLink()
Sets the text of the link to display the pop-in (if display is "pop-in")
at line 283
void
setPopinLink(string $popinLink)
Returns the text of the link to display the pop-in (if display is "pop-in")
at line 294
bool
isDisplayable()
Returns the displayable attribute of this FieldSet object
at line 305
bool
getDisplayable()
Returns the displayable attribute of this FieldSet object
at line 317
void
setDisplayable(bool $displayable)
Determines whether this field set can be displayed or not
at line 328
bool
hasInputFields()
Returns the inputFields attribute of this FieldSet object
at line 339
bool
getInputFields()
Returns the inputFields attribute of this FieldSet object
at line 351
void
setInputFields(bool $inputFields)
Determines whether this field set contains at least one field entered by the user or not.
at line 362
array
getFields()
Returns the list of fields or field rows of this field set
at line 374
void
setFields(array $fields)
Sets the list of fields or field rows of this field set
at line 386
void
addField(Field|FieldRow $field)
Adds a Field or FieldRow object in the list of fields of this field set.
at line 398
void
removeField(int $index)
Removes a Field or FieldRow object from the list of fields of this field set.
at line 410
Field|null
getFieldByPosition(int $position)
Retrieves a Field object by its position in the list of fields of this field set.
at line 427
FieldRow|null
getFieldRowById(int $id)
Retrieves a FieldRow object by this id.
at line 443
array
getColumns()
Returns the list of columns (header of a grid) in this field set when the disposition is "grid"
at line 455
void
setColumns(array $columns)
Sets the list of columns (header of a grid) in this field set when the disposition is "grid"
at line 467
void
addColumn(Column $column)
Adds a Column object in the list of columns (header of a grid) in this field set.
at line 479
void
removeColumn(int $index)
Removes a Column object in the list of columns (header of a grid) in this field set.
at line 491
Column|null
getColumnById(int $id)
Retrieves a Column object by this id.
at line 507
string
getClass()
Returns the class name of this FieldSet object