Class ilSplitButton. More...

Inheritance diagram for ilSplitButtonGUI:

Collaboration diagram for ilSplitButtonGUI:

Public Member Functions
	addMenuItem (ilSplitButtonMenuItem $menu_item)

	removeMenuItem (ilSplitButtonMenuItem $menu_item)

	hasMenuItems ()

	getMenuItems ()

	setMenuItems ($menu_items)

	getDefaultButton ()

	hasDefaultButton ()

	setDefaultButton (ilButtonBase $default_button)

	render ()

Public Member Functions inherited from ilButtonBase
	__clone ()
	Clone instance. More...

	getType ()
	Get button type. More...

	setId ($a_value)
	Set id. More...

	getId ()
	Get id. More...

	setCaption ($a_value, $a_is_lng_id=true)
	Set caption. More...

	getCaption ($a_translate=true)
	Get caption. More...

	setPrimary ($a_value)
	Toggle primary status. More...

	isPrimary ()
	Get primary status. More...

	setOmitPreventDoubleSubmission ($a_value)
	Toggle double submission prevention status. More...

	getOmitPreventDoubleSubmission ()
	Get double submission prevention status. More...

	setOnClick ($a_value)
	Set onclick. More...

	getOnClick ()
	Get onclick. More...

	setAccessKey ($a_value)
	Set access key. More...

	getAccessKey ()
	Get access key. More...

	setDisabled ($a_value)
	Toggle disabled status. More...

	isDisabled ()
	Get disabled status. More...

	addCSSClass ($a_value)
	Add CSS class. More...

	getCSSClasses ()
	Get CSS class(es) More...

	applyDefaultCss ($apply_default_css=null)

	render ()
	Render HTML. More...

	getToolbarHTML ()

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Static Public Member Functions
static	getInstance ()

static	getInstance ()
	Factory. More...

Protected Attributes
	$lng

	$default_button

	$menu_items = array()

Protected Attributes inherited from ilButtonBase
	$lng

	$type

	$id

	$caption

	$caption_is_lng_id

	$primary

	$omit_prevent_double_submission

	$onclick

	$acc_key

	$disabled

	$css = array()

	$apply_default_css = true

Additional Inherited Members
Data Fields inherited from ilButtonBase
const	TYPE_SUBMIT = 1

const	TYPE_LINK = 2

const	TYPE_SPLIT = 3

const	TYPE_BUTTON = 4

Protected Member Functions inherited from ilButtonBase
	__construct ($a_type)
	Constructor. More...

	setType ($a_value)
	Set button type. More...

	gatherCssClasses ()
	Gather all active CSS classes. More...

	renderAttributesHelper (array $a_attr)
	Render HTML node attributes. More...

	renderAttributes (array $a_additional_attr=null)
	Render current HTML attributes. More...

	prepareRender ()
	Prepare render. More...

Detailed Description

Class ilSplitButton.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 14 of file class.ilSplitButtonGUI.php.

Member Function Documentation

◆ addMenuItem()

ilSplitButtonGUI::addMenuItem ( ilSplitButtonMenuItem $menu_item )

Parameters

ilSplitButtonMenuItem $menu_item

Definition at line 59 of file class.ilSplitButtonGUI.php.

    {
        $this->menu_items[] = $menu_item;
    }

◆ getDefaultButton()

ilSplitButtonGUI::getDefaultButton ( )

Returns: ilButtonBase

Definition at line 112 of file class.ilSplitButtonGUI.php.

    {
        return $this->default_button;
    }

References $default_button.

Referenced by render().

Here is the caller graph for this function:

◆ getInstance()

static ilSplitButtonGUI::getInstance ( )

static

Returns: self;

Reimplemented from ilButtonBase.

Definition at line 51 of file class.ilSplitButtonGUI.php.

    {
        return new self(self::TYPE_SPLIT);
    }

References ilButtonBase\TYPE_SPLIT.

Referenced by ilRepositorySearchGUI\fillAutoCompleteToolbar(), ilPortfolioPageTableGUI\fillRow(), assClozeTestGUI\populateQuestionSpecificFormPart(), and ilObjForumGUI\renderSplitButton().

Here is the caller graph for this function:

◆ getMenuItems()

ilSplitButtonGUI::getMenuItems ( )

Returns: ilSplitButtonMenuItem[]

Definition at line 86 of file class.ilSplitButtonGUI.php.

    {
        return $this->menu_items;
    }

References $menu_items.

Referenced by render().

Here is the caller graph for this function:

◆ hasDefaultButton()

ilSplitButtonGUI::hasDefaultButton ( )

Returns: boolean

Definition at line 120 of file class.ilSplitButtonGUI.php.

    {
        return ($this->default_button instanceof ilButtonBase);
    }

Referenced by render().

Here is the caller graph for this function:

◆ hasMenuItems()

ilSplitButtonGUI::hasMenuItems ( )

Returns: boolean

Definition at line 78 of file class.ilSplitButtonGUI.php.

    {
        return count($this->menu_items) > 0;
    }

Referenced by render().

Here is the caller graph for this function:

◆ removeMenuItem()

ilSplitButtonGUI::removeMenuItem ( ilSplitButtonMenuItem $menu_item )

Parameters

ilSplitButtonMenuItem $menu_item

Definition at line 67 of file class.ilSplitButtonGUI.php.

    {
        $key = array_search($menu_item, $this->menu_items);
        if ($key !== false) {
            unset($this->menu_items[$key]);
        }
    }

◆ render()

ilSplitButtonGUI::render ( )

Returns: string

Exceptions

ilSplitButtonException

Reimplemented from ilButtonBase.

Definition at line 137 of file class.ilSplitButtonGUI.php.

    {
        $tpl = new ilTemplate('tpl.split_button.html', true, true, 'Services/UIComponent/SplitButton');
 
        if (!$this->hasDefaultButton()) {
            throw new ilSplitButtonException(
                "Cannot render a split button without a default button"
            );
        }
 
        $tpl->setVariable('DEFAULT_ITEM_CONTENT', $this->getDefaultButton()->render());
        if ($this->hasMenuItems()) {
            $btn_classes = $this->getDefaultButton()->getCSSClasses();
            if ($this->getDefaultButton()->isPrimary()) {
                $btn_classes[] = 'btn-primary';
            }
            $tpl->setVariable('BTN_CSS_CLASS', implode(' ', $btn_classes));
 
            foreach ($this->getMenuItems() as $item) {
                if ($item instanceof ilSplitButtonSeparatorMenuItem) {
                    $tpl->setCurrentBlock('separator');
                    $tpl->touchBlock('separator');
                    $tpl->parseCurrentBlock();
                } else {
                    $tpl->setCurrentBlock('item');
                    $tpl->setVariable('CONTENT', $item->getContent());
                    $tpl->parseCurrentBlock();
                }
 
                $tpl->setCurrentBlock('items');
                $tpl->parseCurrentBlock();
            }
 
            $tpl->setVariable('TXT_TOGGLE_DROPDOWN', $this->lng->txt('toggle_dropdown'));
        }
 
        return $tpl->get();
    }

References $tpl, getDefaultButton(), getMenuItems(), hasDefaultButton(), hasMenuItems(), ilButtonBase\isPrimary(), and render().

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultButton()

ilSplitButtonGUI::setDefaultButton ( ilButtonBase $default_button )

Parameters

ilButtonBase $default_button

Definition at line 128 of file class.ilSplitButtonGUI.php.

    {
        $this->default_button = $default_button;
    }

References $default_button.

◆ setMenuItems()

ilSplitButtonGUI::setMenuItems ( $menu_items )

Parameters

ilSplitButtonMenuItem[] $menu_items

Exceptions

ilSplitButtonException

Definition at line 95 of file class.ilSplitButtonGUI.php.

    {
        array_walk($menu_items, function (&$item, $idx) {
            if (!($item instanceof ilSplitButtonMenuItem)) {
                throw new ilSplitButtonException(sprintf(
                    "Cannot set menu items, element at index '%s' is not of type 'ilSplitButtonItem'",
                    $idx
                ));
            }
        });
 
        $this->menu_items = $menu_items;
    }

References $menu_items.

Field Documentation

◆ $default_button

ilSplitButtonGUI::$default_button

protected

Definition at line 24 of file class.ilSplitButtonGUI.php.

Referenced by getDefaultButton(), and setDefaultButton().

◆ $lng

ilSplitButtonGUI::$lng

protected

Definition at line 19 of file class.ilSplitButtonGUI.php.

◆ $menu_items

ilSplitButtonGUI::$menu_items = array()

protected

Definition at line 29 of file class.ilSplitButtonGUI.php.

Referenced by getMenuItems(), and setMenuItems().

The documentation for this class was generated from the following file:

Services/UIComponent/SplitButton/classes/class.ilSplitButtonGUI.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addMenuItem()

◆ getDefaultButton()

◆ getInstance()

◆ getMenuItems()

◆ hasDefaultButton()

◆ hasMenuItems()

◆ removeMenuItem()

◆ render()

◆ setDefaultButton()

◆ setMenuItems()

Field Documentation

◆ $default_button

◆ $lng

◆ $menu_items