Class GridModel

java.lang.Object
org.eclipse.gef.mvc.fx.models.GridModel

public class GridModel extends Object
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.
  • Property Details

  • Field Details

    • ZOOM_GRID_DEFAULT

      public static final boolean ZOOM_GRID_DEFAULT
      The default value for isZoomGrid().
      See Also:
    • SHOW_GRID_DEFAULT

      public static final boolean SHOW_GRID_DEFAULT
      The default value for isShowGrid().
      See Also:
    • GRID_CELL_HEIGHT_DEFAULT

      public static final double GRID_CELL_HEIGHT_DEFAULT
      The default grid cell height.
      See Also:
    • GRID_CELL_WIDTH_DEFAULT

      public static final double GRID_CELL_WIDTH_DEFAULT
      The default grid cell width.
      See Also:
    • GRID_CELL_WIDTH_PROPERTY

      public static final String GRID_CELL_WIDTH_PROPERTY
      Name of the "grid cell width" property.
      See Also:
    • GRID_CELL_HEIGHT_PROPERTY

      public static final String GRID_CELL_HEIGHT_PROPERTY
      Name of the "grid cell height" property.
      See Also:
    • SHOW_GRID_PROPERTY

      public static final String SHOW_GRID_PROPERTY
      Name of the "show grid" property.
      See Also:
    • ZOOM_GRID_PROPERTY

      public static final String ZOOM_GRID_PROPERTY
      Name of the "zoom grid" property.
      See Also:
  • Constructor Details

    • GridModel

      public GridModel()
  • Method Details

    • 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.
    • gridCellHeightProperty

      public DoubleProperty gridCellHeightProperty()
      Returns a double property representing the grid cell height.
      See Also:
    • gridCellWidthProperty

      public DoubleProperty gridCellWidthProperty()
      Returns a double property representing the grid cell width.
      See Also:
    • isShowGrid

      public boolean isShowGrid()
      Returns true if the grid is visible, otherwise false.
      Returns:
      true if the grid is visible, 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.
    • 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.
    • 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.
    • showGridProperty

      public BooleanProperty showGridProperty()
      Returns a boolean property whose value indicates whether grid is to be shown.
      See Also:
    • zoomGridProperty

      public BooleanProperty zoomGridProperty()
      Returns a boolean property whose value indicates whether grid is to be zoomed.
      See Also: