TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton:

Public Member Functions
	getIcon ()
	setIcon (?Icon $icon)
	getLabel ()
	setLabel (string $label)
	getTitle ()
	setTitle (?string $title)
	getShowLabelText ()
	setShowLabelText (bool $showLabelText)
	addItem (DropDownItemInterface $item)
DropDownItemInterface[]	getItems ()
bool	isValid ()
string	getType ()
	__toString ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface
string	render ()

Protected Attributes
Icon	$icon = null
string	$label = ''
string	$title = null
array	$items = []
bool	$showLabelText = false

Detailed Description

DropDownButton

This button type is a container for dropdown items. It will render a dropdown containing all items attached to it. There are different kinds available, each item needs to implement the DropDownItemInterface. When this type contains elements of type DropDownRadio it will use the icon of the first active item of this type.

$buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar(); $dropDownButton = $buttonBar->makeDropDownButton() ->setLabel('Dropdown') ->setTitle('Save') ->setIcon($this->iconFactory->getIcon('actions-heart')) ->getShowLabelText(true) ->addItem( GeneralUtility::makeInstance(DropDownItem::class) ->setLabel('Item') ->setHref('#') ); $buttonBar->addButton($dropDownButton, ButtonBar::BUTTON_POSITION_RIGHT, 2);

Definition at line 47 of file DropDownButton.php.

Member Function Documentation

__toString()

TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::__toString

(

)

Definition at line 194 of file DropDownButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface\render().

addItem()

TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::addItem

(

DropDownItemInterface

$item

)

Definition at line 100 of file DropDownButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\DropDown\DropDownItemInterface\getType(), and TYPO3\CMS\Backend\Template\Components\Buttons\DropDown\DropDownItemInterface\isValid().

getIcon()

TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::getIcon

(

)

Definition at line 55 of file DropDownButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\$icon.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\isValid().

getItems()

DropDownItemInterface [] TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::getItems

(

)

Returns

‪DropDownItemInterface[]

Definition at line 119 of file DropDownButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\$items.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\isValid().

getLabel()

TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::getLabel

(

)

Definition at line 67 of file DropDownButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\$label.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\isValid().

getShowLabelText()

TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::getShowLabelText

(

)

Definition at line 89 of file DropDownButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\$showLabelText.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\isValid().

getTitle()

TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::getTitle

(

)

Definition at line 78 of file DropDownButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\$label.

getType()

string TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::getType

(

)

Returns

‪string

Implements TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface.

Definition at line 137 of file DropDownButton.php.

isValid()

bool TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::isValid

(

)

Returns

‪bool

Implements TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface.

Definition at line 127 of file DropDownButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\getIcon(), TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\getItems(), TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\getLabel(), and TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\getShowLabelText().

setIcon()

TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::setIcon

(

?Icon

$icon

)

Definition at line 60 of file DropDownButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\$icon, and TYPO3\CMS\Core\Imaging\Icon\setSize().

setLabel()

TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::setLabel

(

string

$label

)

Definition at line 72 of file DropDownButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\$label.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\makeLanguageSwitchButton().

setShowLabelText()

TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::setShowLabelText

(

bool

$showLabelText

)

Definition at line 94 of file DropDownButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\$showLabelText.

setTitle()

TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::setTitle

(

?string

$title

)

Definition at line 83 of file DropDownButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\$title.

Member Data Documentation

$icon

Icon TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::$icon = null

protected

Definition at line 49 of file DropDownButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\getIcon(), and TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\setIcon().

$items

array TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::$items = []

protected

Definition at line 52 of file DropDownButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\getItems().

$label

string TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::$label = ''

protected

Definition at line 50 of file DropDownButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\getLabel(), TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\getTitle(), and TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\setLabel().

$showLabelText

bool TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::$showLabelText = false

protected

Definition at line 53 of file DropDownButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\getShowLabelText(), and TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\setShowLabelText().

$title

string TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton::$title = null

protected

Definition at line 51 of file DropDownButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\DropDownButton\setTitle().