BlockInfo
class BlockInfo
This class allows the storage and retrieval of the attributes of a block of information (blockinfo)
The blockinfo is an element of the simulation page of the same level as the field group but does not contain any input or output fields. It contains textual information that can be useful to the user in the simulation process. It can be contextualized by showing / hiding it totally or partially using the actions of business rules depending on certain conditions.
Properties
| private Panel | $panel | ||
| private int | $id | ||
| private string | $name | ||
| private string | $label | ||
| private string | $display | ||
| private string | $popinLink | ||
| private array | $chapters | ||
| private bool | $displayable |
Methods
Returns the ID of this BlockInfo object
Sets the ID of this BlockInfo object
Returns the name of this BlockInfo object
Sets the name of this BlockInfo object
Returns the label of this BlockInfo object
Sets the label of this BlockInfo object
Returns the display mode of this BlockInfo object
Sets the display mode of this BlockInfo object
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 list of chapters contained in this BlockInfo object
Sets the list of chapters contained in this BlockInfo object
Adds a chapter to the list of chapters contained in this BlockInfo object
Removes a chapter from the list of chapters contained in this BlockInfo object
Retrieves a chapter by its ID in the chapter list of this BlockInfo object
Searchs if this block of information contains at least one chapter that can be folded / unfolded and returns true or false according to the result of the search.
Searchs if this block of information contains at least one chapter that can be folded / unfolded and returns true or false according to the result of the search.
Returns the displayable attribute of this BlockInfo object
Returns the displayable attribute of this BlockInfo object
Determines whether this BlockInfo can be displayed or not
Returns the class name of this BlockInfo object
Details
at line 114
void
__construct(Panel $panel, int $id)
Constructor of class BlockInfo
at line 126
Panel
getPanel()
Returns the Panel object that contains this BlockInfo object
at line 137
int
getId()
Returns the ID of this BlockInfo object
at line 149
void
setId(int $id)
Sets the ID of this BlockInfo object
at line 160
string
getName()
Returns the name of this BlockInfo object
at line 172
void
setName(string $name)
Sets the name of this BlockInfo object
at line 183
string
getLabel()
Returns the label of this BlockInfo object
at line 195
void
setLabel(string $label)
Sets the label of this BlockInfo object
at line 213
string
getDisplay()
Returns the display mode of this BlockInfo object
The possible values are :
- inline: the content of the BlockInfo object is displayed "online" in the simulation page
- grouped: the fields of the field set are displayed in a group in the simulation page
- accordion: the content of the BlockInfo object is displayed in the item of an accordion
- pop-in: the content of the BlockInfo object is displayed in a pop-in modal window.
at line 232
void
setDisplay(string $display)
Sets the display mode of this BlockInfo object
The possible values are :
- inline: the content of the BlockInfo object is displayed "online" in the simulation page
- grouped: the fields of the field set are displayed in a group in the simulation page
- accordion: the content of the BlockInfo object is displayed in the item of an accordion
- pop-in: the content of the BlockInfo object is displayed in a pop-in modal window.
at line 243
string
getPopinLink()
Sets the text of the link to display the pop-in (if display is "pop-in")
at line 255
void
setPopinLink(string $popinLink)
Returns the text of the link to display the pop-in (if display is "pop-in")
at line 266
array
getChapters()
Returns the list of chapters contained in this BlockInfo object
at line 278
void
setChapters(array $chapters)
Sets the list of chapters contained in this BlockInfo object
at line 290
void
addChapter(Chapter $chapter)
Adds a chapter to the list of chapters contained in this BlockInfo object
at line 302
void
removeChapter(int $index)
Removes a chapter from the list of chapters contained in this BlockInfo object
at line 314
Chapter|null
getChapterById(int $id)
Retrieves a chapter by its ID in the chapter list of this BlockInfo object
at line 332
bool
hasCollapsibles()
Searchs if this block of information contains at least one chapter that can be folded / unfolded and returns true or false according to the result of the search.
This method is an alias of getCollapsibles.
at line 348
bool
getCollapsibles()
Searchs if this block of information contains at least one chapter that can be folded / unfolded and returns true or false according to the result of the search.
at line 359
bool
isDisplayable()
Returns the displayable attribute of this BlockInfo object
at line 370
bool
getDisplayable()
Returns the displayable attribute of this BlockInfo object
at line 382
void
setDisplayable(bool $displayable)
Determines whether this BlockInfo can be displayed or not
at line 393
string
getClass()
Returns the class name of this BlockInfo object