Class GetPasteButtonEvent

Class GetPasteButtonEvent.

This event gets emitted when a paste button is generated.

Symfony\Component\EventDispatcher\Event

DcGeneral\Event\AbstractEnvironmentAwareEvent implements DcGeneral\EnvironmentAwareInterface

DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent

DcGeneral\Contao\View\Contao2BackendView\Event\GetPasteButtonEvent

Namespace: DcGeneral\Contao\View\Contao2BackendView\Event
Package: DcGeneral\Contao\View\Contao2BackendView\Event
Located at Contao/View/Contao2BackendView/Event/GetPasteButtonEvent.php

Methods summary
`public mixed`	# `setCircularReference( boolean $blnCircularReference )` Set determinator if there exists a circular reference. Set determinator if there exists a circular reference. 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. Parameters `$blnCircularReference` `boolean` $blnCircularReference The flag. Returns `mixed` $this
`public boolean`	# `getCircularReference( )` Get determinator if there exists a circular reference. Get determinator if there exists a circular reference. 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. Returns `boolean`
`public mixed`	# `setHrefAfter( string $hrefAfter )` Set the href for the paste after button. Set the href for the paste after button. Parameters `$hrefAfter` `string` $hrefAfter The href. Returns `mixed` $this
`public string`	# `getHrefAfter( )` Get the href for the paste after button. Get the href for the paste after button. Returns `string`
`public mixed`	# `setHrefInto( string $hrefInto )` Set the href for the paste into button. Set the href for the paste into button. Parameters `$hrefInto` `string` $hrefInto The href. Returns `mixed` $this
`public string`	# `getHrefInto( )` Get the href for the paste into button. Get the href for the paste into button. Returns `string`
`public mixed`	# `setHtmlPasteAfter( string $html )` Set the html code for the paste after button. Set the html code for the paste after button. Parameters `$html` `string` $html The HTML code. Returns `mixed` $this
`public string`	# `getHtmlPasteAfter( )` Get the html code for the paste after button. Get the html code for the paste after button. Returns `string`
`public mixed`	# `setHtmlPasteInto( string $html )` Set the html code for the paste into button. Set the html code for the paste into button. Parameters `$html` `string` $html The HTML code. Returns `mixed` $this
`public string`	# `getHtmlPasteInto( )` Get the html code for the paste after button. Get the html code for the paste after button. Returns `string`
`public mixed`	# `setModel( DcGeneral\Data\ModelInterface $model )` Set the model currently in scope. Set the model currently in scope. Parameters `$model` `DcGeneral\Data\ModelInterface` $model The model currently in scope. Returns `mixed` $this
`public DcGeneral\Data\ModelInterface`	# `getModel( )` Get the model currently in scope. Get the model currently in scope. Returns `DcGeneral\Data\ModelInterface`
`public mixed`	# `setNext( DcGeneral\Data\ModelInterface $next )` Set the next model. Set the next model. Parameters `$next` `DcGeneral\Data\ModelInterface` $next The next model. Returns `mixed` $this
`public DcGeneral\Data\ModelInterface`	# `getNext( )` Get the next model. Get the next model. Returns `DcGeneral\Data\ModelInterface`
`public mixed`	# `setPrevious( DcGeneral\Data\ModelInterface $previous )` Set the previous model. Set the previous model. Parameters `$previous` `DcGeneral\Data\ModelInterface` $previous The previous model. Returns `mixed` $this
`public DcGeneral\Data\ModelInterface`	# `getPrevious( )` Get the previous model. Get the previous model. Returns `DcGeneral\Data\ModelInterface`
`public mixed`	# `setPasteAfterDisabled( boolean $pasteAfterDisabled )` Set the determinator if the paste after button shall be disabled. Set the determinator if the paste after button shall be disabled. Parameters `$pasteAfterDisabled` `boolean` $pasteAfterDisabled Determinator flag for the disabling state. Returns `mixed` $this
`public boolean`	# `isPasteAfterDisabled( )` Check if the paste after button shall be disabled. Check if the paste after button shall be disabled. Returns `boolean`
`public mixed`	# `setPasteIntoDisabled( boolean $pasteIntoDisabled )` Set the determinator if the paste into button shall be disabled. Set the determinator if the paste into button shall be disabled. Parameters `$pasteIntoDisabled` `boolean` $pasteIntoDisabled Determinator flag for the disabling state. Returns `mixed` $this
`public boolean`	# `isPasteIntoDisabled( )` Check if the paste into button shall be disabled. Check if the paste into button shall be disabled. Returns `boolean`

Methods inherited from DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent
`getAttributes(), getHtml(), getKey(), getLabel(), getTitle(), setAttributes(), setHtml(), setKey(), setLabel(), setTitle()`

Methods inherited from DcGeneral\Event\AbstractEnvironmentAwareEvent
`__construct(), getEnvironment()`

Constants inherited from DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent
`NAME`

Properties summary
`protected boolean`	`$blnCircularReference`	# Determinator if there is a circular reference from an item in the clipboard to the current model. Determinator if there is a circular reference from an item in the clipboard to the current model.
`protected string`	`$hrefAfter`	# The href information to use for the paste after button. The href information to use for the paste after button.
`protected string`	`$hrefInto`	# The href information to use for the paste into button. The href information to use for the paste into button.
`protected string`	`$htmlPasteAfter`	# The Html code to use for the "paste after" button. The Html code to use for the "paste after" button.
`protected string`	`$htmlPasteInto`	# The Html code to use for the "paste into" button. The Html code to use for the "paste into" button.
`protected DcGeneral\Data\ModelInterface`	`$model`	# The model to which the command shall be applied to. The model to which the command shall be applied to.
`protected DcGeneral\Data\ModelInterface`	`$next`	# The next model in the list. The next model in the list.
`protected DcGeneral\Data\ModelInterface`	`$previous`	# The previous model in the list. The previous model in the list.
`protected boolean`	`$pasteIntoDisabled`	# Determinator if the paste into button shall be disabled. Determinator if the paste into button shall be disabled.
`protected boolean`	`$pasteAfterDisabled`	# Determinator if the paste after button shall be disabled. Determinator if the paste after button shall be disabled.

Properties inherited from DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent
`$attributes, $html, $key, $label, $title`

Properties inherited from DcGeneral\Event\AbstractEnvironmentAwareEvent
`$environment`

Namespaces

Classes

Class GetPasteButtonEvent

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns