org.das2.graph

Class StackedHistogramRenderer

java.lang.Object

org.das2.graph.Renderer

org.das2.graph.StackedHistogramRenderer

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener, Displayable, Editable, DataSetConsumer, TableDataSetConsumer

public class StackedHistogramRenderer
extends Renderer
implements TableDataSetConsumer, java.beans.PropertyChangeListener, Displayable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StackedHistogramRenderer.PeaksIndicator
protected class	StackedHistogramRenderer.RebinListener
static class	StackedHistogramRenderer.Rebinner

Field Summary

Fields inherited from class org.das2.graph.Renderer

colorBar, control, CONTROL_KEY_COLOR, CONTROL_KEY_COLOR_TABLE, CONTROL_KEY_DRAW_ERROR, CONTROL_KEY_FILL_COLOR, CONTROL_KEY_FILL_DIRECTION, CONTROL_KEY_FONT_SIZE, CONTROL_KEY_LINE_STYLE, CONTROL_KEY_LINE_THICK, CONTROL_KEY_REFERENCE, 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_COLORBAR, PROP_CONTROL, PROP_DRAWLEGENDLABEL, PROP_ID, PROP_LEGENDLABEL, PROP_TOPDECORATOR, propertyChangeSupport, renderException, topDecorator

Constructor Summary

Constructors

Constructor and Description
StackedHistogramRenderer(DasAxis zAxis)
StackedHistogramRenderer(DasPlot parent, DataSetDescriptor dsd, DasAxis zAxis, DasAxis yAxis)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getControl() get the string which summarizes the state of the renderer.
javax.swing.Icon	getListIcon() An icon can be provided that will be shown in a list along with the textual description of the element.
java.lang.String	getListLabel() return a String that will help the user identify this item when choosing from a list.
StackedHistogramRenderer.PeaksIndicator	getPeaksIndicator() Getter for property peaksIndicator.
DasAxis	getZAxis()
protected void	installRenderer()
boolean	isSliceRebinnedData() Getter for property sliceRebinnedData.
void	propertyChange(java.beans.PropertyChangeEvent e)
void	render(java.awt.Graphics g, DasAxis xAxis, DasAxis yAxis, ProgressMonitor mon) Render is called whenever the image needs to be refreshed or the content has changed.
void	setControl(java.lang.String s) set the control string which contains a number of properties.
void	setPeaksIndicator(StackedHistogramRenderer.PeaksIndicator peaksIndicator) Setter for property peaksIndicator.
void	setSliceRebinnedData(boolean sliceRebinnedData) Setter for property sliceRebinnedData.
void	setYAxis(DasAxis yAxis) This sets the yAxis and adds itself to the axis property change listener.
void	setZAxis(DasAxis zAxis)
void	setZTitle(java.lang.String title)
protected void	uninstallRenderer()
void	updatePlotImage(DasAxis xAxis, DasAxis yAxis_1, ProgressMonitor monitor) updatePlotImage is called once the expensive operation of loading the data is completed.

Methods inherited from class org.das2.graph.Renderer

acceptContext, acceptsDataSet, addPropertyChangeListener, addPropertyChangeListener, decodePlotSymbolControl, drawListIcon, encodeBooleanControl, encodeColorControl, encodePlotSymbolControl, formatControl, getAffineTransform, getBooleanControl, getColorBar, getColorControl, getConsumedDataSet, getControl, getDataLoader, getDataSet, getDataSetDescriptor, getDataSetID, getDatumControl, getDoubleArrayControl, getDoubleControl, getId, getIntegerControl, getLastException, getLegendLabel, getParent, getRenderCount, getTopDecorator, getUpdateCount, getXmemento, getYmemento, hasControl, incrementRenderCount, incrementUpdateCount, invalidateParentCacheImage, isActive, isDrawLegendLabel, isDumpDataSet, isTableDataSet, parseControl, refresh, refreshImage, removePropertyChangeListener, removePropertyChangeListener, renderException, resetCounters, setActive, setColorBar, setDataSet, setDataSetDescriptor, setDataSetID, setDataSetLoader, setDrawLegendLabel, setDumpDataSet, setException, setId, setLastException, setLegendLabel, setParent, setTopDecorator, setUpFont, setUpFont, update, updateCacheImage, updateImmediately

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.das2.dataset.DataSetConsumer

getConsumedDataSet

Methods inherited from interface org.das2.components.propertyeditor.Displayable

drawListIcon

Constructor Detail

StackedHistogramRenderer

public StackedHistogramRenderer(DasAxis zAxis)

StackedHistogramRenderer

public StackedHistogramRenderer(DasPlot parent,
                                DataSetDescriptor dsd,
                                DasAxis zAxis,
                                DasAxis yAxis)

Method Detail

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:

render

public void render(java.awt.Graphics g,
                   DasAxis xAxis,
                   DasAxis yAxis,
                   ProgressMonitor mon)

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

mon - a monitor for the operation. Note the render operation should be fast (<300ms).

installRenderer

protected void installRenderer()

Overrides:

installRenderer in class Renderer

uninstallRenderer

protected void uninstallRenderer()

Overrides:

uninstallRenderer in class Renderer

setZAxis

public void setZAxis(DasAxis zAxis)

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

setYAxis

public void setYAxis(DasAxis yAxis)

This sets the yAxis and adds itself to the axis property change listener. TODO: why must this Renderer be special and have a separate set y axis?

Parameters:

yAxis - the new yAxis

Throws:

java.lang.IllegalArgumentException - if the yAxis is not an instanceof DasLabelAxis

updatePlotImage

public void updatePlotImage(DasAxis xAxis,
                            DasAxis yAxis_1,
                            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_1 - 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

getZAxis

public DasAxis getZAxis()

Specified by:

getZAxis in interface TableDataSetConsumer

setZTitle

public void setZTitle(java.lang.String title)

getPeaksIndicator

public StackedHistogramRenderer.PeaksIndicator getPeaksIndicator()

Getter for property peaksIndicator.

Returns:

Value of property peaksIndicator.

setPeaksIndicator

public void setPeaksIndicator(StackedHistogramRenderer.PeaksIndicator peaksIndicator)

Setter for property peaksIndicator.

Parameters:

peaksIndicator - New value of property peaksIndicator.

isSliceRebinnedData

public boolean isSliceRebinnedData()

Getter for property sliceRebinnedData.

Returns:

Value of property sliceRebinnedData.

setSliceRebinnedData

public void setSliceRebinnedData(boolean sliceRebinnedData)

Setter for property sliceRebinnedData.

Parameters:

sliceRebinnedData - New value of property sliceRebinnedData.

getListLabel

public java.lang.String getListLabel()

Description copied from interface: Displayable

return a String that will help the user identify this item when choosing from a list.

Specified by:

getListLabel in interface Displayable

Overrides:

getListLabel in class Renderer

Returns:

the list label.

getListIcon

public javax.swing.Icon getListIcon()

Description copied from interface: Displayable

An icon can be provided that will be shown in a list along with the textual description of the element. This method should return null if there is no icon available, or a roughly 16x16 pixel icon.

Specified by:

getListIcon in interface Displayable

Overrides:

getListIcon in class Renderer

Returns:

the icon.