Methods
-
canReceive()
-
Whether a receiver is currently accepting new objects.
-
canReceiveMultipleObjects()
-
Whether the receiver is able to handle multiple objects.
-
canReceiveObjects(objects)
-
Use this to determine if the objects being dropped can be received.
Parameters:
Name Type Description objects
Array The list of object names about to passed to this receiver -
getLastReceiveFailureMessage()
-
This method is abstract and must be implemented by subclasses.
This method is used when
module:caplin/component/InstrumentReceiver#canReceiveObjects
returnsfalse
and an error message is required to explain why the objects were not accepted.- Implementations:
- module:caplin/grid/decorator/DropDecorator#getLastReceiveFailureMessage
- module:caplin/grid/PersonalGridDataProvider#getLastReceiveFailureMessage
-
getSuccessMessage()
-
This method is abstract and must be implemented by subclasses.
This method is used when
module:caplin/component/InstrumentReceiver#canReceiveObjects
returnstrue
and a success message is required to explain when the objects are accepted.- Implementations:
- module:caplin/grid/decorator/DropDecorator#getSuccessMessage
- module:caplin/grid/PersonalGridDataProvider#getSuccessMessage
-
receiveObjects(objects, indexopt)
-
The callback method that is invoked when an object is dropped onto the implementing object.
Parameters:
Name Type Attributes Description objects
Array The list of object names being passed to this receiver index
number <optional>
The index to insert the new objects at. If not included, objects should be appended to the end. - Implementations:
- module:caplin/grid/decorator/DropDecorator#receiveObjects
- module:caplin/grid/PersonalGridDataProvider#receiveObjects