96 lines
1.9 KiB
PHP
96 lines
1.9 KiB
PHP
<?php
|
|
|
|
namespace FML\Types;
|
|
|
|
use FML\Elements\Format;
|
|
use FML\Stylesheet\Style;
|
|
|
|
/**
|
|
* Interface for Element being able to contain other Controls
|
|
*
|
|
* @author steeffeen <mail@steeffeen.com>
|
|
* @copyright FancyManiaLinks Copyright © 2017 Steffen Schröder
|
|
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
|
|
*/
|
|
interface Container
|
|
{
|
|
|
|
/**
|
|
* Get the children
|
|
*
|
|
* @api
|
|
* @return Renderable[]
|
|
*/
|
|
public function getChildren();
|
|
|
|
/**
|
|
* Add a new child
|
|
*
|
|
* @api
|
|
* @param Renderable $child Child Control to add
|
|
* @return static
|
|
*/
|
|
public function addChild(Renderable $child);
|
|
|
|
/**
|
|
* Add a new child
|
|
*
|
|
* @api
|
|
* @param Renderable $child Child Control to add
|
|
* @return static
|
|
* @deprecated Use addChild()
|
|
* @see Container::addChild()
|
|
*/
|
|
public function add(Renderable $child);
|
|
|
|
/**
|
|
* Add new children
|
|
*
|
|
* @api
|
|
* @param Renderable[] $children Child Controls to add
|
|
* @return static
|
|
*/
|
|
public function addChildren(array $children);
|
|
|
|
/**
|
|
* Remove all children
|
|
*
|
|
* @api
|
|
* @return static
|
|
*/
|
|
public function removeAllChildren();
|
|
|
|
/**
|
|
* Remove all children
|
|
*
|
|
* @api
|
|
* @return static
|
|
* @deprecated Use removeAllChildren()
|
|
* @see Container::removeAllChildren()
|
|
*/
|
|
public function removeChildren();
|
|
|
|
/**
|
|
* Get the Format
|
|
*
|
|
* @api
|
|
* @param bool $createIfEmpty If the format should be created if it doesn't exist yet
|
|
* @return Format
|
|
* @deprecated Use Style
|
|
* @see Style
|
|
*/
|
|
public function getFormat($createIfEmpty = true);
|
|
|
|
/**
|
|
* Set the Format
|
|
*
|
|
* @api
|
|
* @param Format $format New Format
|
|
* @return static
|
|
* @deprecated Use Style
|
|
* @see Style
|
|
*/
|
|
public function setFormat(Format $format = null);
|
|
|
|
}
|