Panel
class Panel
This class allows the storage and retrieval of the attributes of a panel.
A panel is where the informations of a simulation step are displayed.
Information can be organized in one or more panels.
If there are multiple panels, they are displayed as tabs.
The first levels of information in a panel are field sets or blocks of information.
Properties
| private Step | $step | ||
| private int | $id | ||
| private string | $name | ||
| private string | $label | ||
| private array | $fieldsets | ||
| private bool | $displayable |
Methods
Returns the id of this panel
Sets the id of this panel
Returns the name of this panel
Sets the name of this panel
Returns the label of this panel
Sets the label of this panel
Returns the list of field sets (FieldSet objects) or block of informations (BlockInfo objects) contained in this panel.
Sets the list of field sets (FieldSet objects) or block of informations (BlockInfo objects) contained in this panel.
Adds a Fieldset or BlockInfo object to the list of field sets or block of informations contained in this panel.
Removes a Fieldset or BlockInfo object from the list of field sets or block of informations contained in this panel.
Retrieves a Fieldset object by its id in the list of field sets contained in this panel.
Retrieves a BlockInfo object by its id in the list of blocks of informations contained in this panel.
Retrieves the BlockInfo or the Fieldset object by its id in the list of blocks contained in this panel.
Returns the displayable attribute of this Panel object
Returns the displayable attribute of this Panel object
Determines whether this panel can be displayed or not
Does this panel contain at least one input field?
Does this panel contain at least one required input field?
Details
at line 102
void
__construct(Step $step, int $id)
Constructor of class Panel
at line 114
Step
getStep()
Returns the Step object that contains this panel
at line 125
int
getId()
Returns the id of this panel
at line 137
void
setId(int $id)
Sets the id of this panel
at line 148
string
getName()
Returns the name of this panel
at line 160
void
setName(string $name)
Sets the name of this panel
at line 171
string
getLabel()
Returns the label of this panel
at line 183
void
setLabel(string $label)
Sets the label of this panel
at line 194
array
getFieldSets()
Returns the list of field sets (FieldSet objects) or block of informations (BlockInfo objects) contained in this panel.
at line 206
void
setFieldSets(array $fieldsets)
Sets the list of field sets (FieldSet objects) or block of informations (BlockInfo objects) contained in this panel.
at line 218
void
addFieldSet(FieldSet|BlockInfo $fieldset)
Adds a Fieldset or BlockInfo object to the list of field sets or block of informations contained in this panel.
at line 230
void
removeFieldSet(int $index)
Removes a Fieldset or BlockInfo object from the list of field sets or block of informations contained in this panel.
at line 242
Fieldset|null
getFieldSetById(int $id)
Retrieves a Fieldset object by its id in the list of field sets contained in this panel.
at line 259
BlockInfo|null
getBlockInfoById(int $id)
Retrieves a BlockInfo object by its id in the list of blocks of informations contained in this panel.
at line 276
BlockInfo|Fieldset|null
getBlockById(int $id)
Retrieves the BlockInfo or the Fieldset object by its id in the list of blocks contained in this panel.
at line 292
bool
isDisplayable()
Returns the displayable attribute of this Panel object
at line 303
bool
getDisplayable()
Returns the displayable attribute of this Panel object
at line 315
void
setDisplayable(bool $displayable)
Determines whether this panel can be displayed or not
at line 326
bool
hasInputFields()
Does this panel contain at least one input field?
at line 342
bool
hasRequiredFields()
Does this panel contain at least one required input field?