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

  • AbstractElement
  • DefaultFilterElement
  • DefaultLimitElement
  • DefaultPanel
  • DefaultPanelContainer
  • DefaultSearchElement
  • DefaultSortElement
  • DefaultSubmitElement

Interfaces

  • FilterElementInterface
  • LimitElementInterface
  • PanelContainerInterface
  • PanelElementInterface
  • PanelInterface
  • SearchElementInterface
  • SortElementInterface
  • SubmitElementInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Interface PanelInterface

this interface describes a panel.

A panel is a row of a panel container.

DcGeneral\Panel\PanelInterface implements IteratorAggregate

Direct known implementers

DcGeneral\Panel\DefaultPanel
Namespace: DcGeneral\Panel
Package: DcGeneral\Panel
Located at Panel/PanelInterface.php
Methods summary
public DcGeneral\Panel\PanelContainerInterface
# getContainer( )

Get the parenting container.

Get the parenting container.

Returns

DcGeneral\Panel\PanelContainerInterface
public DcGeneral\Panel\PanelInterface
# setContainer( DcGeneral\Panel\PanelContainerInterface $objContainer )

Set the parenting container.

Set the parenting container.

Parameters

$objContainer
DcGeneral\Panel\PanelContainerInterface
$objContainer The Container to be used as parent.

Returns

DcGeneral\Panel\PanelInterface
public mixed
# addElement( string $strKey, DcGeneral\Panel\PanelElementInterface $objElement )

Add an element to the panel.

Add an element to the panel.

Parameters

$strKey
string
$strKey Name of the panel.
$objElement
DcGeneral\Panel\PanelElementInterface
$objElement The element instance to add.

Returns

mixed
public DcGeneral\Panel\PanelElementInterface
# getElement( string $strKey )

Retrieve an element with the given name.

Retrieve an element with the given name.

Parameters

$strKey
string
$strKey The name of the element.

Returns

DcGeneral\Panel\PanelElementInterface
public
# initialize( DcGeneral\Data\ConfigInterface $objConfig, DcGeneral\Panel\PanelElementInterface $objElement = null )

Initialize the passed config via all contained elements.

Initialize the passed config via all contained elements.

Parameters

$objConfig
DcGeneral\Data\ConfigInterface
$objConfig The config to which the initialization shall be applied to.
$objElement
DcGeneral\Panel\PanelElementInterface
$objElement The element to be initialized (if any).
Methods inherited from IteratorAggregate
getIterator()
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0