TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface:

Public Member Functions
string	getIdentifier ()
string	getServiceName ()
array	getGroupNames ()
string	getTitle ()
string	getDescription ()
string	getIconIdentifier ()
string	getHeight ()
string	getWidth ()
string	getAdditionalCssClasses ()

Detailed Description

Defines API of configuration for a widget. This is separated by concrete implementation of a widget (WidgetInterface). The configuration is used to generate UX, and other stuff.

Definition at line 25 of file WidgetConfigurationInterface.php.

Member Function Documentation

getAdditionalCssClasses()

string TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface::getAdditionalCssClasses

(

)

This method returns additional CSS classes which should be added to the rendered widget

Returns

‪string

Implemented in TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration.

getDescription()

string TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface::getDescription

(

)

Returns the description of a widget, this is used for the widget selector

Returns

‪string

Implemented in TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration.

getGroupNames()

array TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface::getGroupNames

(

)

Returns array of group names associated to this widget

Returns

‪array

Implemented in TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration.

getHeight()

string TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface::getHeight

(

)

Returns the height of a widget (small, medium, large)

Returns

‪string

Implemented in TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration.

getIconIdentifier()

string TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface::getIconIdentifier

(

)

Returns the icon identifier of a widget, this is used for the widget selector

Returns

‪string

Implemented in TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration.

getIdentifier()

string TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface::getIdentifier

(

)

Returns the unique identifier of a widget

Returns

‪string

Implemented in TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration.

getServiceName()

string TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface::getServiceName

(

)

Returns the service name providing the widget implementation

Returns

‪string

Implemented in TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration.

getTitle()

string TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface::getTitle

(

)

Returns the title of a widget, this is used for the widget selector

Returns

‪string

Implemented in TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration.

getWidth()

string TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface::getWidth

(

)

Returns the width of a widget (small, medium, large)

Returns

‪string

Implemented in TYPO3\CMS\Dashboard\Widgets\WidgetConfiguration.