ILIAS
release_8 Revision v8.19
|
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...
Public Member Functions | |
setFormAction (string $a_val, bool $a_multipart=false, string $a_target="") | |
Set form action (if form action is set, toolbar is wrapped into form tags) More... | |
getFormAction () | |
setLeadingImage (string $a_img, string $a_alt) | |
setHidden (bool $a_val) | |
getHidden () | |
setId (string $a_val) | |
getId () | |
setPreventDoubleSubmission (bool $a_val) | |
getPreventDoubleSubmission () | |
addButton (string $a_txt, string $a_cmd, string $a_target="", ?int $a_acc_key=null, string $a_additional_attrs='', string $a_id="", string $a_class='submit') | |
addFormButton (string $a_txt, string $a_cmd, ?int $a_acc_key=null, bool $a_primary=false, ?string $a_class=null) | |
addInputItem (ilToolbarItem $a_item, bool $a_output_label=false) | |
addStickyItem ( $a_item, bool $a_output_label=false) | |
Add a sticky item. More... | |
addButtonInstance (ilButtonBase $a_button) | |
Add button instance. More... | |
addDropDown (string $a_txt, string $a_dd_html) | |
addAdvancedSelectionList (ilAdvancedSelectionListGUI $adv) | |
addSeparator () | |
addText (string $a_text) | |
addSpacer (string $a_width=null) | |
addComponent (\ILIAS\UI\Component\Component $a_comp) | |
addLink (string $a_caption, string $a_url, bool $a_disabled=false) | |
setOpenFormTag (bool $a_val) | |
getOpenFormTag () | |
setCloseFormTag (bool $a_val) | |
getCloseFormTag () | |
setFormName (string $a_val) | |
getFormName () | |
getGroupedItems () | |
Get all groups (items separated by a separator) More... | |
getItems () | |
setItems (array $items) | |
Data Fields | |
array | $items = array() |
Protected Member Functions | |
applyAutoStickyToSingleElement () | |
If the toolbar consists of only one button, make it sticky Note: Atm this is only possible for buttons. More... | |
Protected Attributes | |
ilLanguage | $lng |
string | $id = '' |
string | $form_action = '' |
bool | $hidden = false |
array | $lead_img |
bool | $open_form_tag = true |
bool | $close_form_tag = true |
string | $form_target = "" |
string | $form_name = "" |
bool | $prevent_double_submission = false |
array | $sticky_items = array() |
bool | $has_separator = false |
ILIAS DI UIServices | $ui |
bool | $multipart = false |
Static Protected Attributes | |
static int | $instances = 0 |
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.
ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.
If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Toolbar. The toolbar currently only supports a list of buttons as links. A default toolbar object is available in the $ilToolbar global object.
Definition at line 25 of file class.ilToolbarGUI.php.
ilToolbarGUI::addAdvancedSelectionList | ( | ilAdvancedSelectionListGUI | $adv | ) |
Definition at line 192 of file class.ilToolbarGUI.php.
ilToolbarGUI::addButton | ( | string | $a_txt, |
string | $a_cmd, | ||
string | $a_target = "" , |
||
?int | $a_acc_key = null , |
||
string | $a_additional_attrs = '' , |
||
string | $a_id = "" , |
||
string | $a_class = 'submit' |
||
) |
Definition at line 116 of file class.ilToolbarGUI.php.
Referenced by SurveyQuestionGUI\addMaterial(), ilMultilingualismGUI\addToolbar(), ilTestResultsToolbarGUI\build(), ilObjSurveyQuestionPoolGUI\exportObject(), ilPCProfileGUI\initForm(), ilObjStudyProgrammeMembersGUI\initMailToMemberButton(), ilContSkillAdminGUI\listCompetences(), ilRecommendedContentRoleConfigGUI\listItems(), ilCalendarCategoryGUI\manage(), ilObjTestGUI\populateQuestionBrowserToolbarButtons(), ilContainerGUI\renderObject(), ilSkillProfileGUI\showLevelsWithLocalContext(), ilMembershipGUI\showMailToMemberToolbarButton(), and ilMembershipGUI\showMemberExportToolbarButton().
ilToolbarGUI::addButtonInstance | ( | ilButtonBase | $a_button | ) |
Add button instance.
ilButtonBase | $a_button |
Definition at line 176 of file class.ilToolbarGUI.php.
References addStickyItem(), and ilButtonBase\isPrimary().
Referenced by ILIAS\Survey\Mode\AbstractUIModifier\addApprSelectionToToolbar(), ilParticipantsTestResultsGUI\addDeleteAllTestResultsButton(), ILIAS\Survey\Mode\AbstractUIModifier\addExportAndPrintButton(), ilTestParticipantsGUI\addFinishAllPassesButton(), ilTestNavigationToolbarGUI\addFinishTestButton(), ilTestNavigationToolbarGUI\addQuestionListButton(), ilTestNavigationToolbarGUI\addQuestionSelectionButton(), ilTestNavigationToolbarGUI\addQuestionTreeButton(), ILIAS\Survey\Mode\IndividualFeedback\UIModifier\addRaterSelectionToToolbar(), ilTestNavigationToolbarGUI\addSuspendTestButton(), ilTestParticipantsGUI\addUserSearchControls(), ilAssQuestionPreviewToolbarGUI\build(), ilTestResultsToolbarGUI\build(), ilObjCmiXapiAdministrationGUI\buildLrsTypesToolbarGUI(), ilDclRecordListGUI\createSwitchers(), ilDclRecordListGUI\executeCommand(), ilObjUserFolderGUI\exportObject(), ilAppointmentPresentationGUI\getHTML(), ilContSkillAdminGUI\listProfiles(), and ILIAS\Survey\Mode\AbstractUIModifier\setResultsDetailToolbar().
ilToolbarGUI::addComponent | ( | \ILIAS\UI\Component\Component | $a_comp | ) |
Definition at line 213 of file class.ilToolbarGUI.php.
Referenced by ilECSUserConsentModalGUI\addConsentModalToToolbar(), ILIAS\Survey\Mode\AbstractUIModifier\addExportAndPrintButton(), ilECSUserConsentModalGUI\addRemoteLinkToToolbar(), ilCalendarViewGUI\addToolbarFileDownload(), ilWikiPageGUI\initToolbar(), ilSkillTreeAdminGUI\listTrees(), ilExcRandomAssignmentGUI\renderStartPage(), ilObjBlogGUI\renderToolbarNavigation(), ilContainerGUI\showAdministrationPanel(), and ilCalendarPresentationGUI\showViewSelection().
ilToolbarGUI::addDropDown | ( | string | $a_txt, |
string | $a_dd_html | ||
) |
Definition at line 185 of file class.ilToolbarGUI.php.
ilToolbarGUI::addFormButton | ( | string | $a_txt, |
string | $a_cmd, | ||
?int | $a_acc_key = null , |
||
bool | $a_primary = false , |
||
?string | $a_class = null |
||
) |
Definition at line 133 of file class.ilToolbarGUI.php.
References addStickyItem(), and ilSubmitButton\getInstance().
Referenced by ilDidacticTemplateGUI\appendToolbarSwitch(), ilTestSkillEvaluationToolbarGUI\build(), ilTestRandomQuestionSetSourcePoolDefinitionListToolbarGUI\populateNewQuestionSelectionRuleInputs(), ilContainerGUI\showAdministrationPanel(), and ilObjWorkspaceFolderGUI\showAdministrationPanel().
ilToolbarGUI::addInputItem | ( | ilToolbarItem | $a_item, |
bool | $a_output_label = false |
||
) |
Definition at line 152 of file class.ilToolbarGUI.php.
Referenced by ILIAS\Survey\Mode\AbstractUIModifier\addApprSelectionToToolbar(), ILIAS\Survey\Mode\IndividualFeedback\UIModifier\addRaterSelectionToToolbar(), ilPersonalSkillsFilterGUI\addToToolbar(), ilDidacticTemplateGUI\appendToolbarSwitch(), ilTestResultsToolbarGUI\build(), ilTestSkillEvaluationToolbarGUI\build(), ilDclRecordListGUI\createSwitchers(), ilObjUserFolderGUI\exportObject(), ilContSkillAdminGUI\listProfiles(), and ILIAS\Survey\Mode\AbstractUIModifier\setResultsDetailToolbar().
ilToolbarGUI::addLink | ( | string | $a_caption, |
string | $a_url, | ||
bool | $a_disabled = false |
||
) |
Definition at line 218 of file class.ilToolbarGUI.php.
ilToolbarGUI::addSeparator | ( | ) |
Definition at line 197 of file class.ilToolbarGUI.php.
Referenced by ILIAS\Survey\Mode\AbstractUIModifier\addApprSelectionToToolbar(), ILIAS\Survey\Mode\AbstractUIModifier\addExportAndPrintButton(), ILIAS\Survey\Mode\IndividualFeedback\UIModifier\addRaterSelectionToToolbar(), ilCalendarViewGUI\addToolbarFileDownload(), ilTestParticipantsGUI\addUserSearchControls(), ilTestResultsToolbarGUI\build(), ilTestInfoScreenToolbarGUI\build(), ilDclRecordListGUI\createSwitchers(), ilAppointmentPresentationGUI\getHTML(), ilObjStudyProgrammeMembersGUI\initMailToMemberButton(), ilContSkillAdminGUI\listProfiles(), ilObjBlogGUI\renderToolbarNavigation(), ILIAS\Survey\Mode\AbstractUIModifier\setResultsDetailToolbar(), ilContainerGUI\showAdministrationPanel(), ilMembershipGUI\showMailToMemberToolbarButton(), ilMembershipGUI\showMemberExportToolbarButton(), and ilCalendarPresentationGUI\showViewSelection().
ilToolbarGUI::addSpacer | ( | string | $a_width = null | ) |
Definition at line 208 of file class.ilToolbarGUI.php.
ilToolbarGUI::addStickyItem | ( | $a_item, | |
bool | $a_output_label = false |
||
) |
Add a sticky item.
Sticky items are always visible, also if the toolbar is collapsed (responsive view). Sticky items are displayed first in the toolbar.
ilToolbarItem | \ILIAS\UI\Component\Component | $a_item |
Definition at line 165 of file class.ilToolbarGUI.php.
Referenced by addButtonInstance(), addFormButton(), applyAutoStickyToSingleElement(), ilDclRecordListGUI\executeCommand(), and ilAppointmentPresentationGUI\getHTML().
ilToolbarGUI::addText | ( | string | $a_text | ) |
Definition at line 203 of file class.ilToolbarGUI.php.
Referenced by ILIAS\Survey\Mode\AbstractUIModifier\addExportAndPrintButton(), ilDidacticTemplateGUI\appendToolbarSwitch(), and ilDclRecordListGUI\createSwitchers().
|
protected |
If the toolbar consists of only one button, make it sticky Note: Atm this is only possible for buttons.
If we are dealing with objects implementing the ilToolbarItem interface one day, other elements can be added as sticky.
Definition at line 509 of file class.ilToolbarGUI.php.
References addStickyItem(), ilSubmitButton\getInstance(), and ilLinkButton\getInstance().
Referenced by getGroupedItems().
ilToolbarGUI::getCloseFormTag | ( | ) |
Definition at line 242 of file class.ilToolbarGUI.php.
References $close_form_tag.
Referenced by getGroupedItems().
ilToolbarGUI::getFormAction | ( | ) |
Definition at line 71 of file class.ilToolbarGUI.php.
References $form_action.
Referenced by getGroupedItems().
ilToolbarGUI::getFormName | ( | ) |
Definition at line 252 of file class.ilToolbarGUI.php.
References $form_name.
Referenced by getGroupedItems().
ilToolbarGUI::getGroupedItems | ( | ) |
Get all groups (items separated by a separator)
Definition at line 261 of file class.ilToolbarGUI.php.
References $GLOBALS, $i, $lng, $tpl, applyAutoStickyToSingleElement(), getCloseFormTag(), getFormAction(), getFormName(), getHidden(), getId(), getOpenFormTag(), getPreventDoubleSubmission(), ILIAS\Repository\lng(), ilLanguage\txt(), and ILIAS\Repository\ui().
ilToolbarGUI::getHidden | ( | ) |
Definition at line 88 of file class.ilToolbarGUI.php.
References $hidden.
Referenced by getGroupedItems().
ilToolbarGUI::getId | ( | ) |
Definition at line 98 of file class.ilToolbarGUI.php.
Referenced by ilTestInfoScreenToolbarGUI\build(), and getGroupedItems().
ilToolbarGUI::getItems | ( | ) |
Definition at line 494 of file class.ilToolbarGUI.php.
References $items.
Referenced by ilTestInfoScreenToolbarGUI\build().
ilToolbarGUI::getOpenFormTag | ( | ) |
Definition at line 232 of file class.ilToolbarGUI.php.
References $open_form_tag.
Referenced by getGroupedItems().
ilToolbarGUI::getPreventDoubleSubmission | ( | ) |
Definition at line 108 of file class.ilToolbarGUI.php.
References $prevent_double_submission.
Referenced by getGroupedItems().
ilToolbarGUI::setCloseFormTag | ( | bool | $a_val | ) |
Definition at line 237 of file class.ilToolbarGUI.php.
Referenced by ilObjTestGUI\infoScreen().
ilToolbarGUI::setFormAction | ( | string | $a_val, |
bool | $a_multipart = false , |
||
string | $a_target = "" |
||
) |
Set form action (if form action is set, toolbar is wrapped into form tags)
Definition at line 61 of file class.ilToolbarGUI.php.
Referenced by ilTestRandomQuestionSetSourcePoolDefinitionListToolbarGUI\build(), ilTestSkillEvaluationToolbarGUI\build(), ilDclRecordListGUI\createSwitchers(), ilObjUserFolderGUI\exportObject(), McstImageGalleryGUI\getHTML(), and ilContSkillAdminGUI\listProfiles().
ilToolbarGUI::setFormName | ( | string | $a_val | ) |
Definition at line 247 of file class.ilToolbarGUI.php.
ilToolbarGUI::setHidden | ( | bool | $a_val | ) |
Definition at line 83 of file class.ilToolbarGUI.php.
ilToolbarGUI::setId | ( | string | $a_val | ) |
Definition at line 93 of file class.ilToolbarGUI.php.
Referenced by ilTestResultsToolbarGUI\build(), ilCalendarAppointmentPresentationGUI\getContentByPlugins(), ilCalendarAppointmentPresentationGUI\getModalHTML(), and ilContainerGUI\showAdministrationPanel().
ilToolbarGUI::setItems | ( | array | $items | ) |
Definition at line 499 of file class.ilToolbarGUI.php.
References $items.
Referenced by ilTestInfoScreenToolbarGUI\clearItems().
ilToolbarGUI::setLeadingImage | ( | string | $a_img, |
string | $a_alt | ||
) |
Definition at line 76 of file class.ilToolbarGUI.php.
Referenced by ILIAS\Services\UICore\MetaTemplate\PageContentGUI\fillAdminPanel(), ilGlobalTemplate\fillAdminPanel(), ilDataCollectionGlobalTemplate\fillAdminPanel(), ilContainerGUI\showAdministrationPanel(), and ilObjWorkspaceFolderGUI\showAdministrationPanel().
ilToolbarGUI::setOpenFormTag | ( | bool | $a_val | ) |
Definition at line 226 of file class.ilToolbarGUI.php.
ilToolbarGUI::setPreventDoubleSubmission | ( | bool | $a_val | ) |
Definition at line 103 of file class.ilToolbarGUI.php.
|
protected |
Definition at line 38 of file class.ilToolbarGUI.php.
Referenced by getCloseFormTag().
|
protected |
Definition at line 30 of file class.ilToolbarGUI.php.
Referenced by getFormAction().
|
protected |
Definition at line 40 of file class.ilToolbarGUI.php.
Referenced by getFormName().
|
protected |
Definition at line 39 of file class.ilToolbarGUI.php.
|
protected |
Definition at line 43 of file class.ilToolbarGUI.php.
|
protected |
Definition at line 31 of file class.ilToolbarGUI.php.
Referenced by getHidden().
|
protected |
Definition at line 29 of file class.ilToolbarGUI.php.
|
staticprotected |
Definition at line 28 of file class.ilToolbarGUI.php.
array ilToolbarGUI::$items = array() |
Definition at line 32 of file class.ilToolbarGUI.php.
Referenced by getItems(), and setItems().
|
protected |
Definition at line 33 of file class.ilToolbarGUI.php.
|
protected |
|
protected |
Definition at line 45 of file class.ilToolbarGUI.php.
|
protected |
Definition at line 37 of file class.ilToolbarGUI.php.
Referenced by getOpenFormTag().
|
protected |
Definition at line 41 of file class.ilToolbarGUI.php.
Referenced by getPreventDoubleSubmission().
|
protected |
Definition at line 42 of file class.ilToolbarGUI.php.
|
protected |
Definition at line 44 of file class.ilToolbarGUI.php.