Caplin Trader 5.1.0

Class: module:ct-grid/decorator/DropDecorator

module:ct-grid/decorator/DropDecorator(config)

new module:ct-grid/decorator/DropDecorator(config)

Constructs a DropDecorator instance — end-users will never need to do this themselves since grids are fully constructed based on their XML definition files by the module:ct-grid/GridComponentFactory class.

The drop decorator is used to allow receiving instruments that have been dragged onto a grid configured with this decorator from other grids or trade panels configured with the drag decorator. The drop decorator only makes sense where the grid rows are instruments that can be requested from the Liberator.

It ultimately passes the received instruments on to the GridView's receiveObjects method.

Extends:
Parameters:
Name Type Description
config oject

config object
Implements:

Extends

Methods

canReceive()

Implements:
See:

canReceiveMultipleObjects()

Implements:
See:

canReceiveObjects()

Implements:
See:

disposeDropTarget()

Disposes the drop target

Inherited From:

getLastReceiveFailureMessage()

Implements:
See:

getSuccessMessage()

Implements:
See:

onClose()

Implements:
See:
  • module:ct-grid/decorator/GridViewListener#onClose

onContainerHtmlRendered()

Implements:
See:
  • module:ct-grid/decorator/GridViewListener#onContainerHtmlRendered

receiveObjects()

Implements:
See:

setDropTarget(component, config)

Sets the drop target

Parameters:
Name Type Description
component module:ct-component/Component

The component to be set as a drop target
config Object

The drop decorator configuration object

Properties
Name Type Description
ddGroup String

The logical name for the group of instruments that are accepted by the component.
Inherited From:

setGridView()

Implements:
See: