ILIAS
trunk Revision v11.0_alpha-1744-gb0451eebef4
|
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 27 of file class.ilToolbarGUI.php.
ilToolbarGUI::addAdvancedSelectionList | ( | ilAdvancedSelectionListGUI | $adv | ) |
Definition at line 194 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 118 of file class.ilToolbarGUI.php.
Referenced by ilMultilingualismGUI\addToolbar(), ilPCProfileGUI\initForm(), ilContSkillAdminGUI\listCompetences(), ilRecommendedContentRoleConfigGUI\listItems(), ilCalendarCategoryGUI\manage(), ilObjTestGUI\populateQuestionBrowserToolbarButtons(), ilContainerGUI\renderObject(), ilSkillProfileGUI\showLevelsWithLocalContext(), ilMembershipGUI\showMailToMemberToolbarButton(), ilMembershipGUI\showMemberExportToolbarButton(), and ilObjExerciseGUI\showOverviewObject().
ilToolbarGUI::addButtonInstance | ( | ilButtonBase | $a_button | ) |
Add button instance.
ilButtonBase | $a_button |
Definition at line 178 of file class.ilToolbarGUI.php.
References addStickyItem(), and ilButtonBase\isPrimary().
ilToolbarGUI::addComponent | ( | \ILIAS\UI\Component\Component | $a_comp | ) |
Definition at line 215 of file class.ilToolbarGUI.php.
Referenced by ilObjectGUI\addAvailabilityPeriodButtonToToolbar(), ilECSUserConsentModalGUI\addConsentModalToToolbar(), ILIAS\Survey\Mode\AbstractUIModifier\addExportAndPrintButton(), ilTestParticipantsGUI\addExportDropdown(), ilWikiPageGUI\addLanguageSelectionToToolbar(), ilTestNavigationToolbarGUI\addPassOverviewButton(), ilECSUserConsentModalGUI\addRemoteLinkToToolbar(), ilTestNavigationToolbarGUI\addSuspendTestButton(), ilCalendarViewGUI\addToolbarFileDownload(), ilTestParticipantsGUI\addUserSearchControls(), ilSurveyEvaluationGUI\buildExportButtonAndModal(), ilObjCmiXapiAdministrationGUI\buildLrsTypesToolbarGUI(), ilTestSubmissionReviewGUI\buildToolbar(), ilAppointmentPresentationGUI\getHTML(), ilObjStudyProgrammeMembersGUI\initMailToMemberButton(), ilWikiPageGUI\initToolbar(), ilSkillTreeAdminGUI\listTrees(), ilTermDefinitionBulkCreationGUI\modifyToolbar(), ilBookBulkCreationGUI\modifyToolbar(), ilExcRandomAssignmentGUI\renderStartPage(), ilConsultationHoursGUI\renderViewControl(), ilContainerGUI\showAdministrationPanel(), ilCalendarPresentationGUI\showViewSelection(), and ilSurveyEvaluationGUI\validateAndSubmitExportForm().
ilToolbarGUI::addDropDown | ( | string | $a_txt, |
string | $a_dd_html | ||
) |
Definition at line 187 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 135 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 154 of file class.ilToolbarGUI.php.
Referenced by ILIAS\Survey\Mode\AbstractUIModifier\addApprSelectionToToolbar(), ILIAS\Survey\Mode\IndividualFeedback\UIModifier\addRaterSelectionToToolbar(), ilPersonalSkillsFilterGUI\addToToolbar(), ilDidacticTemplateGUI\appendToolbarSwitch(), ilTestSkillEvaluationToolbarGUI\build(), ilContSkillAdminGUI\listProfiles(), and ILIAS\Survey\Mode\AbstractUIModifier\setResultsDetailToolbar().
ilToolbarGUI::addLink | ( | string | $a_caption, |
string | $a_url, | ||
bool | $a_disabled = false |
||
) |
Definition at line 220 of file class.ilToolbarGUI.php.
ilToolbarGUI::addSeparator | ( | ) |
Definition at line 199 of file class.ilToolbarGUI.php.
Referenced by ILIAS\Survey\Mode\AbstractUIModifier\addApprSelectionToToolbar(), ilObjectGUI\addAvailabilityPeriodButtonToToolbar(), ILIAS\Survey\Mode\AbstractUIModifier\addExportAndPrintButton(), ilTestParticipantsGUI\addExportDropdown(), ILIAS\Survey\Mode\IndividualFeedback\UIModifier\addRaterSelectionToToolbar(), ilCalendarViewGUI\addToolbarFileDownload(), ilTestParticipantsGUI\addUserSearchControls(), ilAppointmentPresentationGUI\getHTML(), ilObjStudyProgrammeMembersGUI\initMailToMemberButton(), ilContSkillAdminGUI\listProfiles(), ilConsultationHoursGUI\renderViewControl(), ILIAS\Survey\Mode\AbstractUIModifier\setResultsDetailToolbar(), ilContainerGUI\showAdministrationPanel(), ilMembershipGUI\showMailToMemberToolbarButton(), ilMembershipGUI\showMemberExportToolbarButton(), and ilCalendarPresentationGUI\showViewSelection().
ilToolbarGUI::addSpacer | ( | ?string | $a_width = null | ) |
Definition at line 210 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 167 of file class.ilToolbarGUI.php.
Referenced by addButtonInstance(), addFormButton(), applyAutoStickyToSingleElement(), ilTestNavigationToolbarGUI\build(), ilAppointmentPresentationGUI\getHTML(), ILIAS\Repository\Link\LinkAdapterGUI\toToolbar(), and ILIAS\UI\Implementation\Component\Button\Button\ButtonAdapterGUI\toToolbar().
ilToolbarGUI::addText | ( | string | $a_text | ) |
Definition at line 205 of file class.ilToolbarGUI.php.
Referenced by ilDidacticTemplateGUI\appendToolbarSwitch().
|
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 474 of file class.ilToolbarGUI.php.
References addStickyItem(), ilSubmitButton\getInstance(), ilLinkButton\getInstance(), and null.
Referenced by getGroupedItems().
ilToolbarGUI::getCloseFormTag | ( | ) |
Definition at line 244 of file class.ilToolbarGUI.php.
References $close_form_tag.
Referenced by getGroupedItems().
ilToolbarGUI::getFormAction | ( | ) |
Definition at line 73 of file class.ilToolbarGUI.php.
References $form_action.
Referenced by getGroupedItems().
ilToolbarGUI::getFormName | ( | ) |
Definition at line 254 of file class.ilToolbarGUI.php.
References $form_name.
Referenced by getGroupedItems().
ilToolbarGUI::getGroupedItems | ( | ) |
Get all groups (items separated by a separator)
Definition at line 263 of file class.ilToolbarGUI.php.
References $GLOBALS, $lng, applyAutoStickyToSingleElement(), getCloseFormTag(), getFormAction(), getFormName(), getHidden(), getId(), getOpenFormTag(), getPreventDoubleSubmission(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ILIAS\Repository\lng(), null, ilLanguage\txt(), and ILIAS\Repository\ui().
ilToolbarGUI::getHidden | ( | ) |
Definition at line 90 of file class.ilToolbarGUI.php.
References $hidden.
Referenced by getGroupedItems().
ilToolbarGUI::getId | ( | ) |
Definition at line 100 of file class.ilToolbarGUI.php.
Referenced by getGroupedItems().
ilToolbarGUI::getItems | ( | ) |
ilToolbarGUI::getOpenFormTag | ( | ) |
Definition at line 234 of file class.ilToolbarGUI.php.
References $open_form_tag.
Referenced by getGroupedItems().
ilToolbarGUI::getPreventDoubleSubmission | ( | ) |
Definition at line 110 of file class.ilToolbarGUI.php.
References $prevent_double_submission.
Referenced by getGroupedItems().
ilToolbarGUI::setCloseFormTag | ( | bool | $a_val | ) |
Definition at line 239 of file class.ilToolbarGUI.php.
Referenced by ilObjTestGUI\forwardToInfoScreen().
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 63 of file class.ilToolbarGUI.php.
Referenced by ilTestRandomQuestionSetSourcePoolDefinitionListToolbarGUI\build(), ilTestSkillEvaluationToolbarGUI\build(), McstImageGalleryGUI\getHTML(), and ilContSkillAdminGUI\listProfiles().
ilToolbarGUI::setFormName | ( | string | $a_val | ) |
Definition at line 249 of file class.ilToolbarGUI.php.
ilToolbarGUI::setHidden | ( | bool | $a_val | ) |
Definition at line 85 of file class.ilToolbarGUI.php.
ilToolbarGUI::setId | ( | string | $a_val | ) |
Definition at line 95 of file class.ilToolbarGUI.php.
Referenced by ilTestSubmissionReviewGUI\buildToolbar(), ilCalendarAppointmentPresentationGUI\getContentByPlugins(), ilCalendarAppointmentPresentationGUI\getModalHTML(), and ilContainerGUI\showAdministrationPanel().
ilToolbarGUI::setItems | ( | array | $items | ) |
Definition at line 464 of file class.ilToolbarGUI.php.
References $items.
Referenced by ilTestInfoScreenToolbarGUI\clearItems().
ilToolbarGUI::setLeadingImage | ( | string | $a_img, |
string | $a_alt | ||
) |
Definition at line 78 of file class.ilToolbarGUI.php.
Referenced by ILIAS\components\UICore\MetaTemplate\PageContentGUI\fillAdminPanel(), ilGlobalTemplate\fillAdminPanel(), ilDataCollectionGlobalTemplate\fillAdminPanel(), ilContainerGUI\showAdministrationPanel(), and ilObjWorkspaceFolderGUI\showAdministrationPanel().
ilToolbarGUI::setOpenFormTag | ( | bool | $a_val | ) |
Definition at line 228 of file class.ilToolbarGUI.php.
ilToolbarGUI::setPreventDoubleSubmission | ( | bool | $a_val | ) |
Definition at line 105 of file class.ilToolbarGUI.php.
|
protected |
Definition at line 40 of file class.ilToolbarGUI.php.
Referenced by getCloseFormTag().
|
protected |
Definition at line 32 of file class.ilToolbarGUI.php.
Referenced by getFormAction().
|
protected |
Definition at line 42 of file class.ilToolbarGUI.php.
Referenced by getFormName().
|
protected |
Definition at line 41 of file class.ilToolbarGUI.php.
|
protected |
Definition at line 45 of file class.ilToolbarGUI.php.
|
protected |
Definition at line 33 of file class.ilToolbarGUI.php.
Referenced by getHidden().
|
protected |
Definition at line 31 of file class.ilToolbarGUI.php.
Referenced by ilTestNavigationToolbarGUI\buildCheckNavigationClosure().
|
staticprotected |
Definition at line 30 of file class.ilToolbarGUI.php.
array ilToolbarGUI::$items = array() |
Definition at line 34 of file class.ilToolbarGUI.php.
Referenced by getItems(), and setItems().
|
protected |
Definition at line 35 of file class.ilToolbarGUI.php.
|
protected |
Definition at line 29 of file class.ilToolbarGUI.php.
Referenced by ilTestRandomQuestionSetSourcePoolDefinitionListToolbarGUI\__construct(), and getGroupedItems().
|
protected |
Definition at line 47 of file class.ilToolbarGUI.php.
|
protected |
Definition at line 39 of file class.ilToolbarGUI.php.
Referenced by getOpenFormTag().
|
protected |
Definition at line 43 of file class.ilToolbarGUI.php.
Referenced by getPreventDoubleSubmission().
|
protected |
Definition at line 44 of file class.ilToolbarGUI.php.
|
protected |
Definition at line 46 of file class.ilToolbarGUI.php.