Package org.eclipse.gef.mvc.fx.providers

Interface ISnappingLocationProvider

All Known Implementing Classes:

BoundsSnappingLocationProvider, CenterSnappingLocationProvider, ConnectionSnappingLocationProvider, TopLeftSnappingLocationProvider

public interface ISnappingLocationProvider

The ISnappingLocationProvider is used to determine SnappingModel.SnappingLocations for an IContentPart.

Method Summary

Modifier and Type	Method	Description
List<SnappingModel.SnappingLocation>	getHorizontalSnappingLocations(IContentPart<? extends javafx.scene.Node> part)	Returns the horizontal SnappingModel.SnappingLocations for the given IContentPart.
List<SnappingModel.SnappingLocation>	getVerticalSnappingLocations(IContentPart<? extends javafx.scene.Node> part)	Returns the vertical SnappingModel.SnappingLocations for the given IContentPart.
static ISnappingLocationProvider	union(List<ISnappingLocationProvider> providers)	Combines the given ISnappingLocationProviders by wrapping them in a new ISnappingLocationProvider that returns a combination of all SnappingModel.SnappingLocations that are returned by the individual providers.

Method Details

union

static ISnappingLocationProvider union(List<ISnappingLocationProvider> providers)

Combines the given ISnappingLocationProviders by wrapping them in a new ISnappingLocationProvider that returns a combination of all SnappingModel.SnappingLocations that are returned by the individual providers.

Parameters:

providers - The ISnappingLocationProviders to combine.

Returns:

A new ISnappingLocationProvider that represents the combination of the given providers.

getHorizontalSnappingLocations

List<SnappingModel.SnappingLocation> getHorizontalSnappingLocations(IContentPart<? extends javafx.scene.Node> part)

Returns the horizontal SnappingModel.SnappingLocations for the given IContentPart.

Parameters:

part - The IContentPart for which to compute the SnappingModel.SnappingLocations.

Returns:

A List of all horizontal SnappingModel.SnappingLocations for the given IContentPart.

getVerticalSnappingLocations

List<SnappingModel.SnappingLocation> getVerticalSnappingLocations(IContentPart<? extends javafx.scene.Node> part)

Returns the vertical SnappingModel.SnappingLocations for the given IContentPart.

Parameters:

part - The IContentPart for which to compute the SnappingModel.SnappingLocations.

Returns:

A List of all vertical SnappingModel.SnappingLocations for the given IContentPart.