de.gsi.chart.renderer.spi

Class GridRenderer

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

de.gsi.chart.renderer.spi.GridRenderer

All Implemented Interfaces:

Renderer, Styleable, EventTarget

public class GridRenderer
extends Pane
implements Renderer

Property Summary

Type	Property and Description
BooleanProperty	drawOnTop Indicates whether grid lines should be drawn on top or beneath graphs
BooleanProperty	horizontalGridLinesVisible Indicates whether horizontal major grid lines are visible or not.
BooleanProperty	horizontalMinorGridLinesVisible Indicates whether horizontal minor grid lines are visible or not.
BooleanProperty	showInLegend Sets whether DataSets attached to this renderer shall be shown in the legend
BooleanProperty	verticalGridLinesVisible Indicates whether vertical major grid lines are visible or not.
BooleanProperty	verticalMinorGridLinesVisible Indicates whether vertical minor grid lines are visible or not.

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Field Summary

Fields

Modifier and Type	Field and Description
protected ObservableList<Axis>	axesList
protected Chart	baseChart

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
GridRenderer(XYChart chart)

Method Summary

Modifier and Type	Method and Description
protected static void	applyGraphicsStyleFromLineStyle(GraphicsContext gc, Line style)
protected void	drawEuclideanGrid(GraphicsContext gc, XYChart xyChart)
protected void	drawHorizontalMajorGridLines(GraphicsContext gc, Axis yAxis, double xAxisWidthSnapped, double yAxisHeight)
protected void	drawHorizontalMinorGridLines(GraphicsContext gc, Axis yAxis, double xAxisWidthSnapped, double yAxisHeight)
Canvas	drawLegendSymbol(DataSet dataSet, int dsIndex, int width, int height)
BooleanProperty	drawOnTopProperty() Indicates whether grid lines should be drawn on top or beneath graphs
protected void	drawPolarCircle(GraphicsContext gc, Axis yAxis, double yRange, double xCentre, double yCentre, double maxRadius)
protected void	drawPolarGrid(GraphicsContext gc, XYChart xyChart)
protected void	drawVerticalMajorGridLines(GraphicsContext gc, Axis xAxis, double xAxisWidth, double yAxisHeightSnapped)
protected void	drawVerticalMinorGridLines(GraphicsContext gc, Axis xAxis, double xAxisWidth, double yAxisHeightSnapped)
ObservableList<Axis>	getAxes()
List<CssMetaData<? extends Styleable,?>>	getCssMetaData()
ObservableList<DataSet>	getDatasets()
ObservableList<DataSet>	getDatasetsCopy()
Line	getHorizontalMajorGrid() modify this to change drawing of horizontal major grid lines
Line	getHorizontalMinorGrid() modify this to change drawing of horizontal minor grid lines
Line	getVerticalMajorGrid() modify this to change drawing of vertical major grid lines
Line	getVerticalMinorGrid() modify this to change drawing of vertical minor grid lines
BooleanProperty	horizontalGridLinesVisibleProperty() Indicates whether horizontal major grid lines are visible or not.
BooleanProperty	horizontalMinorGridLinesVisibleProperty() Indicates whether horizontal minor grid lines are visible or not.
boolean	isDrawOnTop() Indicates whether grid lines should be drawn on top or beneath graphs
void	render(GraphicsContext gc, Chart chart, int dataSetOffset, ObservableList<DataSet> datasets)
void	setDrawOnTop(boolean state) Indicates whether grid lines should be drawn on top or beneath graphs
Renderer	setShowInLegend(boolean state) Sets whether DataSets attached to this renderer shall be shown in the legend
boolean	showInLegend() Sets whether DataSets attached to this renderer shall be shown in the legend
BooleanProperty	showInLegendProperty() Sets whether DataSets attached to this renderer shall be shown in the legend
BooleanProperty	verticalGridLinesVisibleProperty() Indicates whether vertical major grid lines are visible or not.
BooleanProperty	verticalMinorGridLinesVisibleProperty() Indicates whether vertical minor grid lines are visible or not.

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBackground, getBorder, getClassCssMetaData, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, layoutChildren, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

drawOnTop

public final BooleanProperty drawOnTopProperty

Indicates whether grid lines should be drawn on top or beneath graphs

See Also:

isDrawOnTop(), setDrawOnTop(boolean)

horizontalGridLinesVisible

public final BooleanProperty horizontalGridLinesVisibleProperty

Indicates whether horizontal major grid lines are visible or not.

horizontalMinorGridLinesVisible

public final BooleanProperty horizontalMinorGridLinesVisibleProperty

Indicates whether horizontal minor grid lines are visible or not.

showInLegend

public BooleanProperty showInLegendProperty

Specified by:

showInLegendProperty in interface Renderer

verticalGridLinesVisible

public final BooleanProperty verticalGridLinesVisibleProperty

Indicates whether vertical major grid lines are visible or not.

verticalMinorGridLinesVisible

public final BooleanProperty verticalMinorGridLinesVisibleProperty

Indicates whether vertical minor grid lines are visible or not.

Field Detail

baseChart

protected final Chart baseChart

axesList

protected final ObservableList<Axis> axesList

Constructor Detail

GridRenderer

public GridRenderer(XYChart chart)

Method Detail

drawEuclideanGrid

protected void drawEuclideanGrid(GraphicsContext gc,
                                 XYChart xyChart)

drawHorizontalMajorGridLines

protected void drawHorizontalMajorGridLines(GraphicsContext gc,
                                            Axis yAxis,
                                            double xAxisWidthSnapped,
                                            double yAxisHeight)

drawHorizontalMinorGridLines

protected void drawHorizontalMinorGridLines(GraphicsContext gc,
                                            Axis yAxis,
                                            double xAxisWidthSnapped,
                                            double yAxisHeight)

drawLegendSymbol

public Canvas drawLegendSymbol(DataSet dataSet,
                               int dsIndex,
                               int width,
                               int height)

Specified by:

drawLegendSymbol in interface Renderer

Parameters:

dataSet - the data set for which the representative icon should be generated

dsIndex - index within renderer set

width - requested width of the returning Canvas

height - requested height of the returning Canvas

Returns:

a graphical icon representation of the given data sets

drawOnTopProperty

public final BooleanProperty drawOnTopProperty()

Indicates whether grid lines should be drawn on top or beneath graphs

See Also:

isDrawOnTop(), setDrawOnTop(boolean)

drawPolarCircle

protected void drawPolarCircle(GraphicsContext gc,
                               Axis yAxis,
                               double yRange,
                               double xCentre,
                               double yCentre,
                               double maxRadius)

drawPolarGrid

protected void drawPolarGrid(GraphicsContext gc,
                             XYChart xyChart)

drawVerticalMajorGridLines

protected void drawVerticalMajorGridLines(GraphicsContext gc,
                                          Axis xAxis,
                                          double xAxisWidth,
                                          double yAxisHeightSnapped)

drawVerticalMinorGridLines

protected void drawVerticalMinorGridLines(GraphicsContext gc,
                                          Axis xAxis,
                                          double xAxisWidth,
                                          double yAxisHeightSnapped)

getAxes

public ObservableList<Axis> getAxes()

Specified by:

getAxes in interface Renderer

Returns:

observable list of axes that are supposed to be used by the renderer

getCssMetaData

public List<CssMetaData<? extends Styleable,?>> getCssMetaData()

Specified by:

getCssMetaData in interface Styleable

Overrides:

getCssMetaData in class Region

getDatasets

public ObservableList<DataSet> getDatasets()

Specified by:

getDatasets in interface Renderer

getDatasetsCopy

public ObservableList<DataSet> getDatasetsCopy()

Specified by:

getDatasetsCopy in interface Renderer

getHorizontalMajorGrid

public Line getHorizontalMajorGrid()

modify this to change drawing of horizontal major grid lines

Returns:

the Line node to be styled

getHorizontalMinorGrid

public Line getHorizontalMinorGrid()

modify this to change drawing of horizontal minor grid lines

Returns:

the Line node to be styled

getVerticalMajorGrid

public Line getVerticalMajorGrid()

modify this to change drawing of vertical major grid lines

Returns:

the Line node to be styled

getVerticalMinorGrid

public Line getVerticalMinorGrid()

modify this to change drawing of vertical minor grid lines

Returns:

the Line node to be styled

horizontalGridLinesVisibleProperty

public final BooleanProperty horizontalGridLinesVisibleProperty()

Indicates whether horizontal major grid lines are visible or not.

horizontalMinorGridLinesVisibleProperty

public final BooleanProperty horizontalMinorGridLinesVisibleProperty()

Indicates whether horizontal minor grid lines are visible or not.

isDrawOnTop

public final boolean isDrawOnTop()

Indicates whether grid lines should be drawn on top or beneath graphs

Returns:

drawOnTop state

render

public void render(GraphicsContext gc,
                   Chart chart,
                   int dataSetOffset,
                   ObservableList<DataSet> datasets)

Specified by:

render in interface Renderer

setDrawOnTop

public final void setDrawOnTop(boolean state)

Indicates whether grid lines should be drawn on top or beneath graphs

Parameters:

state - true: draw on top

setShowInLegend

public Renderer setShowInLegend(boolean state)

Description copied from interface: Renderer

Sets whether DataSets attached to this renderer shall be shown in the legend

Specified by:

setShowInLegend in interface Renderer

Parameters:

state - true (default) if data sets are supposed to be drawn

Returns:

the renderer class

showInLegend

public boolean showInLegend()

Description copied from interface: Renderer

Sets whether DataSets attached to this renderer shall be shown in the legend

Specified by:

showInLegend in interface Renderer

Returns:

true (default) if data sets are supposed to be drawn

showInLegendProperty

public BooleanProperty showInLegendProperty()

Description copied from interface: Renderer

Sets whether DataSets attached to this renderer shall be shown in the legend

Specified by:

showInLegendProperty in interface Renderer

verticalGridLinesVisibleProperty

public final BooleanProperty verticalGridLinesVisibleProperty()

Indicates whether vertical major grid lines are visible or not.

verticalMinorGridLinesVisibleProperty

public final BooleanProperty verticalMinorGridLinesVisibleProperty()

Indicates whether vertical minor grid lines are visible or not.

applyGraphicsStyleFromLineStyle

protected static void applyGraphicsStyleFromLineStyle(GraphicsContext gc,
                                                      Line style)