com.yworks.yfiles.view.input

Class ReparentStripePositionHandler

java.lang.Object

com.yworks.yfiles.view.input.ReparentStripePositionHandler

All Implemented Interfaces:

IDragHandler, IPositionHandler

public class ReparentStripePositionHandler
extends Object
implements IPositionHandler

Customized IPositionHandler implementation that moves a stripe in the table hierarchy when the stripe is dragged.

This class is used by default by both ReparentStripeInputMode and StripeDropInputMode to perform the actual reparenting and insertion.

Constructor Summary

Constructors

Constructor and Description
ReparentStripePositionHandler(IStripe movedStripe) Creates a new instance of this position handler which moves .

Method Summary

Modifier and Type	Method and Description
void	addStripeChangedListener(IEventHandler<StripeEventArgs> stripeChangedEvent) Adds the given listener for the StripeChanged event that occurs when a stripe state is changed by this input mode.
void	cancelDrag(IInputModeContext context, PointD originalLocation) Called by clients to indicate that the dragging has been canceled by the user.
protected ICanvasObject	createSourceGhostVisualization(IInputModeContext context) Create a visualization for the source region of the reparent gesture.
protected ICanvasObject	createTargetGhostVisualization(IInputModeContext context, IStripe stripe) Create a visualization for the target region of the reparent gesture.
protected StripeReparentPolicy	determineGesture(IInputModeContext context, IPoint location, IStripe sourceStripe, StripeSubregion targetSubregion, RectD targetBounds) Determine the reparent gesture that would result from the given parameters.
void	dragFinished(IInputModeContext context, PointD originalLocation, PointD newLocation) Called by clients to indicate that the repositioning has just been finished.
protected IInputModeContext	getInputModeContext() The current IInputModeContext.
IPoint	getLocation() Returns a view of the location of the item.
IStripe	getMovedStripe() Allows to query the moved stripe.
protected StripeSubregion	getTargetSubregion(PointD location) Finds the target stripe subregion at location and its associated owner node.
void	handleMove(IInputModeContext context, PointD originalLocation, PointD newLocation) Called by clients to indicate that the element has been dragged and its position should be updated.
void	initializeDrag(IInputModeContext context) Called by clients to indicate that the element is going to be dragged.
protected void	onStripeChanged(StripeEventArgs args) Called whenever a change in the oldTable hierarchy occurs through this position handler.
void	removeStripeChangedListener(IEventHandler<StripeEventArgs> stripeChangedEvent) Removes the given listener for the StripeChanged event that occurs when a stripe state is changed by this input mode.
void	setPosition(PointD location)
protected ICanvasObject	updateSourceVisualization(IInputModeContext context, ICanvasObject targetVisualization, IStripe targetStripe, StripeReparentPolicy reparentPosition) Modifies the source visualization itself.
protected ICanvasObject	updateTargetVisualization(IInputModeContext context, ICanvasObject targetVisualization, IStripe targetStripe, StripeReparentPolicy reparentPosition, RectD targetBounds) Modifies the target visualization itself.
protected RectD	updateTargetVisualizationBounds(RectD originalTargetBounds, StripeReparentPolicy reparentPosition, IStripe targetStripe) Updates the visualization bounds for the target visualization depending on the provided values.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReparentStripePositionHandler

public ReparentStripePositionHandler(IStripe movedStripe)

Creates a new instance of this position handler which moves .movedStripe

Method Detail

addStripeChangedListener

public final void addStripeChangedListener(IEventHandler<StripeEventArgs> stripeChangedEvent)

Adds the given listener for the StripeChanged event that occurs when a stripe state is changed by this input mode.

Parameters:

stripeChangedEvent - The listener to add.

See Also:

removeStripeChangedListener(IEventHandler)

cancelDrag

public final void cancelDrag(IInputModeContext context,
                             PointD originalLocation)

Description copied from interface: IDragHandler

Called by clients to indicate that the dragging has been canceled by the user.

This method may be called after the initial IDragHandler.initializeDrag(IInputModeContext) and zero or more invocations of IDragHandler.handleMove(IInputModeContext, PointD, PointD). Implementations should reset the position of the items they modify to their initial state. Alternatively to this method the IDragHandler.dragFinished(IInputModeContext, PointD, PointD) method might be called.

Specified by:

cancelDrag in interface IDragHandler

Parameters:

context - The context to retrieve information about the drag from.

originalLocation - The value of the coordinate of the Location property at the time of IDragHandler.initializeDrag(IInputModeContext).

createSourceGhostVisualization

protected ICanvasObject createSourceGhostVisualization(IInputModeContext context)

Create a visualization for the source region of the reparent gesture.

The default implementation uses the return value of IStripeInputVisualizationHelper.getVisualCreator(IInputModeContext, INode, StripeVisualizationType) with type StripeVisualizationType.DRAG_SOURCE.

Parameters:

context - The current input mode context

Returns:

A canvas object that is used to visualize the target region.

See Also:

updateSourceVisualization(IInputModeContext, ICanvasObject, IStripe, StripeReparentPolicy)

createTargetGhostVisualization

protected ICanvasObject createTargetGhostVisualization(IInputModeContext context,
                                                       IStripe stripe)

Create a visualization for the target region of the reparent gesture.

The default implementation uses the return value of IStripeInputVisualizationHelper.getVisualCreator(IInputModeContext, INode, StripeVisualizationType) with type StripeVisualizationType.DROP_TARGET.

Parameters:

context - The current input mode context

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

Returns:

A canvas object that is used to visualize the target region.

See Also:

updateTargetVisualization(IInputModeContext, ICanvasObject, IStripe, StripeReparentPolicy, RectD)

determineGesture

protected StripeReparentPolicy determineGesture(IInputModeContext context,
                                                IPoint location,
                                                IStripe sourceStripe,
                                                StripeSubregion targetSubregion,
                                                RectD targetBounds)

Determine the reparent gesture that would result from the given parameters.

The target region has already been determined by getTargetSubregion(PointD)

Parameters:

context - The current input mode context

location - The current drag location

sourceStripe - The stripe that is moved

targetSubregion - The stripe subregion for the target.

targetBounds - The target bounds

Returns:

A StripeReparentPolicy that specifies the operation to perform.

dragFinished

public final void dragFinished(IInputModeContext context,
                               PointD originalLocation,
                               PointD newLocation)

Description copied from interface: IDragHandler

Called by clients to indicate that the repositioning has just been finished.

This method may be called after the initial IDragHandler.initializeDrag(IInputModeContext) and zero or more invocations of IDragHandler.handleMove(IInputModeContext, PointD, PointD). Alternatively to this method the IDragHandler.cancelDrag(IInputModeContext, PointD) method might be called.

Specified by:

dragFinished in interface IDragHandler

Parameters:

context - The context to retrieve information about the drag from.

originalLocation - The value of the Location property at the time of IDragHandler.initializeDrag(IInputModeContext).

newLocation - The coordinates in the world coordinate system that the client wants the handle to be at. Depending on the implementation the Location may or may not be modified to reflect the new value. This is the same value as delivered in the last invocation of IDragHandler.handleMove(IInputModeContext, PointD, PointD)

getInputModeContext

protected final IInputModeContext getInputModeContext()

The current IInputModeContext.

Returns:

The InputModeContext.

getLocation

public final IPoint getLocation()

Description copied from interface: IDragHandler

Returns a view of the location of the item.

The point describes the current world coordinate of the element that can be modified by this handler.

Specified by:

getLocation in interface IDragHandler

Returns:

The Location.

getMovedStripe

public final IStripe getMovedStripe()

Allows to query the moved stripe.

Returns:

The MovedStripe.

getTargetSubregion

protected StripeSubregion getTargetSubregion(PointD location)

Finds the target stripe subregion at location and its associated owner node.

Parameters:

location - The hit location.

Returns:

A StripeSubregion that lies at location, or null if no such region could be found.

handleMove

public final void handleMove(IInputModeContext context,
                             PointD originalLocation,
                             PointD newLocation)

Description copied from interface: IDragHandler

Called by clients to indicate that the element has been dragged and its position should be updated.

This method may be called more than once after an initial IDragHandler.initializeDrag(IInputModeContext) and will the final call will be followed by either one IDragHandler.dragFinished(IInputModeContext, PointD, PointD) or one IDragHandler.cancelDrag(IInputModeContext, PointD) call.

Specified by:

handleMove in interface IDragHandler

Parameters:

context - The context to retrieve information about the drag from.

originalLocation - The value of the Location property at the time of IDragHandler.initializeDrag(IInputModeContext).

newLocation - The coordinates in the world coordinate system that the client wants the handle to be at. Depending on the implementation the Location may or may not be modified to reflect the new value.

initializeDrag

public final void initializeDrag(IInputModeContext context)

Description copied from interface: IDragHandler

Called by clients to indicate that the element is going to be dragged.

This call will be followed by one or more calls to IDragHandler.handleMove(IInputModeContext, PointD, PointD), and a final IDragHandler.dragFinished(IInputModeContext, PointD, PointD) or IDragHandler.cancelDrag(IInputModeContext, PointD).

Specified by:

initializeDrag in interface IDragHandler

Parameters:

context - The context to retrieve information about the drag from.

onStripeChanged

protected void onStripeChanged(StripeEventArgs args)

Called whenever a change in the oldTable hierarchy occurs through this position handler.

removeStripeChangedListener

public final void removeStripeChangedListener(IEventHandler<StripeEventArgs> stripeChangedEvent)

Removes the given listener for the StripeChanged event that occurs when a stripe state is changed by this input mode.

Parameters:

stripeChangedEvent - The listener to remove.

See Also:

addStripeChangedListener(IEventHandler)

setPosition

public final void setPosition(PointD location)

updateSourceVisualization

protected ICanvasObject updateSourceVisualization(IInputModeContext context,
                                                  ICanvasObject targetVisualization,
                                                  IStripe targetStripe,
                                                  StripeReparentPolicy reparentPosition)

Modifies the source visualization itself.

The default does not change targetVisualization.

Parameters:

context - The current input mode context.

targetVisualization - The canvas object for the target visualization

targetStripe - The target for the reparent gesture

reparentPosition - Where to place the stripe after reparenting.

updateTargetVisualization

protected ICanvasObject updateTargetVisualization(IInputModeContext context,
                                                  ICanvasObject targetVisualization,
                                                  IStripe targetStripe,
                                                  StripeReparentPolicy reparentPosition,
                                                  RectD targetBounds)

Modifies the target visualization itself.

The default implementation only hides targetVisualization iff reparentPosition is StripeReparentPolicy.INVALID.

Parameters:

context - The current input mode context.

targetVisualization - The canvas object for the target visualization.

targetStripe - The target for the reparent gesture.

reparentPosition - The mode the describes the results of the reparent gesture.

targetBounds - The current visualization bounds that have been computed with updateTargetVisualizationBounds(RectD, StripeReparentPolicy, IStripe)

updateTargetVisualizationBounds

protected RectD updateTargetVisualizationBounds(RectD originalTargetBounds,
                                                StripeReparentPolicy reparentPosition,
                                                IStripe targetStripe)

Updates the visualization bounds for the target visualization depending on the provided values.

Parameters:

originalTargetBounds - The target bounds prior to this method call.

reparentPosition - Where to place the stripe after the reparenting operations according to the reparent gesture.

targetStripe - The target stripe which has been determined by the input mode.

Returns:

Updated bounds for the target visualization.