Overview

Namespaces

  • DcGeneral
    • Clipboard
    • Contao
      • Callback
      • Compatibility
      • DataDefinition
        • Definition
      • Dca
        • Builder
          • Legacy
        • Definition
        • Palette
        • Populator
      • Event
      • View
        • Contao2BackendView
          • Event
    • Controller
    • Data
    • DataDefinition
      • Builder
      • Definition
        • Properties
        • View
          • Panel
      • ModelRelationship
      • Palette
        • Builder
          • Event
        • Condition
          • Palette
          • Property
    • EnvironmentPopulator
    • Event
    • Exception
    • Factory
      • Event
    • Panel
    • View
      • Event

Classes

  • BaseButtonEvent
  • BaseGetButtonsEvent
  • BuildWidgetEvent
  • DecodePropertyValueForWidgetEvent
  • EditModelBeforeSaveEvent
  • EncodePropertyValueFromWidgetEvent
  • GetBreadcrumbEvent
  • GetEditModeButtonsEvent
  • GetGlobalButtonEvent
  • GetGlobalButtonsEvent
  • GetGroupHeaderEvent
  • GetOperationButtonEvent
  • GetParentHeaderEvent
  • GetPasteButtonEvent
  • GetPasteRootButtonEvent
  • GetPropertyOptionsEvent
  • GetSelectModeButtonsEvent
  • ManipulateWidgetEvent
  • ModelToLabelEvent
  • ParentViewChildRecordEvent
  • ResolveWidgetErrorMessageEvent
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class BuildWidgetEvent

Class BuildWidgetEvent.

This event is being emitted when the widget manager wants to create a new widget instance.

Symfony\Component\EventDispatcher\Event
Extended by DcGeneral\Event\AbstractEnvironmentAwareEvent implements DcGeneral\EnvironmentAwareInterface
Extended by DcGeneral\Event\AbstractModelAwareEvent implements DcGeneral\ModelAwareInterface
Extended by DcGeneral\Contao\View\Contao2BackendView\Event\BuildWidgetEvent
Namespace: DcGeneral\Contao\View\Contao2BackendView\Event
Package: DcGeneral\Contao\View\Contao2BackendView\Event
Located at Contao/View/Contao2BackendView/Event/BuildWidgetEvent.php
Methods summary
public
# __construct( DcGeneral\EnvironmentInterface $environment, DcGeneral\Data\ModelInterface $model, DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $property )

Create a new event.

Create a new event.

Parameters

$environment
DcGeneral\EnvironmentInterface
$environment The environment instance in use.
$model
DcGeneral\Data\ModelInterface
$model The model holding the data for the widget that shall be instantiated.
$property
DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
$property The property for which the widget shall be instantiated.

Overrides

DcGeneral\Event\AbstractModelAwareEvent::__construct()
public DcGeneral\Contao\View\Contao2BackendView\Event\BuildWidgetEvent
# setWidget( Widget $widget )

Stores the widget instance into the event.

Stores the widget instance into the event.

Parameters

$widget
Widget
$widget The widget instance.

Returns

DcGeneral\Contao\View\Contao2BackendView\Event\BuildWidgetEvent
public Widget
# getWidget( )

Retrieve the widget instance from the event.

Retrieve the widget instance from the event.

Returns

Widget
public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
# getProperty( )

Retrieve the property definition from the event for which the widget shall be instantiated.

Retrieve the property definition from the event for which the widget shall be instantiated.

Returns

DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
Methods inherited from DcGeneral\Event\AbstractModelAwareEvent
getModel()
Methods inherited from DcGeneral\Event\AbstractEnvironmentAwareEvent
getEnvironment()
Constants summary
string NAME 'dc-general.view.contao2backend.build-widget'
#

The name of the event.

The name of the event.

Properties summary
protected DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $property
#

The property for which a widget shall get instantiated.

The property for which a widget shall get instantiated.

protected Widget $widget
#

The instantiated widget.

The instantiated widget.

Properties inherited from DcGeneral\Event\AbstractModelAwareEvent
$model
Properties inherited from DcGeneral\Event\AbstractEnvironmentAwareEvent
$environment
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0