com.yworks.yfiles.view.input

Class StripeDropInputMode

java.lang.Object

com.yworks.yfiles.view.input.DropInputMode

com.yworks.yfiles.view.input.ItemDropInputMode<IStripe>

com.yworks.yfiles.view.input.StripeDropInputMode

All Implemented Interfaces:

IInputMode

public class StripeDropInputMode
extends ItemDropInputMode<IStripe>

An ItemDropInputMode specialized to drag 'n' drop IStripes.

A dragged IStripe is optionally visualized during the drag operation.

Field Summary

Fields inherited from class com.yworks.yfiles.view.input.DropInputMode

DATA_FORMAT_DROP_ID

Constructor Summary

Constructors

Constructor and Description
StripeDropInputMode() Constructs a new instance of class StripeDropInputMode.

Method Summary

Modifier and Type	Method and Description
void	addStripeCreatedListener(IEventHandler<ItemEventArgs<IStripe>> stripeCreatedEvent) Adds the given listener for the StripeCreated event that occurs when a new stripe gets created by this input mode.
void	cancel() Cleanly cancels this mode.
protected ITable	createPreviewTable() Create a preview version of the table that is temporarily used to show the dragged stripe.
protected IStripe	createStripe(IInputModeContext context, IStripe newParent) Create a new stripe as the result of a drag and drop gesture.
protected RectD	getPreviewTableLayout(PointD location, SizeD size) Calculates the layout of the new table.
protected void	onDragDropped(InputModeEventArgs eventArgs) Called once a drag has been dropped on the canvas.
protected void	onDragEntered(InputModeEventArgs eventArgs) Called once a drag has entered the canvas.
protected void	onDragExited(InputModeEventArgs eventArgs) Called once a drag has left the canvas.
protected void	onDraggedOver(InputModeEventArgs e) Called whenever a drag is over the canvas.
protected void	onStripeCreated(ItemEventArgs<IStripe> args) Called whenever a new stripe is created.
protected void	populatePreviewGraph(IGraph previewGraph) Subclasses shall fill the specified graph that is used to preview the dragged item.
void	removeStripeCreatedListener(IEventHandler<ItemEventArgs<IStripe>> stripeCreatedEvent) Removes the given listener for the StripeCreated event that occurs when a new stripe gets created by this input mode.
protected void	setDragLocation(PointD location) Sets the drag location and calls ItemDropInputMode.updatePreview(IGraph, PointD) to update the layout of item preview based on the mouse coordinates and the results of the SnapContext.
protected void	updatePreview(IGraph previewGraph, PointD newLocation) Subclasses shall update the preview graph so the dragged item is displayed at the specified dragLocation.

Methods inherited from class com.yworks.yfiles.view.input.ItemDropInputMode

addItemCreatedListener, cleanup, cleanupDropTarget, cleanupPreview, cleanupSnapContext, collectSnapResults, getDraggedItem, getDropTarget, getDropTarget, getItemCreator, getPreviewGraph, getSnapContext, getSnappedMousePosition, initializeDropTarget, initializePreview, initializeSnapContext, isDropTargetHighlightEnabled, isPreviewEnabled, isSnappingEnabled, onConcurrencyControllerDeactivated, onItemCreated, removeItemCreatedListener, setDropTarget, setDropTargetHighlightEnabled, setItemCreator, setPreviewEnabled, setSnapContext, setSnappingEnabled, updateDropTarget

Methods inherited from class com.yworks.yfiles.view.input.DropInputMode

addDragDroppedListener, addDragEnteredListener, addDragLeftListener, addDragOverListener, adjustTransferMode, createInputModeEventArgs, getController, getDropData, getDropData, getDropDataMap, getDropLocation, getExpectedType, getInputModeContext, getLastDragEvent, getMousePosition, getPriority, getTransferMode, getValidDropHitTestable, install, isCapturingMouseInputDuringDragEnabled, isEnabled, isExclusive, onCanceled, onConcurrencyControllerActivated, onStopped, removeDragDroppedListener, removeDragEnteredListener, removeDragLeftListener, removeDragOverListener, setCapturingMouseInputDuringDragEnabled, setDropDataMap, setEnabled, setExclusive, setPriority, setTransferMode, setValidDropHitTestable, stop, uninstall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StripeDropInputMode

public StripeDropInputMode()

Constructs a new instance of class StripeDropInputMode.

Method Detail

addStripeCreatedListener

public final void addStripeCreatedListener(IEventHandler<ItemEventArgs<IStripe>> stripeCreatedEvent)

Adds the given listener for the StripeCreated event that occurs when a new stripe gets created by this input mode.

Parameters:

stripeCreatedEvent - The listener to add.

See Also:

removeStripeCreatedListener(IEventHandler)

cancel

public void cancel()

Description copied from class: DropInputMode

Cleanly cancels this mode.

Specified by:

cancel in interface IInputMode

Overrides:

cancel in class DropInputMode

createPreviewTable

protected ITable createPreviewTable()

Create a preview version of the table that is temporarily used to show the dragged stripe.

createStripe

protected IStripe createStripe(IInputModeContext context,
                               IStripe newParent)

Create a new stripe as the result of a drag and drop gesture.

This method is called by the ItemCreator that is set as default on this class.

Parameters:

newParent - The parent for which to create the stripe.

context - The context for which the stripe should be created.

Returns:

a newly created stripe.

getPreviewTableLayout

protected RectD getPreviewTableLayout(PointD location,
                                      SizeD size)

Calculates the layout of the new table.

In this implementation the mouse location is used as center of the table. Can be overridden in child class to implement a different layout.

Parameters:

location - Current mouse position

size - Size of the table

Returns:

a RectD with the given size and the mouse location as center.

onDragDropped

protected void onDragDropped(InputModeEventArgs eventArgs)

Description copied from class: DropInputMode

Called once a drag has been dropped on the canvas.

Overrides:

onDragDropped in class ItemDropInputMode<IStripe>

onDragEntered

protected void onDragEntered(InputModeEventArgs eventArgs)

Description copied from class: ItemDropInputMode

Called once a drag has entered the canvas.

Calls ItemDropInputMode.initializeSnapContext(), ItemDropInputMode.initializePreview() and ItemDropInputMode.initializeDropTarget().

Overrides:

onDragEntered in class ItemDropInputMode<IStripe>

onDragExited

protected void onDragExited(InputModeEventArgs eventArgs)

Description copied from class: DropInputMode

Called once a drag has left the canvas.

Overrides:

onDragExited in class ItemDropInputMode<IStripe>

onDraggedOver

protected void onDraggedOver(InputModeEventArgs e)

Description copied from class: DropInputMode

Called whenever a drag is over the canvas.

Overrides:

onDraggedOver in class ItemDropInputMode<IStripe>

onStripeCreated

protected void onStripeCreated(ItemEventArgs<IStripe> args)

Called whenever a new stripe is created.

populatePreviewGraph

protected void populatePreviewGraph(IGraph previewGraph)

Description copied from class: ItemDropInputMode

Subclasses shall fill the specified graph that is used to preview the dragged item.

Overrides:

populatePreviewGraph in class ItemDropInputMode<IStripe>

Parameters:

previewGraph - The preview graph to fill.

removeStripeCreatedListener

public final void removeStripeCreatedListener(IEventHandler<ItemEventArgs<IStripe>> stripeCreatedEvent)

Removes the given listener for the StripeCreated event that occurs when a new stripe gets created by this input mode.

Parameters:

stripeCreatedEvent - The listener to remove.

See Also:

addStripeCreatedListener(IEventHandler)

setDragLocation

protected void setDragLocation(PointD location)

Description copied from class: ItemDropInputMode

Sets the drag location and calls ItemDropInputMode.updatePreview(IGraph, PointD) to update the layout of item preview based on the mouse coordinates and the results of the SnapContext.

Overrides:

setDragLocation in class ItemDropInputMode<IStripe>

Parameters:

location - The current location of the mouse in world coordinates.

updatePreview

protected void updatePreview(IGraph previewGraph,
                             PointD newLocation)

Description copied from class: ItemDropInputMode

Subclasses shall update the preview graph so the dragged item is displayed at the specified dragLocation.

Overrides:

updatePreview in class ItemDropInputMode<IStripe>

Parameters:

previewGraph - The preview graph to update.

newLocation - The current drag location.