Package org.eclipse.gef
Class SnapToGrid
java.lang.Object
org.eclipse.gef.SnapToHelper
org.eclipse.gef.SnapToGrid
- All Implemented Interfaces:
PositionConstants
A helper used to perform snapping to a grid, which is specified on the
graphical viewer via the various properties defined in this class. This
helper can be used in conjunction with the
DragEditPartsTracker when
dragging editparts within a graphical viewer. When snapping a rectangle, the
edges of the rectangle will snap along gridlines.
This helper does not keep up with changes made to the graphical viewer's properties. Clients should instantiate a new helper each time one is requested and not hold on to instances of the helper, if the grid properties specified on the viewer are subject to change.
- Since:
- 3.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected GraphicalEditPartThe graphical part whose content's figure defines the grid.static final intDeprecated.use DEFAULT_GRID_SIZEstatic final intThe default grid size if the viewer does not specify a size.protected intThe horizontal interval for the gridprotected intThe vertical interval for the gridprotected PointThe origin of the grid.static final StringA viewer property indicating whether the snap function is enabled.static final StringA viewer property indicating the grid's origin.static final StringA viewer property indicating the grid spacing.static final StringA viewer property indicating whether the grid should be displayed.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
ConstructorsConstructorDescriptionSnapToGrid(GraphicalEditPart container) Constructs a gridded snap helper on the given editpart. -
Method Summary
Modifier and TypeMethodDescriptionintsnapRectangle(Request request, int snapLocations, PrecisionRectangle rect, 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
-
Field Details
-
PROPERTY_GRID_ENABLED
A viewer property indicating whether the snap function is enabled. The value must be a Boolean.- See Also:
-
PROPERTY_GRID_VISIBLE
A viewer property indicating whether the grid should be displayed. The value must be a Boolean.- See Also:
-
PROPERTY_GRID_SPACING
A viewer property indicating the grid spacing. The value must be aDimension.- See Also:
-
PROPERTY_GRID_ORIGIN
A viewer property indicating the grid's origin. The value must be aPoint.- See Also:
-
DEFAULT_GRID_SIZE
public static final int DEFAULT_GRID_SIZEThe default grid size if the viewer does not specify a size.- See Also:
-
DEFAULT_GAP
public static final int DEFAULT_GAPDeprecated.use DEFAULT_GRID_SIZE- See Also:
-
container
The graphical part whose content's figure defines the grid. -
gridX
protected int gridXThe horizontal interval for the grid -
gridY
protected int gridYThe vertical interval for the grid -
origin
The origin of the grid.
-
-
Constructor Details
-
SnapToGrid
Constructs a gridded snap helper on the given editpart. The editpart should be the graphical editpart whose contentspane figure is used as the reference for the grid.- Parameters:
container- the editpart which the grid is on
-
-
Method Details
-
snapRectangle
public int snapRectangle(Request request, int snapLocations, PrecisionRectangle rect, PrecisionRectangle result) Description copied from class:SnapToHelperApplies 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 datamay 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:
snapRectanglein classSnapToHelper- Parameters:
request- the request ornullsnapLocations- the input snap locationsrect- the input rectangleresult- the correction is applied to this rectangle- Returns:
- the remaining snap locations
- See Also:
-