org.das2.graph

Class DigitalRenderer

java.lang.Object

org.das2.graph.Renderer

org.das2.graph.DigitalRenderer

All Implemented Interfaces:

Displayable, Editable, DataSetConsumer

public class DigitalRenderer
extends Renderer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DigitalRenderer.Align

Field Summary

Fields

Modifier and Type	Field and Description
protected DigitalRenderer.Align	align
protected java.awt.Color	color
protected int	dataSetSizeLimit
static java.lang.String	PROP_ALIGN
static java.lang.String	PROP_COLOR
static java.lang.String	PROP_DATASETSIZELIMIT
static java.lang.String	PROP_FILLLABEL
static java.lang.String	PROP_FONTSIZE font size, expressed as relative string like "1em" or "6pt"
static java.lang.String	PROP_FORMAT format, empty string means use either dataset's format, or %.2f
static java.lang.String	PROP_PLOTSYMBOL
static java.lang.String	PROP_SIZE font size, 0 indicates the plot font should be used.

Fields inherited from class org.das2.graph.Renderer

bottomDecorator, colorBar, control, CONTROL_KEY_COLOR, CONTROL_KEY_COLOR_TABLE, CONTROL_KEY_DRAW_ERROR, CONTROL_KEY_FILL_COLOR, CONTROL_KEY_FILL_DIRECTION, CONTROL_KEY_FILL_TEXTURE, CONTROL_KEY_FONT_SIZE, CONTROL_KEY_LINE_STYLE, CONTROL_KEY_LINE_THICK, CONTROL_KEY_MODULO_X, CONTROL_KEY_MODULO_Y, CONTROL_KEY_REFERENCE, CONTROL_KEY_SPECIAL_COLORS, CONTROL_KEY_SYMBOL, CONTROL_KEY_SYMBOL_SIZE, drawLegendLabel, ds, firstValidIndex, id, lastException, lastValidIndex, legendLabel, logger, MARKER_DATASET, MARKER_X_AXIS_RANGE, MARKER_Y_AXIS_RANGE, needWorkMarkers, PROP_ACTIVE, PROP_BOTTOMDECORATOR, PROP_COLORBAR, PROP_CONTROL, PROP_DRAWLEGENDLABEL, PROP_ID, PROP_LEGENDLABEL, PROP_RECORDFILE, PROP_TOPDECORATOR, propertyChangeSupport, renderException, topDecorator

Constructor Summary

Constructors

Constructor and Description
DigitalRenderer()

Method Summary

Modifier and Type	Method and Description
boolean	acceptContext(int x, int y) Returns true if the render will accept the context for a point.
static QDataSet	doAutorange(QDataSet ds) autorange on the data, returning a rank 2 bounds for the dataset.
static java.lang.String	formatDatum(java.lang.String form, Datum d, char type) format the datum into a string, using the format and the pre-calculated type.
DigitalRenderer.Align	getAlign()
java.awt.Color	getColor()
java.lang.String	getControl() get the string which summarizes the state of the renderer.
int	getDataSetSizeLimit()
java.lang.String	getFillLabel()
java.lang.String	getFontSize()
java.lang.String	getFormat()
PlotSymbol	getPlotSymbol()
double	getSize()
void	render(java.awt.Graphics2D g, DasAxis xAxis, DasAxis yAxis) Render is called whenever the image needs to be refreshed or the content has changed.
java.awt.Shape	selectionArea() like accept context, but provides a shape to indicate selection.
void	setAlign(DigitalRenderer.Align align) For the box containing the digital number, which corner is anchored to the data.
void	setColor(java.awt.Color color)
void	setControl(java.lang.String s) set the control string which contains a number of properties.
void	setDataSetSizeLimit(int dataSetSizeLimit)
void	setFillLabel(java.lang.String fillLabel) the label printed where fill data (invalid data placeholder) is found.
void	setFontSize(java.lang.String fontSize)
void	setFormat(java.lang.String value) note the dataset's format will be used if this is "", and "%.2f" if no format is found there.
void	setPlotSymbol(PlotSymbol plotSymbol)
void	setSize(double size)
static char	typeForFormat(java.lang.String form) return the data type needed for the format.
void	updatePlotImage(DasAxis xAxis, DasAxis yAxis, ProgressMonitor monitor) updatePlotImage is called once the expensive operation of loading the data is completed.

Methods inherited from class org.das2.graph.Renderer

acceptsDataSet, addPropertyChangeListener, addPropertyChangeListener, addToStats, decodeDatum, decodeFillStyle, decodePlotSymbolConnectorControl, decodePlotSymbolControl, drawListIcon, encodeBooleanControl, encodeColorControl, encodeDatum, encodeFillStyle, encodePlotSymbolConnectorControl, encodePlotSymbolControl, formatControl, getAffineTransform, getBooleanControl, getBottomDecorator, getColorBar, getColorControl, getConsumedDataSet, getControl, getDataLoader, getDataSet, getDataSetDescriptor, getDataSetID, getDatumControl, getDoubleArrayControl, getDoubleControl, getId, getIntegerControl, getInternalDataSet, getLastException, getLegendLabel, getListIcon, getListLabel, getParent, getRenderCount, getStatsFile, getTopDecorator, getUpdateCount, getXmemento, getYmemento, hasControl, incrementRenderCount, incrementUpdateCount, installRenderer, invalidateParentCacheImage, isActive, isDrawLegendLabel, isDumpDataSet, isTableDataSet, parseControl, parseLayoutString, postException, postMessage, postMessage, refresh, refreshImage, removePropertyChangeListener, removePropertyChangeListener, renderException, resetCounters, setActive, setBottomDecorator, setColorBar, setDataSet, setDataSetDescriptor, setDataSetID, setDataSetLoader, setDrawLegendLabel, setDumpDataSet, setException, setId, setLastException, setLegendLabel, setParent, setStatsFile, setTopDecorator, setUpFont, setUpFont, uninstallRenderer, update, updateCacheImage, updateImmediately

Methods inherited from class java.lang.Object

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

Field Detail

color

protected java.awt.Color color

PROP_COLOR

public static final java.lang.String PROP_COLOR

See Also:

Constant Field Values

align

protected DigitalRenderer.Align align

PROP_ALIGN

public static final java.lang.String PROP_ALIGN

See Also:

Constant Field Values

PROP_PLOTSYMBOL

public static final java.lang.String PROP_PLOTSYMBOL

See Also:

Constant Field Values

PROP_FORMAT

public static final java.lang.String PROP_FORMAT

format, empty string means use either dataset's format, or %.2f

See Also:

Constant Field Values

PROP_SIZE

public static final java.lang.String PROP_SIZE

font size, 0 indicates the plot font should be used. TODO: this should be relativeSize. Add a property for this as well.

See Also:

Constant Field Values

PROP_FONTSIZE

public static final java.lang.String PROP_FONTSIZE

font size, expressed as relative string like "1em" or "6pt"

See Also:

Constant Field Values

PROP_FILLLABEL

public static final java.lang.String PROP_FILLLABEL

See Also:

Constant Field Values

dataSetSizeLimit

protected int dataSetSizeLimit

PROP_DATASETSIZELIMIT

public static final java.lang.String PROP_DATASETSIZELIMIT

See Also:

Constant Field Values

Constructor Detail

DigitalRenderer

public DigitalRenderer()

Method Detail

doAutorange

public static QDataSet doAutorange(QDataSet ds)

autorange on the data, returning a rank 2 bounds for the dataset.

Parameters:

ds - the dataset

Returns:

a bounding box or null if the dataset is empty.

See Also:

Schemes.boundingBox()

getColor

public java.awt.Color getColor()

setColor

public void setColor(java.awt.Color color)

getAlign

public DigitalRenderer.Align getAlign()

setAlign

public void setAlign(DigitalRenderer.Align align)

For the box containing the digital number, which corner is anchored to the data. Note this is consistent with the anchorPosition property of annotations.

Parameters:

align -

getPlotSymbol

public PlotSymbol getPlotSymbol()

setPlotSymbol

public void setPlotSymbol(PlotSymbol plotSymbol)

getFormat

public java.lang.String getFormat()

setFormat

public void setFormat(java.lang.String value)

note the dataset's format will be used if this is "", and "%.2f" if no format is found there.

Parameters:

value -

getSize

public double getSize()

setSize

public void setSize(double size)

getFontSize

public java.lang.String getFontSize()

setFontSize

public void setFontSize(java.lang.String fontSize)

getFillLabel

public java.lang.String getFillLabel()

setFillLabel

public void setFillLabel(java.lang.String fillLabel)

the label printed where fill data (invalid data placeholder) is found.

Parameters:

fillLabel - the label such as "fill" or "" for nothing.

setControl

public void setControl(java.lang.String s)

Description copied from class: Renderer

set the control string which contains a number of properties. These are defined for each renderer, but they should try to be consistent. See http://autoplot.org/developer.guessRenderType#Proposed_extensions When overriding this, be sure to call super.

Overrides:

setControl in class Renderer

Parameters:

s - the control

See Also:

etc

getControl

public java.lang.String getControl()

Description copied from class: Renderer

get the string which summarizes the state of the renderer. These allow a compact string to contain the renderer settings. This should be an ampersand-delimited list of name=value pairs.

Overrides:

getControl in class Renderer

Returns:

selectionArea

public java.awt.Shape selectionArea()

like accept context, but provides a shape to indicate selection. This should be roughly the same as the locus of points where acceptContext is true.

Returns:

getDataSetSizeLimit

public int getDataSetSizeLimit()

setDataSetSizeLimit

public void setDataSetSizeLimit(int dataSetSizeLimit)

render

public void render(java.awt.Graphics2D g,
                   DasAxis xAxis,
                   DasAxis yAxis)

Description copied from class: Renderer

Render is called whenever the image needs to be refreshed or the content has changed. This operation should occur with an animation-interactive time scale, and an image should be cached when this is not possible. The graphics object will have its origin at the upper-left corner of the screen.

Specified by:

render in class Renderer

Parameters:

g - the graphics context in the canvas reference frame.

xAxis - the axis relating x data coordinates to horizontal pixel coordinates

yAxis - the axis relating y data coordinates to horizontal pixel coordinates

typeForFormat

public static char typeForFormat(java.lang.String form)

return the data type needed for the format. For example, %d needs integers, %f needs floats.

Parameters:

form -

Returns:

'x' 'X' 'd' 'o' 'c' 'C' or 'f'

formatDatum

public static java.lang.String formatDatum(java.lang.String form,
                                           Datum d,
                                           char type)

format the datum into a string, using the format and the pre-calculated type.

Parameters:

form - the format, such as %.2f or "x=%d cc"

d -

type - 'x' 'X' 'd' 'o' 'c' 'C' or 'f'

Returns:

the string

acceptContext

public boolean acceptContext(int x,
                             int y)

Description copied from class: Renderer

Returns true if the render will accept the context for a point. That is, the renderer affected that point, or nearby points. This is used currently to provide a way for the operator to click on a plot and directly edit the renderer which drew the pixel.

Overrides:

acceptContext in class Renderer

Parameters:

x - the x coordinate in the canvas coordinate system.

y - the y coordinate in the canvas coordinate system.

Returns:

true if the renderer will accept the context.

updatePlotImage

public void updatePlotImage(DasAxis xAxis,
                            DasAxis yAxis,
                            ProgressMonitor monitor)
                     throws DasException

Description copied from class: Renderer

updatePlotImage is called once the expensive operation of loading the data is completed. This operation should occur on an interactive time scale. This is an opportunity to create a cache image of the data with the current axis state, when the render operation cannot operate on an animation interactive time scale. Also, several Renders can be updating at once on separate threads, while the render methods must be called sequentially. Only Renderer should call this method! (This should be protected then, but this is not possible because of exiting use. TODO: introduce "revalidate" to replace this operation.)

Overrides:

updatePlotImage in class Renderer

Parameters:

xAxis - the axis relating x data coordinates to horizontal pixel coordinates

yAxis - the axis relating y data coordinates to horizontal pixel coordinates

monitor - a monitor for the operation. Note the updatePlotImage operation should be fast (<1000ms).

Throws:

DasException