Package org.eclipse.gef.editparts
Class GridLayer
java.lang.Object
org.eclipse.draw2d.Figure
org.eclipse.draw2d.Layer
org.eclipse.draw2d.FreeformLayer
org.eclipse.gef.editparts.GridLayer
- All Implemented Interfaces:
- FreeformFigure,- IFigure
This is a layer that displays the grid. The default grid color is
 
light gray. To change the
 grid color, set the foreground color for this layer.- Since:
- 3.0
- 
Nested Class SummaryNested classes/interfaces inherited from class org.eclipse.draw2d.FigureFigure.FigureIterator, Figure.IdentitySearch, Figure.ReverseFigureChildrenIteratorNested classes/interfaces inherited from interface org.eclipse.draw2d.IFigureIFigure.NoInsets
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected intField indicating the horizontal grid spacingprotected intField for the vertical grid spacingprotected PointField indicating what the grid origin is.Fields inherited from class org.eclipse.draw2d.FigurebgColor, border, bounds, fgColor, flags, font, MAX_FLAG, maxSize, minSize, NO_MANAGER, prefSize, toolTipFields inherited from interface org.eclipse.draw2d.IFigureMAX_DIMENSION, MIN_DIMENSION, NO_INSETS
- 
Constructor SummaryConstructorsConstructorDescriptionConstructor Sets the default grid color: ColorConstants.lightGray
- 
Method SummaryModifier and TypeMethodDescriptiongetPreferredSize(int wHint, int hHint) Overridden to indicate no preferred size.protected voidpaintFigure(Graphics graphics) protected voidPaints the grid.voidSets the origin of the grid.voidsetSpacing(Dimension spacing) Sets the horizontal and vertical spacing of the grid.Methods inherited from class org.eclipse.draw2d.FreeformLayeradd, addFreeformListener, fireExtentChanged, fireMoved, getFreeformExtent, primTranslate, remove, removeFreeformListener, setFreeformBoundsMethods inherited from class org.eclipse.draw2d.LayercontainsPoint, findFigureAtMethods inherited from class org.eclipse.draw2d.Figureadd, add, add, addAncestorListener, addCoordinateListener, addFigureListener, addFocusListener, addKeyListener, addLayoutListener, addListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, erase, findDescendantAtExcluding, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, findMouseEventTargetInDescendantsAt, fireCoordinateSystemChanged, fireFigureMoved, firePropertyChange, firePropertyChange, firePropertyChange, getBackgroundColor, getBorder, getBounds, getChildren, getChildrenRevIterable, getClientArea, getClientArea, getClippingStrategy, getCursor, getFlag, getFont, getForegroundColor, getInsets, getLayoutManager, getListeners, getListenersIterable, getLocalBackgroundColor, getLocalFont, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, handleMouseWheelScrolled, hasFocus, internalGetEventDispatcher, intersects, invalidate, invalidateTree, isCoordinateSystem, isEnabled, isFocusTraversable, isMirrored, isMouseEventTarget, isOpaque, isRequestFocusEnabled, isShowing, isValid, isValidationRoot, isVisible, layout, optimizeClip, paint, paintBorder, paintChildren, paintClientArea, removeAll, removeAncestorListener, removeCoordinateListener, removeFigureListener, removeFocusListener, removeKeyListener, removeLayoutListener, removeListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setChildrenDirection, setChildrenEnabled, setChildrenOrientation, setClippingStrategy, setConstraint, setCursor, setEnabled, setFlag, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setValid, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, useLocalCoordinates, validateMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.draw2d.IFigureadd, add, add, addAncestorListener, addCoordinateListener, addFigureListener, addFocusListener, addKeyListener, addLayoutListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, getBackgroundColor, getBorder, getBounds, getChildren, getClientArea, getClientArea, getClippingStrategy, getCursor, getFont, getForegroundColor, getInsets, getLayoutManager, getLocalBackgroundColor, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, handleMouseWheelScrolled, hasFocus, internalGetEventDispatcher, intersects, invalidate, invalidateTree, isCoordinateSystem, isEnabled, isFocusTraversable, isMirrored, isOpaque, isRequestFocusEnabled, isShowing, isVisible, paint, removeAncestorListener, removeCoordinateListener, removeFigureListener, removeFocusListener, removeKeyListener, removeLayoutListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setClippingStrategy, setConstraint, setCursor, setEnabled, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, validate
- 
Field Details- 
gridXprotected int gridXField indicating the horizontal grid spacing
- 
gridYprotected int gridYField for the vertical grid spacing
- 
originField indicating what the grid origin is. This is used simply to determine the offset from 0,0.
 
- 
- 
Constructor Details- 
GridLayerpublic GridLayer()Constructor Sets the default grid color: ColorConstants.lightGray
 
- 
- 
Method Details- 
getPreferredSizeOverridden to indicate no preferred size. The grid layer should not affect the size of the layered pane in which it is placed.- Specified by:
- getPreferredSizein interface- IFigure
- Overrides:
- getPreferredSizein class- Figure
- See Also:
 
- 
paintFigure- Overrides:
- paintFigurein class- Figure
- See Also:
 
- 
paintGridPaints the grid. Sub-classes can override to customize the grid's look. If this layer is being used with SnapToGrid, this method will only be invoked when thevisibilityproperty is set to true.- Parameters:
- g- The Graphics object to be used to do the painting
- See Also:
 
- 
setOriginSets the origin of the grid. The origin is used only to determine the offset from 0,0.- Parameters:
- p- the origin
 
- 
setSpacingSets the horizontal and vertical spacing of the grid. A grid spacing of 0 will be replaced with thedefaultspacing. A negative spacing will cause no grid lines to be drawn for that dimension.- Parameters:
- spacing- A Dimension representing the horizontal (width) and vertical (height) gaps
 
 
-