contao-community-alliance/dc-general » \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Methods
Properties

Constants
- NAME
```
NAME
```

Class GetPasteButtonEvent.

This event gets emitted when a paste button is generated.

Methods

Get determinator if there exists a circular reference.

getCircularReference() : boolean

This flag determines if there exists a circular reference between the item currently in the clipboard and the current model. A circular reference is of relevance when performing a cut and paste operation for example.

deprecated	Use isCircularReference().
SuppressWarnings	(PHPMD.BooleanGetMethodName)

Returns

boolean

Retrieve the collection of contained models.

getContainedModels() : \ContaoCommunityAlliance\DcGeneral\Data\CollectionInterface

Returns

\ContaoCommunityAlliance\DcGeneral\Data\CollectionInterface

Get the href for the paste after button.

getHrefAfter() : string

Returns

string

Get the href for the paste into button.

getHrefInto() : string

Returns

string

Get the html code for the paste after button.

getHtmlPasteAfter() : string

Returns

string

Get the html code for the paste after button.

getHtmlPasteInto() : string

Returns

string

Get the model currently in scope.

getModel() : \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

Get the next model.

getNext() : \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

Get the previous model.

getPrevious() : \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

Returns

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

Get determinator if there exists a circular reference.

isCircularReference() : boolean

Returns

boolean

Check if the paste after button shall be disabled.

isPasteAfterDisabled() : boolean

Returns

boolean

Check if the paste into button shall be disabled.

isPasteIntoDisabled() : boolean

Returns

boolean

Set determinator if there exists a circular reference.

setCircularReference(boolean $circularReference) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

fluent	This method is part of a fluent interface and will return the same instance

Parameters

$circularReference

boolean

The flag.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Set the collection of contained models.

setContainedModels(\ContaoCommunityAlliance\DcGeneral\Data\CollectionInterface $containedModels) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Parameters

$containedModels

\ContaoCommunityAlliance\DcGeneral\Data\CollectionInterface

The collection of contained models.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Set the href for the paste after button.

setHrefAfter(string $hrefAfter) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

fluent	This method is part of a fluent interface and will return the same instance

Parameters

$hrefAfter

string

The href.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Set the href for the paste into button.

setHrefInto(string $hrefInto) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

fluent	This method is part of a fluent interface and will return the same instance

Parameters

$hrefInto

string

The href.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Set the html code for the paste after button.

setHtmlPasteAfter(string $html) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

fluent	This method is part of a fluent interface and will return the same instance

Parameters

$html

string

The HTML code.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Set the html code for the paste into button.

setHtmlPasteInto(string $html) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

fluent	This method is part of a fluent interface and will return the same instance

Parameters

$html

string

The HTML code.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Set the model currently in scope.

setModel(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $model) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

fluent	This method is part of a fluent interface and will return the same instance

Parameters

$model

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

The model currently in scope.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Set the next model.

setNext(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $next) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

fluent	This method is part of a fluent interface and will return the same instance

Parameters

$next

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

The next model.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Set the determinator if the paste after button shall be disabled.

setPasteAfterDisabled(boolean $pasteAfterDisabled) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

fluent	This method is part of a fluent interface and will return the same instance

Parameters

$pasteAfterDisabled

boolean

Determinator flag for the disabling state.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Set the determinator if the paste into button shall be disabled.

setPasteIntoDisabled(boolean $pasteIntoDisabled) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

fluent	This method is part of a fluent interface and will return the same instance

Parameters

$pasteIntoDisabled

boolean

Determinator flag for the disabling state.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Set the previous model.

setPrevious(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $previous) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

fluent	This method is part of a fluent interface and will return the same instance

Parameters

$previous

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

The previous model.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Properties

Determinator if there is a circular reference from an item in the clipboard to the current model.

$circularReference : bool

The models currently in the clipboard.

$containedModels : \ContaoCommunityAlliance\DcGeneral\Data\CollectionInterface

The href information to use for the paste after button.

$hrefAfter : string

The href information to use for the paste into button.

$hrefInto : string

The Html code to use for the "paste after" button.

$htmlPasteAfter : string

The Html code to use for the "paste into" button.

$htmlPasteInto : string

The model to which the command shall be applied to.

$model : \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

The next model in the list.

$next : \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

Determinator if the paste after button shall be disabled.

$pasteAfterDisabled : bool

Determinator if the paste into button shall be disabled.

$pasteIntoDisabled : bool

The previous model in the list.

$previous : \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

Constants

NAME

NAME