com.yworks.yfiles.view.input

Class SnapResult

java.lang.Object

com.yworks.yfiles.view.input.SnapResult

All Implemented Interfaces:

Comparable<SnapResult>

public abstract class SnapResult
extends Object
implements Comparable<SnapResult>

This is the abstract base class used by the implementers of SnapContext to model the result of the mouse being snapped to a certain location.

It carries a Weight and can be used to obtain a IVisualCreator that will be included in the view if the result is actually snapped after all other results with higher weight have been snapped.

Constructor Summary

Constructors

Constructor and Description
SnapResult()

Method Summary

Modifier and Type	Method and Description
int	compareTo(SnapResult other) Implements the Comparable interface using Weight.
static SnapResult	createLabelSnapResult(ILabelModelParameter layoutParameter, double weight, PointD delta, Object tag, SnapLine snapLine, PointD snappedCoordinates, Object movedObject) Factory method that creates a SnapResult to which a ILabel will snap, based on the given snapLine.
static SnapResult	createPointSnapResult(PointD location, double weight, Object tag, IVisualCreator visualCreator, SnapTypes snapType) Factory method that creates a SnapResult that snaps to a given location.
static SnapResult	createResizeSnapResult(double weight, double delta, Object tag, Iterable<IRectangle> rectangles, double size, boolean horizontal) Factory method that creates a SnapResult which snaps to a given size through a resize operation.
static SnapResult	createSnapLineSnapResult(double weight, PointD delta, Object tag, SnapLine snapLine, PointD snappedLocation, Object movedObject) Factory method that creates a SnapResult which represents a SnapLine to which the current moved item will potentially snap.
static SnapResult	getNullResult() Gets a SnapResult representing that there is no snapping of the x or y coordinate.
Object	getTag() Gets the tag associated with this result.
abstract IVisualCreator	getVisualCreator() Returns a IVisualCreator instance that can be used to create a Node for this result.
double	getWeight() Gets the weight of this result.
boolean	isSnapped(PointD unsnappedLocation, SnapState finalSnapState) Checks whether this instance is still snapped given the final mouse location.
protected void	setTag(Object value) Sets the tag associated with this result.
protected void	setWeight(double value) Sets the weight of this result.
void	snap(PointD unsnappedLocation, SnapState currentSnapState) Core method that performs the actual snapping.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapResult

public SnapResult()

Method Detail

compareTo

public final int compareTo(SnapResult other)

Implements the Comparable interface using Weight.

Specified by:

compareTo in interface Comparable<SnapResult>

Parameters:

other - The second SnapResult

Returns:

The comparison value of the two SnapResults' Weights

createLabelSnapResult

public static SnapResult createLabelSnapResult(ILabelModelParameter layoutParameter,
                                               double weight,
                                               PointD delta,
                                               Object tag,
                                               SnapLine snapLine,
                                               PointD snappedCoordinates,
                                               Object movedObject)

Factory method that creates a SnapResult to which a ILabel will snap, based on the given snapLine.

Parameters:

layoutParameter - The ILabelModelParameter which represents the position to snap to.

weight - The weight of this result. The higher the weight, the more important it is.

delta - The value to add to the mouse coordinates to snap to this result.

tag - The tag associated with this result. If more than one result uses the same tag (not null), only the one with the highest Weight will be rendered.

snapLine - The snap line this class would snap to or null if it doesn't snap to a SnapLine.

snappedCoordinates - The coordinates at the moved item at which the drawn snap line should end.

movedObject - The moved object for which this result is created.

createPointSnapResult

public static SnapResult createPointSnapResult(PointD location,
                                               double weight,
                                               Object tag,
                                               IVisualCreator visualCreator,
                                               SnapTypes snapType)

Factory method that creates a SnapResult that snaps to a given location.

Parameters:

location - The location to snap to.

weight - The weight to assign to the result.

tag - The tag associated with this result. If more than one result uses the same tag (not null), only the one with the highest Weight will be rendered.

visualCreator - The visual creator to use.

snapType - The type of the snapping operation to apply.

Returns:

A result that snaps to the provided location using the provided mode.

createResizeSnapResult

public static SnapResult createResizeSnapResult(double weight,
                                                double delta,
                                                Object tag,
                                                Iterable<IRectangle> rectangles,
                                                double size,
                                                boolean horizontal)

Factory method that creates a SnapResult which snaps to a given size through a resize operation.

Parameters:

weight - The weight of this result. The higher the weight, the more important it is.

delta - The value to add to the mouse coordinates to snap to this result.

tag - The tag associated with this result. If more than one result uses the same tag (not null), only the one with the highest Weight will be rendered.

rectangles - The rectangles that have the same width or height as the node will. The rectangle are used for visualization and should include all objects for which a visualization should be displayed. Typically, these are all objects which have the same size and the object which is currently reshaped.

size - The target size to which the resized object will snap.

horizontal - Indicates whether width or height should snap. true if the width should snap.

createSnapLineSnapResult

public static SnapResult createSnapLineSnapResult(double weight,
                                                  PointD delta,
                                                  Object tag,
                                                  SnapLine snapLine,
                                                  PointD snappedLocation,
                                                  Object movedObject)

Factory method that creates a SnapResult which represents a SnapLine to which the current moved item will potentially snap.

Parameters:

weight - The weight of this result. The higher the weight, the more important it is.

delta - The value to add to the mouse coordinates to snap to this result.

tag - The tag associated with this result. If more than one result uses the same tag (not null), only the one with the highest Weight will be rendered.

snapLine - The snap line this class would snap to or null if it doesn't snap to a SnapLine.

snappedLocation - The coordinates at the moved item at which the drawn snap line should end.

movedObject - The moved object for which this result is created.

getNullResult

public static final SnapResult getNullResult()

Gets a SnapResult representing that there is no snapping of the x or y coordinate.

Returns:

The NullResult.

getTag

public final Object getTag()

Gets the tag associated with this result.

If more than one result uses the same tag (not null), only the one with the highest Weight will be rendered.

Returns:

The Tag.

See Also:

setTag(Object)

getVisualCreator

public abstract IVisualCreator getVisualCreator()

Returns a IVisualCreator instance that can be used to create a Node for this result.

Returns:

A visual creator which creates a Visual which depicts this snap result.

See Also:

VoidVisualCreator.INSTANCE

getWeight

public final double getWeight()

Gets the weight of this result.

Higher weights represent more important results.

Returns:

The Weight.

See Also:

setWeight(double)

isSnapped

public boolean isSnapped(PointD unsnappedLocation,
                         SnapState finalSnapState)

Checks whether this instance is still snapped given the final mouse location.

This implementation simply returns false.

Parameters:

unsnappedLocation - The unsnapped location.

finalSnapState - The final snap state that has been used by the client.

Returns:

Whether the location are still snapped for this instance.

setTag

protected final void setTag(Object value)

Sets the tag associated with this result.

If more than one result uses the same tag (not null), only the one with the highest Weight will be rendered.

Parameters:

value - The Tag to set.

See Also:

getTag()

setWeight

protected final void setWeight(double value)

Sets the weight of this result.

Higher weights represent more important results.

Parameters:

value - The Weight to set.

See Also:

getWeight()

snap

public void snap(PointD unsnappedLocation,
                 SnapState currentSnapState)

Core method that performs the actual snapping.

This implementation does nothing.

Parameters:

unsnappedLocation - The location prior to the snapping.

currentSnapState - The currently snapped location and the state of the snapping. This instance can be modified by subclasses.