Package com.levigo.jadice.web.client.tools.dnd

Interface ExportHandler

All Known Implementing Classes:

DOCPVExportHandler, JWTExportHandler

public interface ExportHandler

ExportHandler can be used to put custom data into a dragEvent. They can be registered in the SelectPageTool.

See also: SelectPageTool.getExportHandlers() ImportHandler

Method Summary

Modifier and Type	Method	Description
boolean	canExport(DnDParameter parameter)	This method is called when a DragStartEvent is fired to decide which handler can export this drop.
void	export(DnDParameter parameter)	This method is responsible for generating the data that should be transported with the event and putting them into it.
void	exportDone(DnDParameter parameter)	This method is called when all exportHandler finished their exports.

Method Details

canExport

boolean canExport(DnDParameter parameter)

This method is called when a DragStartEvent is fired to decide which handler can export this drop.

Parameters:

parameter - The parameter containing the event.

Returns:

True if the handler can export the drop, false otherwise.

export

void export(DnDParameter parameter)

This method is responsible for generating the data that should be transported with the event and putting them into it. The data has to be set into the datastore of the event straight forward in this call. While this event is active is the only time we have write access to the datastore. If generating the data takes to long it may be better to store some kind of reference to the data in the event. That is also the reason why all registered export handler have to generate and write their data into the datastore at the beginning of the dragEvent.

Parameters:

parameter - The parameter containing the event.

exportDone

void exportDone(DnDParameter parameter)

This method is called when all exportHandler finished their exports.

Parameters:

parameter - The parameter containing the event.