Package de.gsi.chart.renderer.spi

Class MetaDataRenderer

java.lang.Object

de.gsi.chart.renderer.spi.AbstractMetaDataRendererParameter<MetaDataRenderer>

de.gsi.chart.renderer.spi.MetaDataRenderer

All Implemented Interfaces:

Renderer

public class MetaDataRenderer
extends AbstractMetaDataRendererParameter<MetaDataRenderer>
implements Renderer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	MetaDataRenderer.MetaLabel
protected static class	MetaDataRenderer.MsgType

Field Summary

Fields

Modifier and Type	Field	Description
protected javafx.collections.ObservableList<Axis>	axesList
protected javafx.scene.layout.BorderPane	borderPane
protected Chart	chart
protected javafx.beans.property.BooleanProperty	drawOnCanvas
protected javafx.scene.layout.HBox	errorBox
protected javafx.scene.layout.HBox	infoBox
protected javafx.beans.property.ObjectProperty<Side>	infoBoxSide
protected javafx.scene.layout.FlowPane	messageBox
protected java.util.List<java.lang.String>	oldErrorMessages
protected java.util.List<java.lang.String>	oldInfoMessages
protected java.util.List<java.lang.String>	oldWarningMessages
protected javafx.scene.layout.HBox	warningBox

Fields inherited from class de.gsi.chart.renderer.spi.AbstractMetaDataRendererParameter

DEFAULT_FONT, DEFAULT_FONT_SIZE, DEFAULT_GRID_DASH_PATTERM, DEFAULT_GRID_LINE_COLOR, DEFAULT_GRID_LINE_WIDTH, iconSize, imgIconError, imgIconInfo, imgIconWarning, showErrorMessages, showInfoMessages, showWarningMessages, strokeColorMarker, strokeDashPattern, strokeLineWidthMarker, style, STYLE_CLASS_LABELLED_MARKER

Constructor Summary

Constructors

Constructor	Description
MetaDataRenderer(Chart chart)

Method Summary

Modifier and Type	Method	Description
javafx.scene.canvas.Canvas	drawLegendSymbol(de.gsi.dataset.DataSet dataSet, int dsIndex, int width, int height)
javafx.beans.property.BooleanProperty	drawOnCanvasProperty()
javafx.collections.ObservableList<Axis>	getAxes()
javafx.scene.layout.BorderPane	getBorderPaneOnCanvas()
javafx.collections.ObservableList<de.gsi.dataset.DataSet>	getDatasets()
javafx.collections.ObservableList<de.gsi.dataset.DataSet>	getDatasetsCopy()
protected java.util.List<de.gsi.dataset.DataSet>	getDataSetsWithMetaData(java.util.List<de.gsi.dataset.DataSet> dataSets)
javafx.scene.layout.HBox	getErrorBox()
javafx.scene.layout.HBox	getInfoBox()
Side	getInfoBoxSide()	whether renderer should draw info box in Side side, ...
javafx.scene.layout.FlowPane	getMessageBox()
protected MetaDataRenderer	getThis()
javafx.scene.layout.HBox	getWarningBox()
javafx.beans.property.ObjectProperty<Side>	infoBoxSideProperty()	whether renderer should draw info box in Side side, ...
boolean	isDrawOnCanvas()
void	render(javafx.scene.canvas.GraphicsContext gc, Chart chart, int dataSetOffset, javafx.collections.ObservableList<de.gsi.dataset.DataSet> datasets)
void	setDrawOnCanvas(boolean state)
MetaDataRenderer	setInfoBoxSide(Side side)	whether renderer should draw info box in Side side, ...
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
javafx.beans.property.BooleanProperty	showInLegendProperty()	Sets whether DataSets attached to this renderer shall be shown in the legend
protected void	updateInfoBoxLocation()

Methods inherited from class de.gsi.chart.renderer.spi.AbstractMetaDataRendererParameter

getStyle, isShowErrorMessages, isShowInfoMessages, isShowWarningMessages, setshowErrorMessages, setshowInfoMessages, setshowWarningMessages, setStyle, showErrorMessagesProperty, showInfoMessagesProperty, showWarningMessagesProperty, styleProperty, updateCSS

Methods inherited from class java.lang.Object

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

Field Detail

borderPane

protected javafx.scene.layout.BorderPane borderPane

messageBox

protected javafx.scene.layout.FlowPane messageBox

infoBox

protected javafx.scene.layout.HBox infoBox

warningBox

protected javafx.scene.layout.HBox warningBox

errorBox

protected javafx.scene.layout.HBox errorBox

axesList

protected final javafx.collections.ObservableList<Axis> axesList

chart

protected Chart chart

oldInfoMessages

protected java.util.List<java.lang.String> oldInfoMessages

oldWarningMessages

protected java.util.List<java.lang.String> oldWarningMessages

oldErrorMessages

protected java.util.List<java.lang.String> oldErrorMessages

drawOnCanvas

protected final javafx.beans.property.BooleanProperty drawOnCanvas

infoBoxSide

protected final javafx.beans.property.ObjectProperty<Side> infoBoxSide

Constructor Detail

MetaDataRenderer

public MetaDataRenderer(Chart chart)

Method Detail

drawLegendSymbol

public javafx.scene.canvas.Canvas drawLegendSymbol(de.gsi.dataset.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

drawOnCanvasProperty

public javafx.beans.property.BooleanProperty drawOnCanvasProperty()

getAxes

public javafx.collections.ObservableList<Axis> getAxes()

Specified by:

getAxes in interface Renderer

Returns:

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

getBorderPaneOnCanvas

public javafx.scene.layout.BorderPane getBorderPaneOnCanvas()

getDatasets

public javafx.collections.ObservableList<de.gsi.dataset.DataSet> getDatasets()

Specified by:

getDatasets in interface Renderer

getDatasetsCopy

public javafx.collections.ObservableList<de.gsi.dataset.DataSet> getDatasetsCopy()

Specified by:

getDatasetsCopy in interface Renderer

getDataSetsWithMetaData

protected java.util.List<de.gsi.dataset.DataSet> getDataSetsWithMetaData(java.util.List<de.gsi.dataset.DataSet> dataSets)

getErrorBox

public javafx.scene.layout.HBox getErrorBox()

Returns:

box that is being filled with Error messages

getInfoBox

public javafx.scene.layout.HBox getInfoBox()

Returns:

box that is being filled with Info messages

getInfoBoxSide

public final Side getInfoBoxSide()

whether renderer should draw info box in Side side, ...

Returns:

Side

getMessageBox

public javafx.scene.layout.FlowPane getMessageBox()

Returns:

FlowPane containing the Info-, Warning- and Error-Boxes

getThis

protected MetaDataRenderer getThis()

Specified by:

getThis in class AbstractMetaDataRendererParameter<MetaDataRenderer>

Returns:

the instance of this AbstractMetaDataRendererParameter.

getWarningBox

public javafx.scene.layout.HBox getWarningBox()

Returns:

box that is being filled with Warning messages

infoBoxSideProperty

public final javafx.beans.property.ObjectProperty<Side> infoBoxSideProperty()

whether renderer should draw info box in Side side, ...

Returns:

property

isDrawOnCanvas

public boolean isDrawOnCanvas()

render

public void render(javafx.scene.canvas.GraphicsContext gc,
                   Chart chart,
                   int dataSetOffset,
                   javafx.collections.ObservableList<de.gsi.dataset.DataSet> datasets)

Specified by:

render in interface Renderer

setDrawOnCanvas

public void setDrawOnCanvas(boolean state)

setInfoBoxSide

public final MetaDataRenderer setInfoBoxSide(Side side)

whether renderer should draw info box in Side side, ...

Parameters:

side - the side to draw

Returns:

itself (fluent design)

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 javafx.beans.property.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

Returns:

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

updateInfoBoxLocation

protected void updateInfoBoxLocation()