Package org.eclipse.gef
Class CompoundSnapToHelper
java.lang.Object
org.eclipse.gef.SnapToHelper
org.eclipse.gef.CompoundSnapToHelper
- All Implemented Interfaces:
org.eclipse.draw2d.PositionConstants
Combines multiple SnapToHelpers into one compound helper. The compound helper
deletages to multiple other helpers.
-
Field Summary
Fields inherited from interface org.eclipse.draw2d.PositionConstants
ALWAYS_LEFT, ALWAYS_RIGHT, BOTTOM, CENTER, EAST, EAST_WEST, HORIZONTAL, LEFT, LEFT_CENTER_RIGHT, MIDDLE, NONE, NORTH, NORTH_EAST, NORTH_SOUTH, NORTH_WEST, NSEW, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TOP_MIDDLE_BOTTOM, VERTICAL, WEST
-
Constructor Summary
ConstructorsConstructorDescriptionCompoundSnapToHelper
(SnapToHelper[] delegates) Constructs a compound snap to helper which will delegate to the provided array of helpers. -
Method Summary
Modifier and TypeMethodDescriptionprotected SnapToHelper[]
Gets the array of helpers.int
snapRectangle
(Request request, int snapOrientation, org.eclipse.draw2d.geometry.PrecisionRectangle baseRect, org.eclipse.draw2d.geometry.PrecisionRectangle result) Applies a snap correction to a Rectangle based on a given Rectangle.Methods inherited from class org.eclipse.gef.SnapToHelper
makeAbsolute, makeRelative, snapPoint, snapPoint, snapRectangle
-
Constructor Details
-
CompoundSnapToHelper
Constructs a compound snap to helper which will delegate to the provided array of helpers. The first helper in the array has highest priority and will be given the first opportunity to perform snapping.- Parameters:
delegates
- an array of helpers- Since:
- 3.0
-
-
Method Details
-
getDelegates
Gets the array of helpers.- Returns:
- the array of helpers.
- Since:
- 3.4
-
snapRectangle
public int snapRectangle(Request request, int snapOrientation, org.eclipse.draw2d.geometry.PrecisionRectangle baseRect, org.eclipse.draw2d.geometry.PrecisionRectangle result) Description copied from class:SnapToHelper
Applies a snap correction to a Rectangle based on a given Rectangle. The provided baseRect will be used as a reference for snapping. The types of snapping to be performed are indicated by the snapOrientation parameter. The correction is applied to the result field.The baseRect is not modified. The correction is applied to the result. The request's
extended data
may contain additional information about the snapping which was performed.All coordinate information received and returned by this method should be in absolute coordinates.
- Specified by:
snapRectangle
in classSnapToHelper
- Parameters:
request
- the request ornull
snapOrientation
- the input snap locationsbaseRect
- the input rectangleresult
- the correction is applied to this rectangle- Returns:
- the remaining snap locations
- See Also:
-