org.das2.graph

Class DasColorBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.das2.graph.DasCanvasComponent

org.das2.graph.DasAxis

org.das2.graph.DasColorBar

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, Editable, DataRangeSelectionListener, TimeRangeSelectionListener

public class DasColorBar
extends DasAxis

Axis that converts to RGB color instead of horizontal or vertical position.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DasColorBar.ColorBarLayoutManager TODO: Ed document me
static class	DasColorBar.Type enumeration of the types of colorbars.

Nested classes/interfaces inherited from class org.das2.graph.DasAxis

DasAxis.AxisLayoutManager, DasAxis.Lock, DasAxis.Memento

Nested classes/interfaces inherited from class org.das2.graph.DasCanvasComponent

DasCanvasComponent.CanvasComponentAction

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_SHOWCOLORBAR
static java.lang.String	PROP_SPECIALCOLORS
static java.lang.String	PROPERTY_FILL_COLOR handle for the property fillColor.
static java.lang.String	PROPERTY_TYPE handle for the property "type".

Fields inherited from class org.das2.graph.DasAxis

axisLabel, BOTTOM, dataRange, datumFormatter, dividerDatumFormatter, enableHistory, flipLabel, formatString, HORIZONTAL, LEFT, majorTicksDomainDivider, MAX_TCA_LINES, minorTicksDomainDivider, primaryInputPanel, PROP_AXISOFFSET, PROP_BOUNDS, PROP_DIVIDERDATUMFORMATTER, PROP_ENABLEHISTORY, PROP_FLIPLABEL, PROP_FLIPPED, PROP_FONTSIZE, PROP_FORMATSTRING, PROP_LABEL, PROP_LINETHICKNESS, PROP_LOCKDOMAINDIVIDER, PROP_LOG, PROP_MAJORTICKSDOMAINDIVIDER, PROP_MINORTICKSDOMAINDIVIDER, PROP_OPPOSITE_AXIS_VISIBLE, PROP_REFERENCE, PROP_SCAN_RANGE, PROP_TCALABELS, PROP_TCAROWS, PROP_TICKVALUES, PROP_UNITS, PROP_USEDOMAINDIVIDER, PROPERTY_DATUMRANGE, PROPERTY_TICKS, RIGHT, secondaryInputPanel, tickV, TOP, useDomainDivider, VERTICAL

Fields inherited from class org.das2.graph.DasCanvasComponent

mouseAdapter, PROP_OPAQUEBACKGROUND, PROPERTIES_ACTION

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
DasColorBar(Datum min, Datum max, boolean log) Create an color bar object, relating data and color.
DasColorBar(Datum min, Datum max, int orientation, boolean log) Create an color bar object, relating data and color.

Method Summary

Modifier and Type	Method and Description
java.awt.Shape	getActiveRegion() get the region containing the axis.
java.awt.Rectangle	getAxisBounds() Calculate the rectangle that bounds the axis including its labels.
static DasColumn	getColorBarColumn(DasColumn column) return a column suitable for the colorbar, based on the spectrogram column.
java.awt.Color	getFillColor() get the color used to indicate fill, often gray or a transparent white.
int	getFillColorIndex() return the index of the fill color in the indexed color model.
java.awt.image.IndexColorModel	getIndexColorModel() return the color model so that indexed color model can be used.
java.lang.String	getSpecialColors()
DasColorBar.Type	getType() return the type of colorbar (e.g.
int	indexColorTransform(double data, Units units) convert the double to an indexed color.
boolean	isShowColorBar()
protected void	paintComponent(java.awt.Graphics g) paints the axis component.
int	rgbTransform(double data, Units units) convert the double to an RGB color.
void	setFillColor(java.awt.Color fillColor) set the color used to indicate fill, often gray or a transparent white.
void	setShowColorBar(boolean showColorBar) when set to false, this is basically an ordinary axis.
void	setSpecialColors(java.lang.String specialColors) set this to a comma-delineated list of name:value pairs,
void	setType(DasColorBar.Type type) set the type of colorbar

Methods inherited from class org.das2.graph.DasAxis

addMouseListener, addMouseMotionListener, addMouseWheelListener, addTickV, addTimeRangeSelectionListener, addToFavorites, attachTo, clearHistory, clone, createAttachedAxis, createAttachedAxis, dataRangeSelected, detach, deviceRangeChanged, drawLabel, findTick, getAffineTransform, getAxisOffset, getAxisOffsetPixels, getDataMaximum, getDataMaximum, getDataMinimum, getDataMinimum, getDataPath, getDataRange, getDatumFormatter, getDatumRange, getDevicePosition, getDividerDatumFormatter, getDLength, getDrawTca, getFontSize, getFormat, getLabel, getLabelBounds, getLabelFont, getLabelOffset, getLineSpacing, getLineThickness, getMajorTicksDomainDivider, getMasterAxis, getMaxLabelWidth, getMemento, getMinorTicksDomainDivider, getOrientation, getRange, getReference, getScanRange, getTcaLabels, getTcaRows, getTickDirection, getTickLabelFont, getTickLength, getTickLines, getTickV, getTickValues, getTitlePositionOffset, getUnits, getUserDatumFormatter, installComponent, invTransform, invTransform, isAnimated, isAttached, isDrawTca, isEnableHistory, isFlipLabel, isFlipped, isHorizontal, isLockDomainDivider, isLog, isOppositeAxisVisible, isTcaLoaded, isTickLabelsVisible, isUseDomainDivider, mutatorLock, paintHorizontalAxis, paintVerticalAxis, processEvent, rangeIsAcceptable, removeFromFavorites, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeTimeRangeSelectionListener, repaint, resetRange, resetTickV, resize, scanNext, scanPrevious, setAnimated, setAxisOffset, setDataMaximum, setDataMinimum, setDataPath, setDataRange, setDataRangeForward, setDataRangePrev, setDataRangeZoomOut, setDatumRange, setDividerDatumFormatter, setDrawTca, setEnableHistory, setFlipLabel, setFlipped, setFontSize, setFormat, setLabel, setLabelOffset, setLeftXLabelOverride, setLineThickness, setLockDomainDivider, setLog, setMajorTicksDomainDivider, setMinorTicksDomainDivider, setNextAction, setNextActionLabel, setOppositeAxisVisible, setOrientation, setPlot, setPreviousAction, setPreviousActionLabel, setReference, setScanRange, setTcaFunction, setTcaLabels, setTcaRows, setTickLabelsVisible, setTickLength, setTickV, setTickV, setTickValues, setUnits, setUseDomainDivider, setUserDatumFormatter, setVisible, tickFormatter, tickFormatter, timeRangeSelected, toString, transform, transform, transform, transform, transform, transformFast, uninstallComponent, updateImmediately, updateTickV, updateTickVManualTicks, valueIsAdjusting

Methods inherited from class org.das2.graph.DasCanvasComponent

acceptContext, addMouseModule, coalesceEvents, getActions, getCanvas, getColumn, getDasMouseInputAdapter, getDasName, getEmSize, getFont, getLineThicknessDouble, getRow, isOpaqueBackground, processDasUpdateEvent, removeMouseModule, setColumn, setDasName, setOpaqueBackground, setRow, showProperties, update

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_TYPE

public static final java.lang.String PROPERTY_TYPE

handle for the property "type".

See Also:

Constant Field Values

PROPERTY_FILL_COLOR

public static final java.lang.String PROPERTY_FILL_COLOR

handle for the property fillColor.

See Also:

Constant Field Values

PROP_SPECIALCOLORS

public static final java.lang.String PROP_SPECIALCOLORS

See Also:

Constant Field Values

PROP_SHOWCOLORBAR

public static final java.lang.String PROP_SHOWCOLORBAR

See Also:

Constant Field Values

Constructor Detail

DasColorBar

public DasColorBar(Datum min,
                   Datum max,
                   boolean log)

Create an color bar object, relating data and color.

Parameters:

min - the minimum value

max - the maximum value

log - if true then the axis is a log axis.

DasColorBar

public DasColorBar(Datum min,
                   Datum max,
                   int orientation,
                   boolean log)

Create an color bar object, relating data and color.

Parameters:

min - the minimum value

max - the maximum value

orientation - the position relative to a plot, one of DasAxis.TOP, DasAxis.BOTTOM, DasAxis.LEFT, DasAxis.RIGHT.

log - if true then the axis is a log axis.

Method Detail

getSpecialColors

public java.lang.String getSpecialColors()

setSpecialColors

public void setSpecialColors(java.lang.String specialColors)

set this to a comma-delineated list of name:value pairs,

Parameters:

specialColors -

rgbTransform

public int rgbTransform(double data,
                        Units units)

convert the double to an RGB color.

Parameters:

data - a data value

units - the units of the given data value.

Returns:

the combined RGB components

See Also:

Color(int)

indexColorTransform

public int indexColorTransform(double data,
                               Units units)

convert the double to an indexed color.

Parameters:

data - a data value

units - the units of the given data value.

Returns:

the index into the color table.

See Also:

getIndexColorModel()

getIndexColorModel

public java.awt.image.IndexColorModel getIndexColorModel()

return the color model so that indexed color model can be used.

Returns:

the color model

getFillColorIndex

public int getFillColorIndex()

return the index of the fill color in the indexed color model.

Returns:

the index of the fill color

getType

public DasColorBar.Type getType()

return the type of colorbar (e.g. DasColorBar.Type.GRAYSCALE or DasColorBar.Type.APL_RAINBOW_BLACK0)

Returns:

the type of colorbar

setType

public final void setType(DasColorBar.Type type)

set the type of colorbar

Parameters:

type - type of colorbar (e.g. DasColorBar.Type.GRAYSCALE or DasColorBar.Type.APL_RAINBOW_BLACK0)

paintComponent

protected void paintComponent(java.awt.Graphics g)

Description copied from class: DasAxis

paints the axis component. The tickV's and bounds should be calculated at this point

Overrides:

paintComponent in class DasAxis

Parameters:

g - the graphics context.

getAxisBounds

public java.awt.Rectangle getAxisBounds()

Description copied from class: DasAxis

Calculate the rectangle that bounds the axis including its labels. When the axis is drawn on both sides of the plot, this rectangle will extend across the plot.

Overrides:

getAxisBounds in class DasAxis

Returns:

Rectangle containing the axes and its labels.

getColorBarColumn

public static DasColumn getColorBarColumn(DasColumn column)

return a column suitable for the colorbar, based on the spectrogram column.

Parameters:

column - the column for the spectrogram described.

Returns:

the new column.

getActiveRegion

public java.awt.Shape getActiveRegion()

Description copied from class: DasAxis

get the region containing the axis.

Overrides:

getActiveRegion in class DasAxis

Returns:

the region containing the axis.

isShowColorBar

public boolean isShowColorBar()

setShowColorBar

public void setShowColorBar(boolean showColorBar)

when set to false, this is basically an ordinary axis. Autoplot uses this to support StackedHistogram mode.

Parameters:

showColorBar - true if the colorbar should be drawn.

getFillColor

public java.awt.Color getFillColor()

get the color used to indicate fill, often gray or a transparent white. Note all instances use the same fillColor.

Returns:

the fill color.

setFillColor

public void setFillColor(java.awt.Color fillColor)

set the color used to indicate fill, often gray or a transparent white. Note all instances use the same fillColor.

Parameters:

fillColor - the new fill color.