TYPO3\CMS\Dashboard\Widgets\WidgetConfigurationInterface Interface Reference

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

Public Member Functions
	getIdentifier ()
	getServiceName ()
	getGroupNames ()
	getTitle ()
	getDescription ()
	getIconIdentifier ()
	getHeight ()
	getWidth ()
	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()

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

(

)

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

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

getDescription()

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

(

)

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

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

getGroupNames()

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

(

)

Returns array of group names associated to this widget

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

getHeight()

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

(

)

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

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

getIconIdentifier()

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

(

)

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

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

getIdentifier()

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

(

)

Returns the unique identifier of a widget

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

getServiceName()

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

(

)

Returns the service name providing the widget implementation

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

getTitle()

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

(

)

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

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

getWidth()

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

(

)

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

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