com.yworks.yfiles.view.input

Class MoveLabelInputMode

java.lang.Object

com.yworks.yfiles.view.input.MoveInputMode

com.yworks.yfiles.view.input.MoveLabelInputMode

All Implemented Interfaces:

IInputMode

public class MoveLabelInputMode
extends MoveInputMode

An IInputMode that can be used to drag a ILabel in a GraphControl.

This implementation shows the possible candidate positions for a given label and allows the user to drag the label to one of these positions.

Constructor Summary

Constructors

Constructor and Description
MoveLabelInputMode() Creates a new instance that will move labels in the graph retrieved from the InputModeContext.

Method Summary

Modifier and Type	Method and Description
protected IHitTestable	createLabelHitTestable() Creates the hit testable that will be used to determine whether this mode may be activated.
protected IPositionHandler	createLabelPositionHandler(ILabel label) Creates the position handler for the given label used in isValidLabelHit(IInputModeContext, PointD).
IGraph	getGraph() Gets the IGraph this mode is acting upon.
IGraphSelection	getGraphSelection() Gets the IGraphSelection this mode is acting upon.
protected ILabel	getHitLabel(IInputModeContext context, PointD location) Looks for a label that has been hit at the specified position.
ILabel	getMovedLabel() Gets the label that is currently moved or null if there is no such label.
boolean	isUsingLabelModelParameterFinderEnabled() Gets a value indicating whether or not using the ILabelModelParameterFinder to assign new label model parameters is allowed.
protected boolean	isValidLabelHit(IInputModeContext context, PointD location) Determines whether or not a valid label has been hit at the specified position.
protected void	onDragCanceled(InputModeEventArgs inputModeEventArgs) Clears the PositionHandler property.
protected void	onDragFinished(InputModeEventArgs inputModeEventArgs) Clears the PositionHandler property.
protected void	onDragStarting(InputModeEventArgs inputModeEventArgs) Registers the PositionHandler created during the last createLabelPositionHandler(ILabel) call.
void	setUsingLabelModelParameterFinderEnabled(boolean value) Sets a value indicating whether or not using the ILabelModelParameterFinder to assign new label model parameters is allowed.
protected boolean	shouldMove(IInputModeContext context, ILabel label) Determines whether or not a label is allowed to be moved.

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

addDragCanceledListener, addDragCancelingListener, addDragFinishedListener, addDragFinishingListener, addDraggedListener, addDraggingListener, addDragStartedListener, addDragStartingListener, addQueryPositionHandlerListener, arm, cancel, createPositionHandlerInputModeContext, disarm, doStartDrag, getAffectedItems, getCancelRecognizer, getController, getDisableSnappingRecognizer, getDraggedRecognizer, getDraggedRecognizerTouch, getEnableSnappingRecognizer, getHitTestable, getHoverRecognizer, getInitialLocation, getInputModeContext, getMoveCursor, getPositionHandler, getPressedRecognizer, getPressedRecognizerTouch, getPriority, getReleasedRecognizer, getReleasedRecognizerTouch, getSnapContext, install, isDragging, isEnabled, isExclusive, isValidStartLocation, onCanceled, onConcurrencyControllerActivated, onConcurrencyControllerDeactivated, onDragCanceling, onDragFinishing, onDragged, onDragging, onDragStarted, onQueryPositionHandler, onStopped, removeDragCanceledListener, removeDragCancelingListener, removeDragFinishedListener, removeDragFinishingListener, removeDraggedListener, removeDraggingListener, removeDragStartedListener, removeDragStartingListener, removeQueryPositionHandlerListener, setCancelRecognizer, setDisableSnappingRecognizer, setDraggedRecognizer, setDraggedRecognizerTouch, setEnabled, setEnableSnappingRecognizer, setExclusive, setHitTestable, setHoverRecognizer, setMoveCursor, setPositionHandler, setPressedRecognizer, setPressedRecognizerTouch, setPriority, setReleasedRecognizer, setReleasedRecognizerTouch, setSnapContext, stop, uninstall

Methods inherited from class java.lang.Object

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

Constructor Detail

MoveLabelInputMode

public MoveLabelInputMode()

Creates a new instance that will move labels in the graph retrieved from the InputModeContext.

See Also:

getGraph()

Method Detail

createLabelHitTestable

protected IHitTestable createLabelHitTestable()

Creates the hit testable that will be used to determine whether this mode may be activated.

This implementation returns an instance that delegates to isValidLabelHit(IInputModeContext, PointD).

Returns:

A hit testable.

createLabelPositionHandler

protected IPositionHandler createLabelPositionHandler(ILabel label)

Creates the position handler for the given label used in isValidLabelHit(IInputModeContext, PointD).

First, this implementation checks for a position handler in the label's lookup. If this fails, it creates a new label position handler for the given label.

Parameters:

label - The label to create a position handler for.

Returns:

A position handler for the given label.

getGraph

public final IGraph getGraph()

Gets the IGraph this mode is acting upon.

Returns:

The Graph.

getGraphSelection

public final IGraphSelection getGraphSelection()

Gets the IGraphSelection this mode is acting upon.

Returns:

The GraphSelection.

getHitLabel

protected ILabel getHitLabel(IInputModeContext context,
                             PointD location)

Looks for a label that has been hit at the specified position.

This implementation checks the GraphSelection to see if there is exactly one selected label. This label is returned if it is hit by the mouse and shouldMove(IInputModeContext, ILabel) returns true. Otherwise, null is returned.

Parameters:

context - The context for the hit test.

location - The coordinates for the hit test.

Returns:

The label hit at the given location or null.

See Also:

isValidLabelHit(IInputModeContext, PointD), shouldMove(IInputModeContext, ILabel)

getMovedLabel

public final ILabel getMovedLabel()

Gets the label that is currently moved or null if there is no such label.

The value of this property is not null only if this mode is currently active and performs a move operation, that is between the DragStarting and the DragFinished event handlers.

Returns:

The MovedLabel.

isUsingLabelModelParameterFinderEnabled

public final boolean isUsingLabelModelParameterFinderEnabled()

Gets a value indicating whether or not using the ILabelModelParameterFinder to assign new label model parameters is allowed.

The default is true

This property has no effect if an IPositionHandler is available in the label's lookup.

Returns:

The UsingLabelModelParameterFinderEnabled.

See Also:

createLabelPositionHandler(ILabel), setUsingLabelModelParameterFinderEnabled(boolean)

isValidLabelHit

protected boolean isValidLabelHit(IInputModeContext context,
                                  PointD location)

Determines whether or not a valid label has been hit at the specified position.

This implementation calls getHitLabel(IInputModeContext, PointD) to find the label at the specified location. If a label is hit, the IPositionHandler is created by createLabelPositionHandler(ILabel).

Parameters:

context - The context for the hit test.

location - The coordinates for the hit test.

Returns:

true if a valid label is hit and the label moving should be started here. Otherwise, false.

onDragCanceled

protected void onDragCanceled(InputModeEventArgs inputModeEventArgs)

Clears the PositionHandler property.

Overrides:

onDragCanceled in class MoveInputMode

Parameters:

inputModeEventArgs - The event argument that contains context information.

onDragFinished

protected void onDragFinished(InputModeEventArgs inputModeEventArgs)

Clears the PositionHandler property.

Overrides:

onDragFinished in class MoveInputMode

Parameters:

inputModeEventArgs - The event argument that contains context information.

onDragStarting

protected void onDragStarting(InputModeEventArgs inputModeEventArgs)

Registers the PositionHandler created during the last createLabelPositionHandler(ILabel) call.

Overrides:

onDragStarting in class MoveInputMode

Parameters:

inputModeEventArgs - The event argument that contains context information.

setUsingLabelModelParameterFinderEnabled

public final void setUsingLabelModelParameterFinderEnabled(boolean value)

Sets a value indicating whether or not using the ILabelModelParameterFinder to assign new label model parameters is allowed.

The default is true

This property has no effect if an IPositionHandler is available in the label's lookup.

Parameters:

value - The UsingLabelModelParameterFinderEnabled to set.

See Also:

createLabelPositionHandler(ILabel), isUsingLabelModelParameterFinderEnabled()

shouldMove

protected boolean shouldMove(IInputModeContext context,
                             ILabel label)

Determines whether or not a label is allowed to be moved.

This implementation returns false if the parent input mode forbids moving the label. Overriding implementations should query this implementation as base if this feature is desired.

Parameters:

context - The context.

label - The label to be checked.

Returns:

true if the label is allowed to move.

See Also:

getHitLabel(IInputModeContext, PointD)