org.eclipse.gef4.mvc.models

Class GridModel

java.lang.Object

org.eclipse.gef4.mvc.models.GridModel

All Implemented Interfaces:

IPropertyChangeNotifier

public class GridModel
extends java.lang.Object
implements IPropertyChangeNotifier

The GridModel stores information about a background grid, i.e. cell width and cell height. It also stores flags indicating if the grid should be visible, if the grid should zoom with the contents, and if contents should snap to the grid.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GRID_CELL_HEIGHT_PROPERTY Name of the "grid cell height" property.
static java.lang.String	GRID_CELL_WIDTH_PROPERTY Name of the "grid cell width" property.
static java.lang.String	SHOW_GRID_PROPERTY Name of the "show grid" property.
static java.lang.String	SNAP_TO_GRID_PROPERTY Name of the "snap to grid" property.
static java.lang.String	ZOOM_GRID_PROPERTY Name of the "zoom grid" property.

Constructor Summary

Constructors

Constructor and Description
GridModel()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
double	getGridCellHeight() Returns the grid cell height.
double	getGridCellWidth() Returns the grid cell width.
boolean	isShowGrid() Returns true if the grid is visible, otherwise false.
boolean	isSnapToGrid() Returns true if snap to grid is enabled, otherwise false.
boolean	isZoomGrid() Returns true if the grid is zooming with the contents, otherwise false.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	setGridCellHeight(double gridCellHeight) Sets the grid cell height to the given value.
void	setGridCellWidth(double gridCellWidth) Sets the grid cell width to the given value.
void	setShowGrid(boolean showGrid) Shows/Hides the grid depending on the given value.
void	setSnapToGrid(boolean snapToGrid) Enables/Disables snap to grid depending on the given value.
void	setZoomGrid(boolean zoomGrid) Enables/Disables grid zooming depending on the given value.

Methods inherited from class java.lang.Object

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

Field Detail

GRID_CELL_WIDTH_PROPERTY

public static final java.lang.String GRID_CELL_WIDTH_PROPERTY

Name of the "grid cell width" property.

See Also:

Constant Field Values

GRID_CELL_HEIGHT_PROPERTY

public static final java.lang.String GRID_CELL_HEIGHT_PROPERTY

Name of the "grid cell height" property.

See Also:

Constant Field Values

SHOW_GRID_PROPERTY

public static final java.lang.String SHOW_GRID_PROPERTY

Name of the "show grid" property.

See Also:

Constant Field Values

ZOOM_GRID_PROPERTY

public static final java.lang.String ZOOM_GRID_PROPERTY

Name of the "zoom grid" property.

See Also:

Constant Field Values

SNAP_TO_GRID_PROPERTY

public static final java.lang.String SNAP_TO_GRID_PROPERTY

Name of the "snap to grid" property.

See Also:

Constant Field Values

Constructor Detail

GridModel

public GridModel()

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface IPropertyChangeNotifier

getGridCellHeight

public double getGridCellHeight()

Returns the grid cell height.

Returns:

The grid cell height.

getGridCellWidth

public double getGridCellWidth()

Returns the grid cell width.

Returns:

The grid cell width.

isShowGrid

public boolean isShowGrid()

Returns true if the grid is visible, otherwise false.

Returns:

true if the grid is visible, otherwise false.

isSnapToGrid

public boolean isSnapToGrid()

Returns true if snap to grid is enabled, otherwise false.

Returns:

true if snap to grid is enabled, otherwise false.

isZoomGrid

public boolean isZoomGrid()

Returns true if the grid is zooming with the contents, otherwise false.

Returns:

true if the grid is zooming with the contents, otherwise false.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface IPropertyChangeNotifier

setGridCellHeight

public void setGridCellHeight(double gridCellHeight)

Sets the grid cell height to the given value.

Parameters:

gridCellHeight - The new grid cell height.

setGridCellWidth

public void setGridCellWidth(double gridCellWidth)

Sets the grid cell width to the given value.

Parameters:

gridCellWidth - The new grid cell width.

setShowGrid

public void setShowGrid(boolean showGrid)

Shows/Hides the grid depending on the given value.

Parameters:

showGrid - true in order to show the grid, or false in order to hide it.

setSnapToGrid

public void setSnapToGrid(boolean snapToGrid)

Enables/Disables snap to grid depending on the given value.

Parameters:

snapToGrid - true in order to enable snap-to-grid, or false in order to disable it.

setZoomGrid

public void setZoomGrid(boolean zoomGrid)

Enables/Disables grid zooming depending on the given value.

Parameters:

zoomGrid - true in order to zoom the grid with the contents, or false in order to not zoom the grid.