GraphEditorProperties (Graph Editor::API 1.0.0 API)

java.lang.Object
- de.tesis.dynaware.grapheditor.utils.GraphEditorProperties

```
public class GraphEditorProperties
extends java.lang.Object
```
General properties for the graph editor.
For example, should the editor have 'bounds', or should objects be draggable outside the editor area?

If a bound is active, objects that are dragged or resized in the editor should stop when they hit the edge, and the editor region will not try to grow in size. Otherwise it will grow up to its max size.

Also stores properties for whether the grid is visible and/or snap-to-grid is on.

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.ObjectProperty<javafx.scene.paint.Color>`	`gridColor` Gets the grid color property.
`javafx.beans.property.DoubleProperty`	`gridSpacing` Gets the grid spacing property.
`javafx.beans.property.BooleanProperty`	`gridVisible` Gets the grid-visible property.
`javafx.beans.property.BooleanProperty`	`snapToGrid` Gets the snap-to-grid property.

Field Summary

Fields
Modifier and Type Field and Description

static double DEFAULT_MAX_HEIGHT

static double DEFAULT_MAX_WIDTH

Fields
Modifier and Type	Field and Description
`static double`	`DEFAULT_MAX_HEIGHT`
`static double`	`DEFAULT_MAX_WIDTH`

Constructor Summary

Constructors
Constructor and Description
`GraphEditorProperties()` Creates a new editor properties instance containing a set of default properties.
`GraphEditorProperties(GraphEditorProperties editorProperties)` Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Map<java.lang.String,java.lang.String>`	`getCustomProperties()` Additional properties that may be added and referred to in custom skin implementations.
`double`	`getEastBoundValue()` Gets the value of the east bound.
`javafx.scene.paint.Color`	`getGridColor()` Gets the grid color.
`double`	`getGridSpacing()` Gets the current grid spacing in pixels.
`double`	`getNorthBoundValue()` Gets the value of the north bound.
`double`	`getSouthBoundValue()` Gets the value of the south bound.
`double`	`getWestBoundValue()` Gets the value of the west bound.
`javafx.beans.property.ObjectProperty<javafx.scene.paint.Color>`	`gridColorProperty()` Gets the grid color property.
`javafx.beans.property.DoubleProperty`	`gridSpacingProperty()` Gets the grid spacing property.
`javafx.beans.property.BooleanProperty`	`gridVisibleProperty()` Gets the grid-visible property.
`boolean`	`isEastBoundActive()` Gets whether the east bound is active.
`boolean`	`isGridVisible()` Checks if the background grid is visible.
`boolean`	`isNorthBoundActive()` Gets whether the north bound is active.
`boolean`	`isSnapToGridOn()` Checks if snap-to-grid is on.
`boolean`	`isSouthBoundActive()` Gets whether the south bound is active.
`boolean`	`isWestBoundActive()` Gets whether the west bound is active.
`void`	`setEastBound(boolean eastBound)` Sets whether the east bound is active.
`void`	`setEastBoundValue(double eastBoundValue)` Sets the value of the east bound.
`void`	`setGridColor(javafx.scene.paint.Color gridColor)` Sets the new grid color.
`void`	`setGridSpacing(double gridSpacing)` Sets the grid spacing to be used if the grid is visible and/or snap-to-grid is enabled.
`void`	`setGridVisible(boolean gridVisible)` Sets whether the background grid should be visible or not.
`void`	`setNorthBoundValue(double northBoundValue)` Sets the value of the north bound.
`void`	`setSnapToGrid(boolean snapToGrid)` Sets whether snap-to-grid should be on.
`void`	`setSouthBound(boolean southBound)` Sets whether the south bound is active.
`void`	`setSouthBoundValue(double southBoundValue)` Sets the value of the south bound.
`void`	`setWestBoundValue(double westBoundValue)` Sets the value of the west bound.
`javafx.beans.property.BooleanProperty`	`snapToGridProperty()` Gets the snap-to-grid property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - gridVisible
```
public javafx.beans.property.BooleanProperty gridVisibleProperty
```
    Gets the grid-visible property.
    
    See Also:
    
    isGridVisible(), setGridVisible(boolean)
  - snapToGrid
```
public javafx.beans.property.BooleanProperty snapToGridProperty
```
    Gets the snap-to-grid property.
    
    See Also:
    
    setSnapToGrid(boolean)
  - gridSpacing
```
public javafx.beans.property.DoubleProperty gridSpacingProperty
```
    Gets the grid spacing property.
    
    See Also:
    
    getGridSpacing(), setGridSpacing(double)
  - gridColor
```
public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> gridColorProperty
```
    Gets the grid color property.
    
    See Also:
    
    getGridColor(), setGridColor(Color)
- Field Detail
  - DEFAULT_MAX_WIDTH
```
public static final double DEFAULT_MAX_WIDTH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_HEIGHT
```
public static final double DEFAULT_MAX_HEIGHT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GraphEditorProperties
```
public GraphEditorProperties()
```
    Creates a new editor properties instance containing a set of default properties.
  - GraphEditorProperties
```
public GraphEditorProperties(GraphEditorProperties editorProperties)
```
    Copy constructor.
    Creates a new editor properties instance with all values copied over from an existing instance.
    
    Parameters:
    
    editorProperties - an existing GraphEditorProperties instance
- Method Detail
  - isNorthBoundActive
```
public boolean isNorthBoundActive()
```
    Gets whether the north bound is active.
    
    Returns:
    
    true if the north bound is active, false if not
  - isSouthBoundActive
```
public boolean isSouthBoundActive()
```
    Gets whether the south bound is active.
    
    Returns:
    
    true if the south bound is active, false if not
  - setSouthBound
```
public void setSouthBound(boolean southBound)
```
    Sets whether the south bound is active.
    
    Parameters:
    
    southBound - true if the south bound is active, false if not
  - isEastBoundActive
```
public boolean isEastBoundActive()
```
    Gets whether the east bound is active.
    
    Returns:
    
    true if the east bound is active, false if not
  - setEastBound
```
public void setEastBound(boolean eastBound)
```
    Sets whether the east bound is active.
    
    Parameters:
    
    eastBound - true if the east bound is active, false if not
  - isWestBoundActive
```
public boolean isWestBoundActive()
```
    Gets whether the west bound is active.
    
    Returns:
    
    true if the west bound is active, false if not
  - getNorthBoundValue
```
public double getNorthBoundValue()
```
    Gets the value of the north bound.
    
    Returns:
    
    the value of the north bound
  - setNorthBoundValue
```
public void setNorthBoundValue(double northBoundValue)
```
    Sets the value of the north bound.
    
    Parameters:
    
    northBoundValue - the value of the north bound
  - getSouthBoundValue
```
public double getSouthBoundValue()
```
    Gets the value of the south bound.
    
    Returns:
    
    the value of the south bound
  - setSouthBoundValue
```
public void setSouthBoundValue(double southBoundValue)
```
    Sets the value of the south bound.
    
    Parameters:
    
    southBoundValue - the value of the south bound
  - getEastBoundValue
```
public double getEastBoundValue()
```
    Gets the value of the east bound.
    
    Returns:
    
    the value of the east bound
  - setEastBoundValue
```
public void setEastBoundValue(double eastBoundValue)
```
    Sets the value of the east bound.
    
    Parameters:
    
    eastBoundValue - the value of the east bound
  - getWestBoundValue
```
public double getWestBoundValue()
```
    Gets the value of the west bound.
    
    Returns:
    
    the value of the west bound
  - setWestBoundValue
```
public void setWestBoundValue(double westBoundValue)
```
    Sets the value of the west bound.
    
    Parameters:
    
    westBoundValue - the value of the west bound
  - isGridVisible
```
public boolean isGridVisible()
```
    Checks if the background grid is visible.
    
    Returns:
    
    true if the background grid is visible, false if not
  - setGridVisible
```
public void setGridVisible(boolean gridVisible)
```
    Sets whether the background grid should be visible or not.
    
    Parameters:
    
    gridVisible - true if the background grid should be visible, false if not
  - gridVisibleProperty
```
public javafx.beans.property.BooleanProperty gridVisibleProperty()
```
    Gets the grid-visible property.
    
    See Also:
    
    isGridVisible(), setGridVisible(boolean)
  - isSnapToGridOn
```
public boolean isSnapToGridOn()
```
    Checks if snap-to-grid is on.
    
    Returns:
    
    true if snap-to-grid is on, false if not
  - setSnapToGrid
```
public void setSnapToGrid(boolean snapToGrid)
```
    Sets whether snap-to-grid should be on.
    
    Parameters:
    
    snapToGrid - true if snap-to-grid should be on, false if not
  - snapToGridProperty
```
public javafx.beans.property.BooleanProperty snapToGridProperty()
```
    Gets the snap-to-grid property.
    
    See Also:
    
    setSnapToGrid(boolean)
  - getGridSpacing
```
public double getGridSpacing()
```
    Gets the current grid spacing in pixels.
    
    Returns:
    
    the current grid spacing
  - setGridSpacing
```
public void setGridSpacing(double gridSpacing)
```
    Sets the grid spacing to be used if the grid is visible and/or snap-to-grid is enabled.
    Integer values are recommended to avoid sub-pixel positioning effects.
    
    Parameters:
    
    gridSpacing - the grid spacing to be used
  - gridSpacingProperty
```
public javafx.beans.property.DoubleProperty gridSpacingProperty()
```
    Gets the grid spacing property.
    
    See Also:
    
    getGridSpacing(), setGridSpacing(double)
  - getGridColor
```
public javafx.scene.paint.Color getGridColor()
```
    Gets the grid color.
    
    Returns:
    
    the grid color, or null if nothing was set
  - setGridColor
```
public void setGridColor(javafx.scene.paint.Color gridColor)
```
    Sets the new grid color.
    
    Parameters:
    
    gridColor - the new grid Color
  - gridColorProperty
```
public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> gridColorProperty()
```
    Gets the grid color property.
    
    See Also:
    
    getGridColor(), setGridColor(Color)
  - getCustomProperties
```
public java.util.Map<java.lang.String,java.lang.String> getCustomProperties()
```
    Additional properties that may be added and referred to in custom skin implementations.
    
    Returns:
    
    a map of custom properties

Class GraphEditorProperties

Property Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

gridVisible

snapToGrid

gridSpacing

gridColor

Field Detail

DEFAULT_MAX_WIDTH

DEFAULT_MAX_HEIGHT

Constructor Detail

GraphEditorProperties

GraphEditorProperties

Method Detail

isNorthBoundActive

isSouthBoundActive

setSouthBound

isEastBoundActive

setEastBound

isWestBoundActive

getNorthBoundValue

setNorthBoundValue

getSouthBoundValue

setSouthBoundValue

getEastBoundValue

setEastBoundValue

getWestBoundValue

setWestBoundValue

isGridVisible

setGridVisible

gridVisibleProperty

isSnapToGridOn

setSnapToGrid

snapToGridProperty

getGridSpacing

setGridSpacing

gridSpacingProperty

getGridColor

setGridColor

gridColorProperty

getCustomProperties