DasAxis

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - org.das2.graph.DasCanvasComponent
      - org.das2.graph.DasAxis

All Implemented Interfaces:

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

Direct Known Subclasses:

DasColorBar, DasLabelAxis
```
public class DasAxis
extends DasCanvasComponent
implements DataRangeSelectionListener, TimeRangeSelectionListener, java.lang.Cloneable
```
One dimensional axis component that transforms data to device space and back, and provides controls for navigating the 1-D data space.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`DasAxis.AxisLayoutManager`
`static interface`	`DasAxis.Lock` until we switch to java 1.5, use this lock object instead of java.util.concurrent.lock
`static class`	`DasAxis.Memento` class for storing an axis transform.

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
`protected java.lang.String`	`axisLabel`
`static int`	`BOTTOM` This value indicates that the axis should be located at the bottom of its cell
`protected DataRange`	`dataRange`
`protected DatumFormatter`	`datumFormatter`
`protected DatumFormatter`	`dividerDatumFormatter` the formatter identified to work with the divider
`protected boolean`	`enableHistory` true if the axis built-in history is enabled.
`protected boolean`	`flipLabel` true means flip the right label so all vertical labels are facing the same direction.
`protected java.lang.String`	`formatString` the formatString, or "" if default behavior.
`static int`	`HORIZONTAL` This value indicates that the axis should be oriented horizontally
`static int`	`LEFT` This value indicates that the axis should be located to the left of its cell
`protected DomainDivider`	`majorTicksDomainDivider`
`static int`	`MAX_TCA_LINES`
`protected DomainDivider`	`minorTicksDomainDivider`
`protected javax.swing.JPanel`	`primaryInputPanel`
`static java.lang.String`	`PROP_AXISOFFSET`
`static java.lang.String`	`PROP_BOUNDS`
`static java.lang.String`	`PROP_DIVIDERDATUMFORMATTER`
`static java.lang.String`	`PROP_ENABLEHISTORY` true if the axis built-in history is enabled.
`static java.lang.String`	`PROP_FLIPLABEL`
`static java.lang.String`	`PROP_FLIPPED`
`static java.lang.String`	`PROP_FONTSIZE`
`static java.lang.String`	`PROP_FORMATSTRING`
`static java.lang.String`	`PROP_LABEL`
`static java.lang.String`	`PROP_LINETHICKNESS`
`static java.lang.String`	`PROP_LOCKDOMAINDIVIDER`
`static java.lang.String`	`PROP_LOG`
`static java.lang.String`	`PROP_MAJORTICKSDOMAINDIVIDER`
`static java.lang.String`	`PROP_MINORTICKSDOMAINDIVIDER`
`static java.lang.String`	`PROP_OPPOSITE_AXIS_VISIBLE`
`static java.lang.String`	`PROP_REFERENCE`
`static java.lang.String`	`PROP_SCAN_RANGE`
`static java.lang.String`	`PROP_TCALABELS`
`static java.lang.String`	`PROP_TCAROWS`
`static java.lang.String`	`PROP_TICKVALUES`
`static java.lang.String`	`PROP_UNITS`
`static java.lang.String`	`PROP_USEDOMAINDIVIDER`
`static java.lang.String`	`PROPERTY_DATUMRANGE`
`static java.lang.String`	`PROPERTY_TICKS`
`static int`	`RIGHT` This value indicates that the axis should be located to the right of its cell
`protected javax.swing.JPanel`	`secondaryInputPanel`
`protected TickVDescriptor`	`tickV`
`static int`	`TOP` This value indicates that the axis should be located at the top of its cell
`protected boolean`	`useDomainDivider`
`static int`	`VERTICAL` This value indicates that the axis should be oriented vertically

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
Modifier	Constructor and Description
`protected`	`DasAxis(DataRange range, int orientation)` Create an axis object, relating data and canvas pixel coordinates.
	`DasAxis(Datum min, Datum max, int orientation)` Create an axis object, relating data and canvas pixel coordinates.
	`DasAxis(Datum min, Datum max, int orientation, boolean log)` Create an axis object, relating data and canvas pixel coordinates.
	`DasAxis(DatumRange range, int orientation)` Create an axis object, relating data and canvas pixel coordinates.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addMouseListener(java.awt.event.MouseListener l)` add mouse wheel listener.
`void`	`addMouseMotionListener(java.awt.event.MouseMotionListener l)` add mouse motion listener.
`void`	`addMouseWheelListener(java.awt.event.MouseWheelListener l)` Adds a MouseWheelListener to the DasAxis.
`void`	`addTickV(Datum majorTick)` add the tick to the current set of major ticks.
`void`	`addTimeRangeSelectionListener(TimeRangeSelectionListener listener)` Registers TimeRangeSelectionListener to receive events.
`void`	`addToFavorites(DatumRange range)` add the range to the favorites list, which is accessible from the popup-menu.
`void`	`attachTo(DasAxis axis)` attach the axis to another axis, so they will both show the same range, as with a stack of time axes or with a slice.
`void`	`clearHistory()` clear the internal history.
`java.lang.Object`	`clone()`
`DasAxis`	`createAttachedAxis()` create another axis that follows this axis.
`DasAxis`	`createAttachedAxis(int orientation)` create another axis that follows this axis.
`void`	`dataRangeSelected(DataRangeSelectionEvent e)` target event handlers to reset the axis bounds.
`void`	`detach()` disconnect this from the common DataRange object that ties this to other axes, and create a new DataRange.
`protected void`	`deviceRangeChanged()` Deprecated. this is not used.
`protected void`	`drawLabel(java.awt.Graphics2D g, Datum value, java.lang.String label, int index, int x, int y)` Draw each label of the axis.
`Datum`	`findTick(Datum xDatum, double direction, boolean minor)` Deprecated. Use getTickVDescriptor.findTick
`java.awt.Shape`	`getActiveRegion()` get the region containing the axis.
`java.awt.geom.AffineTransform`	`getAffineTransform(DasAxis.Memento memento, java.awt.geom.AffineTransform at)` return the AffineTransform, or null.
`java.awt.Rectangle`	`getAxisBounds()` Calculate the rectangle that bounds the axis including its labels.
`java.lang.String`	`getAxisOffset()`
`protected int`	`getAxisOffsetPixels()` return the offset of the axis from the plot, as specified by the axisOffset property.
`Datum`	`getDataMaximum()` return the maximum value
`double`	`getDataMaximum(Units units)` get the bigger extent of the range of this axis, in the given units.
`Datum`	`getDataMinimum()` return the minimum value
`double`	`getDataMinimum(Units units)` get the smaller extent of the range of this axis, in the given units.
`java.lang.String`	`getDataPath()` return the path for the TCA dataset.
`DataRange`	`getDataRange()` return the mutable DataRange object.
`DatumFormatter`	`getDatumFormatter()` return the formatter which converts Datum tick positions to a string.
`DatumRange`	`getDatumRange()` return the current range
`int`	`getDevicePosition()` Deprecated. this should not be used.
`DatumFormatter`	`getDividerDatumFormatter()`
`int`	`getDLength()` return the length of the axis in pixels.
`boolean`	`getDrawTca()` Deprecated. use isDrawTca()
`java.lang.String`	`getFontSize()`
`java.lang.String`	`getFormat()` return the format string for each tick.
`java.lang.String`	`getLabel()` get the label for the axis.
`protected java.awt.Rectangle`	`getLabelBounds(java.awt.Rectangle bounds)` calculate the bounds of the labels.
`java.awt.Font`	`getLabelFont()` get the font for labels.
`java.lang.String`	`getLabelOffset()`
`int`	`getLineSpacing()` calculate the spacing (whitespace) between the TCA items.
`java.lang.String`	`getLineThickness()`
`DomainDivider`	`getMajorTicksDomainDivider()` return the domain divider for major ticks, or null.
`DasAxis`	`getMasterAxis()` return the axis this is attached to.
`protected int`	`getMaxLabelWidth(java.awt.FontMetrics fm)` Deprecated. use getMaxLabelWidth()
`DasAxis.Memento`	`getMemento()` get the memento object which identifies the state of the axis transformation.
`DomainDivider`	`getMinorTicksDomainDivider()` return the domain divider for minor ticks, or null.
`int`	`getOrientation()` returns the orientation of the axis, which is one of BOTTOM,TOP,LEFT or RIGHT.
`DatumRange`	`getRange()` Deprecated. use getDatumRange instead.
`java.lang.String`	`getReference()`
`DatumRange`	`getScanRange()` get the limit the scan buttons, which may be null.
`java.lang.String`	`getTcaLabels()`
`int`	`getTcaRows()` the explicit number of TCA rows used to allocate space (not including time location).
`int`	`getTickDirection()` return the tick direction, 1=down or left, -1=up or right
`java.awt.Font`	`getTickLabelFont()` get the font for tick labels.
`java.lang.String`	`getTickLength()` get the tick length string, for example "0.66em"
`int`	`getTickLines()` return the number of lines that the ticks use, considering the ephemeris (TCAs) loaded.
`TickVDescriptor`	`getTickV()` return the current set of ticks.
`java.lang.String`	`getTickValues()`
`protected int`	`getTitlePositionOffset()` get the offset of the label from the baseline in pixels.
`Units`	`getUnits()` return the units of the axis.
`DatumFormatter`	`getUserDatumFormatter()` get the userDatumFormatter, which converts Datums into Strings.
`protected void`	`installComponent()` perform actions necessary when starting the component, such as handling TCA.
`Datum`	`invTransform(double idata)` return the data location for the given pixel position.
`DatumRange`	`invTransform(double idata1, double idata2)` get the range covered by the two points.
`boolean`	`isAnimated()` true if the axis is animated.
`boolean`	`isAttached()` return true if this is attached to another axis.
`boolean`	`isDrawTca()` true if additional tick labels are drawn using the TCA function.
`boolean`	`isEnableHistory()` true if the axis built-in history is enabled.
`boolean`	`isFlipLabel()` true if the right vertical label should be flipped.
`boolean`	`isFlipped()` return true if the axis is flipped.
`boolean`	`isHorizontal()` test if the axis is horizontal.
`boolean`	`isLockDomainDivider()`
`boolean`	`isLog()` return true if the axis is log.
`boolean`	`isOppositeAxisVisible()` return true if the opposite side is also drawn.
`boolean`	`isTcaLoaded()` true if the TCA data has been loaded and the axis bounds reflect TCA data present.
`boolean`	`isTickLabelsVisible()` true if the tick labels should be drawn.
`boolean`	`isUseDomainDivider()` true if the domain divider should be used.
`DasAxis.Lock`	`mutatorLock()` get an object to lock the axis for multiple operations.
`protected void`	`paintComponent(java.awt.Graphics graphics)` paints the axis component.
`protected void`	`paintHorizontalAxis(java.awt.Graphics2D g)` Paint the axis if it is horizontal
`protected void`	`paintVerticalAxis(java.awt.Graphics2D g)` Paint the vertical axis
`protected void`	`processEvent(java.awt.AWTEvent e)` Processes events occurring on this component.
`protected boolean`	`rangeIsAcceptable(DatumRange dr)`
`void`	`removeFromFavorites(DatumRange range)` remove the range from the favorites list, which is accessible from the popup-menu.
`void`	`removeMouseListener(java.awt.event.MouseListener l)` remove mouse motion listener.
`void`	`removeMouseMotionListener(java.awt.event.MouseMotionListener l)` remove mouse motion listener.
`void`	`removeMouseWheelListener(java.awt.event.MouseWheelListener l)` remove mouse wheel listener.
`void`	`removeTimeRangeSelectionListener(TimeRangeSelectionListener listener)` Removes TimeRangeSelectionListener from the list of listeners.
`void`	`repaint()`
`void`	`resetRange(DatumRange range)` set the axis to the new range, allowing the units to change.
`protected void`	`resetTickV(TickVDescriptor ticks)` call-back for TickMaster
`void`	`resize()` reset bounds (and unused transform), invalidate the tickV, etc.
`void`	`scanNext()` scan to the next interval.
`void`	`scanPrevious()` scan to the previous interval.
`void`	`setAnimated(boolean animated)` if true then the axis will be animated.
`void`	`setAxisOffset(java.lang.String axisOffset)` set the offset of the axis from the plot.
`void`	`setDataMaximum(Datum max)` set the bigger extent of the range of this axis.
`void`	`setDataMinimum(Datum min)` set the smaller extent of the range of this axis.
`void`	`setDataPath(java.lang.String dataset)`
`void`	`setDataRange(Datum minimum, Datum maximum)` Set the data range.
`void`	`setDataRangeForward()` set the range to the next interval.
`void`	`setDataRangePrev()` set the range to the previous interval.
`void`	`setDataRangeZoomOut()` set the range to min-width to max+width.
`void`	`setDatumRange(DatumRange dr)` Set the range for the axis.
`void`	`setDividerDatumFormatter(DatumFormatter dividerDatumFormatter)`
`void`	`setDrawTca(boolean b)` if true then turn on additional tick labels using the TCA function.
`void`	`setEnableHistory(boolean enableHistory)` true if the axis built-in history is enabled.
`void`	`setFlipLabel(boolean flipLabel)` true if the right vertical label should be flipped.
`void`	`setFlipped(boolean b)` flip over the axis.
`void`	`setFontSize(java.lang.String fontSize)`
`void`	`setFormat(java.lang.String formatString)` set a hint at the format string.
`void`	`setLabel(java.lang.String t)` set the label for the axis.
`void`	`setLabelOffset(java.lang.String spec)` explicitly set the position of the label from the axis.
`void`	`setLeftXLabelOverride(int leftXOverride)` Deprecated. use setLabelOffset instead.
`void`	`setLineThickness(java.lang.String lineThickness)` set the thickness of the lines drawn.
`void`	`setLockDomainDivider(boolean lockDomainDivider)` don't allow the domain divider to adjust.
`void`	`setLog(boolean log)` Set the axis to be log or linear.
`void`	`setMajorTicksDomainDivider(DomainDivider majorTicksDomainDivider)`
`void`	`setMinorTicksDomainDivider(DomainDivider minorTicksDomainDivider)`
`void`	`setNextAction(java.lang.String label, javax.swing.AbstractAction abstractAction)` set the action for the next button
`void`	`setNextActionLabel(java.lang.String label, java.lang.String tooltip)` set the label for the popup button
`void`	`setOppositeAxisVisible(boolean visible)` if true, then the axis and its ticks on the opposite side will also be drawn.
`void`	`setOrientation(int orientation)` Set the axis orientation.
`void`	`setPlot(DasPlot p)` set the plot that will get updates
`void`	`setPreviousAction(java.lang.String label, javax.swing.AbstractAction abstractAction)` set the action for the prev button
`void`	`setPreviousActionLabel(java.lang.String label, java.lang.String tooltip)` set the label for the popup button
`void`	`setReference(java.lang.String reference)` draw an optional reference line at the location.
`void`	`setScanRange(DatumRange range)` limit the scan buttons to operate within this range.
`void`	`setTcaFunction(QFunction f)` Add auxiliary data to an axis (usually OrbitAttitude data for a time axis).
`void`	`setTcaLabels(java.lang.String tcaLabels)` set the TCA data labels explicitly, using a semi-colon delimited list of labels.
`void`	`setTcaRows(int tcaRows)` the explicit number of additional TCA rows used to allocate space (not including time location).
`void`	`setTickLabelsVisible(boolean b)` set true if the tick labels should be drawn.
`void`	`setTickLength(java.lang.String tickLengthStr)` set the tick length string, for example "0.33em" "5px" "-0.33em"
`void`	`setTickV(double[] minorTicks, double[] majorTicks)` convenience method for manually setting the ticks so the user needn't understand TickVDescriptor.
`void`	`setTickV(TickVDescriptor tickV)` Sets the TickVDescriptor for this axis.
`void`	`setTickValues(java.lang.String ticks)` manually set the tick positions or spacing.
`void`	`setUnits(Units newUnits)` set the units of the axis, which must be convertible from the old units.
`void`	`setUseDomainDivider(boolean useDomainDivider)` true if the domain divider should be used.
`void`	`setUserDatumFormatter(DatumFormatter userDatumFormatter)` set the userDatumFormatter, which converts Datums into Strings.
`void`	`setVisible(boolean aFlag)` set the component visible or invisible.
`protected java.lang.String`	`tickFormatter(Datum d)` return a label for this datum and visible range.
`protected java.lang.String[]`	`tickFormatter(DatumVector tickV, DatumRange datumRange)` return the tick labels for these datums and visible range.
`void`	`timeRangeSelected(TimeRangeSelectionEvent e)` call back for time range selection event.
`java.lang.String`	`toString()`
`double`	`transform(Datum datum)` Transforms a Datum in data coordinates to a horizontal or vertical position on the parent canvas.
`double`	`transform(double data, Units units)` Transforms a double in the given units in data coordinates to a horizontal or vertical position on the parent canvas.
`protected double`	`transform(double data, Units units, int dmin, int dmax)` Transforms a double in the given units in data coordinates to a horizontal or vertical position on the parent canvas.
`double`	`transform(QDataSet data)` Transforms the rank 0 dataset a horizontal or vertical position on the parent canvas.
`double`	`transform(QDataSet data, Units units)` Transforms the rank 0 dataset a horizontal or vertical position on the parent canvas.
`protected double`	`transformFast(double data, Units units)` this was never utilized, but at_m and at_b could be used to speed up transformation.
`protected void`	`uninstallComponent()` remove the component row and column update listener.
`protected void`	`updateImmediately()` reset the transform and update the tick locations.
`protected void`	`updateTickV()` recalculate the tick positions.
`protected void`	`updateTickVManualTicks(java.lang.String lticks)`
`boolean`	`valueIsAdjusting()` true if a lock is out and an object is rapidly mutating the object.

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
- PROP_LABEL
```
public static final java.lang.String PROP_LABEL
```
  See Also:
  
  Constant Field Values
- PROP_LOG
```
public static final java.lang.String PROP_LOG
```
  See Also:
  
  Constant Field Values
- PROP_OPPOSITE_AXIS_VISIBLE
```
public static final java.lang.String PROP_OPPOSITE_AXIS_VISIBLE
```
  See Also:
  
  Constant Field Values
- PROP_BOUNDS
```
public static final java.lang.String PROP_BOUNDS
```
  See Also:
  
  Constant Field Values
- PROP_SCAN_RANGE
```
public static final java.lang.String PROP_SCAN_RANGE
```
  See Also:
  
  Constant Field Values
- PROP_UNITS
```
public static final java.lang.String PROP_UNITS
```
  See Also:
  
  Constant Field Values
- PROPERTY_TICKS
```
public static final java.lang.String PROPERTY_TICKS
```
  See Also:
  
  Constant Field Values
- MAX_TCA_LINES
```
public static final int MAX_TCA_LINES
```
  See Also:
  
  Constant Field Values
- TOP
```
public static final int TOP
```
  This value indicates that the axis should be located at the top of its cell
  
  See Also:
  
  Constant Field Values
- BOTTOM
```
public static final int BOTTOM
```
  This value indicates that the axis should be located at the bottom of its cell
  
  See Also:
  
  Constant Field Values
- LEFT
```
public static final int LEFT
```
  This value indicates that the axis should be located to the left of its cell
  
  See Also:
  
  Constant Field Values
- RIGHT
```
public static final int RIGHT
```
  This value indicates that the axis should be located to the right of its cell
  
  See Also:
  
  Constant Field Values
- HORIZONTAL
```
public static final int HORIZONTAL
```
  This value indicates that the axis should be oriented horizontally
  
  See Also:
  
  Constant Field Values
- VERTICAL
```
public static final int VERTICAL
```
  This value indicates that the axis should be oriented vertically
  
  See Also:
  
  Constant Field Values
- dataRange
```
protected DataRange dataRange
```
- axisLabel
```
protected java.lang.String axisLabel
```
- tickV
```
protected TickVDescriptor tickV
```
- datumFormatter
```
protected DatumFormatter datumFormatter
```
- primaryInputPanel
```
protected javax.swing.JPanel primaryInputPanel
```
- secondaryInputPanel
```
protected javax.swing.JPanel secondaryInputPanel
```
- PROPERTY_DATUMRANGE
```
public static final java.lang.String PROPERTY_DATUMRANGE
```
  See Also:
  
  Constant Field Values
- enableHistory
```
protected boolean enableHistory
```
  true if the axis built-in history is enabled.
- PROP_ENABLEHISTORY
```
public static final java.lang.String PROP_ENABLEHISTORY
```
  true if the axis built-in history is enabled.
  
  See Also:
  
  Constant Field Values
- PROP_REFERENCE
```
public static final java.lang.String PROP_REFERENCE
```
  See Also:
  
  Constant Field Values
- PROP_TCAROWS
```
public static final java.lang.String PROP_TCAROWS
```
  See Also:
  
  Constant Field Values
- PROP_TCALABELS
```
public static final java.lang.String PROP_TCALABELS
```
  See Also:
  
  Constant Field Values
- PROP_TICKVALUES
```
public static final java.lang.String PROP_TICKVALUES
```
  See Also:
  
  setTickValues(java.lang.String), Constant Field Values
- PROP_AXISOFFSET
```
public static final java.lang.String PROP_AXISOFFSET
```
  See Also:
  
  Constant Field Values
- PROP_FONTSIZE
```
public static final java.lang.String PROP_FONTSIZE
```
  See Also:
  
  Constant Field Values
- PROP_LINETHICKNESS
```
public static final java.lang.String PROP_LINETHICKNESS
```
  See Also:
  
  Constant Field Values
- PROP_FLIPPED
```
public static final java.lang.String PROP_FLIPPED
```
  See Also:
  
  Constant Field Values
- formatString
```
protected java.lang.String formatString
```
  the formatString, or "" if default behavior.
- PROP_FORMATSTRING
```
public static final java.lang.String PROP_FORMATSTRING
```
  See Also:
  
  Constant Field Values
- flipLabel
```
protected boolean flipLabel
```
  true means flip the right label so all vertical labels are facing the same direction.
- PROP_FLIPLABEL
```
public static final java.lang.String PROP_FLIPLABEL
```
  See Also:
  
  Constant Field Values
- dividerDatumFormatter
```
protected DatumFormatter dividerDatumFormatter
```
  the formatter identified to work with the divider
- PROP_DIVIDERDATUMFORMATTER
```
public static final java.lang.String PROP_DIVIDERDATUMFORMATTER
```
  See Also:
  
  Constant Field Values
- minorTicksDomainDivider
```
protected DomainDivider minorTicksDomainDivider
```
- PROP_MINORTICKSDOMAINDIVIDER
```
public static final java.lang.String PROP_MINORTICKSDOMAINDIVIDER
```
  See Also:
  
  Constant Field Values
- majorTicksDomainDivider
```
protected DomainDivider majorTicksDomainDivider
```
- PROP_MAJORTICKSDOMAINDIVIDER
```
public static final java.lang.String PROP_MAJORTICKSDOMAINDIVIDER
```
  See Also:
  
  Constant Field Values
- useDomainDivider
```
protected boolean useDomainDivider
```
- PROP_USEDOMAINDIVIDER
```
public static final java.lang.String PROP_USEDOMAINDIVIDER
```
  See Also:
  
  Constant Field Values
- PROP_LOCKDOMAINDIVIDER
```
public static final java.lang.String PROP_LOCKDOMAINDIVIDER
```
  See Also:
  
  Constant Field Values

Constructor Detail
- DasAxis
```
public DasAxis(Datum min,
               Datum max,
               int orientation)
```
  Create an axis object, relating data and canvas pixel coordinates.
  
  Parameters:
  
  min - the minimum value
  
  max - the maximum value
  
  orientation - DasAxis.TOP, DasAxis.BOTTOM, DasAxis.LEFT, DasAxis.RIGHT.
- DasAxis
```
public DasAxis(DatumRange range,
               int orientation)
```
  Create an axis object, relating data and canvas pixel coordinates.
  
  Parameters:
  
  range - the initial range for the axis.
  
  orientation - the position relative to a plot, one of DasAxis.TOP, DasAxis.BOTTOM, DasAxis.LEFT, DasAxis.RIGHT.
- DasAxis
```
public DasAxis(Datum min,
               Datum max,
               int orientation,
               boolean log)
```
  Create an axis object, relating data and canvas pixel coordinates.
  
  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.
- DasAxis
```
protected DasAxis(DataRange range,
                  int orientation)
```
  Create an axis object, relating data and canvas pixel coordinates.
  
  Parameters:
  
  range - the range object allowing connections between axes. A DataRange is a mutable object.
  
  orientation - the position relative to a plot, one of DasAxis.TOP, DasAxis.BOTTOM, DasAxis.LEFT, DasAxis.RIGHT

Method Detail

getUserDatumFormatter
```
public DatumFormatter getUserDatumFormatter()
```
get the userDatumFormatter, which converts Datums into Strings. This can be null if none should be used.

Returns:

the userDatumFormatter.

setUserDatumFormatter
```
public void setUserDatumFormatter(DatumFormatter userDatumFormatter)
```
set the userDatumFormatter, which converts Datums into Strings. This can be null if none should be used.

Parameters:

userDatumFormatter - the userDatumFormatter.

setNextAction
```
public void setNextAction(java.lang.String label,
                          javax.swing.AbstractAction abstractAction)
```
set the action for the next button

Parameters:

label - the label (step or scan)

abstractAction - the action to invoke.

setPreviousAction

public void setPreviousAction(java.lang.String label,
                              javax.swing.AbstractAction abstractAction)

set the action for the prev button

Parameters:: label - the label (step or scan); abstractAction - the action to invoke.

addToFavorites
```
public void addToFavorites(DatumRange range)
```
add the range to the favorites list, which is accessible from the popup-menu.

Parameters:

range - the range to add.

removeFromFavorites
```
public void removeFromFavorites(DatumRange range)
```
remove the range from the favorites list, which is accessible from the popup-menu.

Parameters:

range - the range to add.

isEnableHistory
```
public boolean isEnableHistory()
```
true if the axis built-in history is enabled.

Returns:

true if the axis built-in history is enabled.

setEnableHistory
```
public void setEnableHistory(boolean enableHistory)
```
true if the axis built-in history is enabled.

Parameters:

enableHistory - true if the axis built-in history is enabled.

setOrientation
```
public void setOrientation(int orientation)
```
Set the axis orientation. One of: DasAxis.TOP, DasAxis.BOTTOM, DasAxis.LEFT, DasAxis.RIGHT

Parameters:

orientation - the orientation, one of TOP,BOTTOM,LEFT,RIGHT.

See Also:

TOP, BOTTOM, LEFT, RIGHT

setDatumRange
```
public void setDatumRange(DatumRange dr)
```
Set the range for the axis. Note this is allowed to change the units as well.

Parameters:

dr - the new range. The range must be interval or ratio measurements.

getDatumRange
```
public DatumRange getDatumRange()
```
return the current range

Returns:

the current range

rangeIsAcceptable

protected boolean rangeIsAcceptable(DatumRange dr)

setDataRange
```
public void setDataRange(Datum minimum,
                         Datum maximum)
```
Set the data range. minimum must be less than maximum, but for nominal data they can be equal.

Parameters:

minimum - the minimum value

maximum - the maximum value

clearHistory
```
public void clearHistory()
```
clear the internal history.

setDataRangePrev
```
public void setDataRangePrev()
```
set the range to the previous interval.

setDataRangeForward
```
public void setDataRangeForward()
```
set the range to the next interval.

setDataRangeZoomOut
```
public void setDataRangeZoomOut()
```
set the range to min-width to max+width.

getDataRange
```
public DataRange getDataRange()
```
return the mutable DataRange object. This is used to bind axes together by sharing an internal model.

Returns:

the DataRange.

deviceRangeChanged
```
protected void deviceRangeChanged()
```
Deprecated. this is not used.

getDataMinimum
```
public Datum getDataMinimum()
```
return the minimum value

Returns:

the minimum value

getDataMaximum
```
public Datum getDataMaximum()
```
return the maximum value

Returns:

the maximum value

getRange
```
public DatumRange getRange()
```
Deprecated. use getDatumRange instead.

This is the preferred method for getting the range of the axis.

Returns:

a DatumRange indicating the range of the axis.

getDataMaximum
```
public double getDataMaximum(Units units)
```
get the bigger extent of the range of this axis, in the given units.

Parameters:

units - the units which the result should be returned in.

Returns:

the value in the units.

getDataMinimum
```
public double getDataMinimum(Units units)
```
get the smaller extent of the range of this axis, in the given units.

Parameters:

units - the units which the result should be returned in.

Returns:

the value in the units.

setDataMaximum
```
public void setDataMaximum(Datum max)
```
set the bigger extent of the range of this axis.

Parameters:

max - the new value

setDataMinimum
```
public void setDataMinimum(Datum min)
```
set the smaller extent of the range of this axis.

Parameters:

min - the new value

isLog
```
public boolean isLog()
```
return true if the axis is log.

Returns:

true if the axis is log.

setLog
```
public void setLog(boolean log)
```
Set the axis to be log or linear. If necessary, axis range will be adjusted to make the range valid.

Parameters:

log - true if the axis should be log.

getReference

public java.lang.String getReference()

setReference
```
public void setReference(java.lang.String reference)
```
draw an optional reference line at the location. Valid entries can be parsed into a Datum, using the units of the axis.

Parameters:

reference -

getUnits
```
public Units getUnits()
```
return the units of the axis.

Returns:

the units of the axis.

setUnits
```
public void setUnits(Units newUnits)
```
set the units of the axis, which must be convertible from the old units.

Parameters:

newUnits - the units of the axis.

See Also:

resetRange(org.das2.datum.DatumRange)

setScanRange
```
public void setScanRange(DatumRange range)
```
limit the scan buttons to operate within this range. Setting this to null will remove the limit. http://sourceforge.net/p/autoplot/bugs/473/

Parameters:

range - null or the range to limit the scanning

getScanRange
```
public DatumRange getScanRange()
```
get the limit the scan buttons, which may be null.

Returns:

the limit the scan buttons, which may be null.

resetRange
```
public void resetRange(DatumRange range)
```
set the axis to the new range, allowing the units to change.

Parameters:

range - the new range

setOppositeAxisVisible
```
public void setOppositeAxisVisible(boolean visible)
```
if true, then the axis and its ticks on the opposite side will also be drawn.

Parameters:

visible - if true, then the axis and its ticks on the opposite side will also be drawn.

isOppositeAxisVisible
```
public boolean isOppositeAxisVisible()
```
return true if the opposite side is also drawn.

Returns:

true if the opposite side is also drawn.

setLabel
```
public void setLabel(java.lang.String t)
```
set the label for the axis. The label for this axis is displayed below the ticks for horizontal axes or to left of the ticks for vertical axes.

Parameters:

t - The new label for this axis

getLabel
```
public java.lang.String getLabel()
```
get the label for the axis.

Returns:

A String instance that contains the title displayed for this axis, or "" if the axis has no title.

isAnimated
```
public boolean isAnimated()
```
true if the axis is animated. Transitions in axis position are drawn rapidly to animate the transition.

Returns:

true if the axis is animated.

setAnimated
```
public void setAnimated(boolean animated)
```
if true then the axis will be animated.

Parameters:

animated - if true then the axis will be animated.

getDrawTca
```
public boolean getDrawTca()
```
Deprecated. use isDrawTca()

if true then additional ephemeris (TCA) ticks are drawn.

Returns:

if true then additional ticks are drawn.

isDrawTca
```
public boolean isDrawTca()
```
true if additional tick labels are drawn using the TCA function.

Returns:

true if additional ticks will be drawn.

See Also:

setTcaFunction(org.das2.qds.QFunction)

isTcaLoaded
```
public boolean isTcaLoaded()
```
true if the TCA data has been loaded and the axis bounds reflect TCA data present.

Returns:

true if the TCA data has been loaded and the axis bounds reflect TCA data present.

setDrawTca
```
public void setDrawTca(boolean b)
```
if true then turn on additional tick labels using the TCA function.

Parameters:

b - if true then additional ticks will be drawn.

See Also:

setTcaFunction(org.das2.qds.QFunction)

getDataPath
```
public java.lang.String getDataPath()
```
return the path for the TCA dataset. This will be a das2server data set address, such as http://www-pw.physics.uiowa.edu/das/das2Server?voyager/tca/earth

Returns:

the path of the TCA dataset, or "".

setDataPath
```
public void setDataPath(java.lang.String dataset)
```
Parameters:

dataset - The URL identifier string of a TCA data set, or "" for no TCAs.

See Also:

which turns on additional ticks.

processEvent
```
protected void processEvent(java.awt.AWTEvent e)
```
Description copied from class: DasCanvasComponent

Processes events occurring on this component. By default this method calls the appropriate process<event type>Event method for the given class of event.
Note that if the event parameter is null the behavior is unspecified and may result in an exception.

Overrides:

processEvent in class DasCanvasComponent

Parameters:

e - the event

See Also:

Component.processComponentEvent(java.awt.event.ComponentEvent), Component.processFocusEvent(java.awt.event.FocusEvent), Component.processKeyEvent(java.awt.event.KeyEvent), Component.processMouseEvent(java.awt.event.MouseEvent), Component.processMouseMotionEvent(java.awt.event.MouseEvent), Component.processInputMethodEvent(java.awt.event.InputMethodEvent), Component.processHierarchyEvent(java.awt.event.HierarchyEvent), Component.processMouseWheelEvent(java.awt.event.MouseWheelEvent), DasCanvasComponent.processDasUpdateEvent(org.das2.event.DasUpdateEvent)

setTcaFunction
```
public void setTcaFunction(QFunction f)
```
Add auxiliary data to an axis (usually OrbitAttitude data for a time axis). This function does the same thing as setDataPath, but with a different interface. The QFunction must have one input parameter which will be positions on this axis (e.g. times from a time axis).

Parameters:

f - will be called upon to generate auxiliary data sets, or null to disable.

See Also:

which turns on additional ticks.

getTcaRows
```
public int getTcaRows()
```
the explicit number of TCA rows used to allocate space (not including time location). If negative, this is ignored.

Returns:

tcaRows

setTcaRows
```
public void setTcaRows(int tcaRows)
```
the explicit number of additional TCA rows used to allocate space (not including time location). If negative, this is ignored.

Parameters:

tcaRows -

getTcaLabels

public java.lang.String getTcaLabels()

setTcaLabels
```
public void setTcaLabels(java.lang.String tcaLabels)
```
set the TCA data labels explicitly, using a semi-colon delimited list of labels.

Parameters:

tcaLabels -

getDevicePosition
```
public final int getDevicePosition()
```
Deprecated. this should not be used.

TODO: remove this

Returns:

the orientation BOTTOM TOP LEFT RIGHT.

getDLength
```
public int getDLength()
```
return the length of the axis in pixels.

Returns:

returns the length of the axis in pixels.

getMasterAxis
```
public DasAxis getMasterAxis()
```
return the axis this is attached to.

Returns:

the axis this is attached to.

attachTo
```
public void attachTo(DasAxis axis)
```
attach the axis to another axis, so they will both show the same range, as with a stack of time axes or with a slice.

Parameters:

axis - the axis.

detach
```
public void detach()
```
disconnect this from the common DataRange object that ties this to other axes, and create a new DataRange.

isAttached
```
public boolean isAttached()
```
return true if this is attached to another axis.

Returns:

true if this is attached to another axis.

getTickV
```
public TickVDescriptor getTickV()
```
return the current set of ticks.

Returns:

the current set of ticks.

setTickV
```
public void setTickV(double[] minorTicks,
                     double[] majorTicks)
```
convenience method for manually setting the ticks so the user needn't understand TickVDescriptor. setTickV(null) can be used to reset the ticks as well as setTickV(null,null).

Parameters:

minorTicks - the minor ticks, or null (None) for the current minor ticks

majorTicks - the major ticks, or null (None) to automatic.

See Also:

setTickV(org.das2.graph.TickVDescriptor)

addTickV
```
public void addTickV(Datum majorTick)
```
add the tick to the current set of major ticks. If the ticks were automatic, they will now be manual. Note this copies the ticks into a new array, presuming this is done at most a few tens of times.

Parameters:

majorTick - tick in the same units as the axis.

See Also:

setTickV(double[], double[])

setTickV
```
public void setTickV(TickVDescriptor tickV)
```
Sets the TickVDescriptor for this axis. If null is passed in, the axis will put into autoTickV mode, where the axis will attempt to determine ticks using an appropriate algorithm.

Parameters:

tickV - the new ticks for this axis, or null for automatic

getTickValues

public java.lang.String getTickValues()

setTickValues

public void setTickValues(java.lang.String ticks)

manually set the tick positions or spacing. The following are examples of accepted settings:

	empty string is automatic behavior
0,45,90,135,180	explicit tick positions, in axis units
+45	spacing between ticks, parsed with the axis offset units.
+20s/4	every 20 seconds, with four minor divisions.
+30s	30 seconds spacing between ticks
*10/2,3,4,5,6,7,8,9	normal log axis.
*1e2/5,10,50	log major ticks should be every two cycles
*5/2,3,4	log major ticks at 1,5,25/
none	no ticks

Parameters:: ticks -
See Also:: about log axes., GraphUtil.calculateManualTicks(java.lang.String, org.das2.datum.DatumRange, boolean)

resetTickV
```
protected void resetTickV(TickVDescriptor ticks)
```
call-back for TickMaster

Parameters:

ticks - the new ticks.

updateTickVManualTicks

protected void updateTickVManualTicks(java.lang.String lticks)

updateTickV
```
protected void updateTickV()
```
recalculate the tick positions.

paintComponent
```
protected void paintComponent(java.awt.Graphics graphics)
```
paints the axis component. The tickV's and bounds should be calculated at this point

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

graphics - the graphics context.

paintHorizontalAxis
```
protected void paintHorizontalAxis(java.awt.Graphics2D g)
```
Paint the axis if it is horizontal

Parameters:

g - the graphics context

getAxisOffsetPixels
```
protected int getAxisOffsetPixels()
```
return the offset of the axis from the plot, as specified by the axisOffset property.

Returns:

the offset of the axis from the plot

paintVerticalAxis
```
protected void paintVerticalAxis(java.awt.Graphics2D g)
```
Paint the vertical axis

Parameters:

g - the graphics context

setLeftXLabelOverride
```
public void setLeftXLabelOverride(int leftXOverride)
```
Deprecated. use setLabelOffset instead.

allows multiple stacked axes to be manually lined up (if you somehow magically know the offset)

Parameters:

leftXOverride -

See Also:

setLabelOffset(java.lang.String)

setLabelOffset
```
public void setLabelOffset(java.lang.String spec)
```
explicitly set the position of the label from the axis. For example, "4em" will position the y-axis label 4ems away from the axis. Empty string is default automatic behavior.

Parameters:

spec - offset string like "5em+5px"

getLabelOffset

public java.lang.String getLabelOffset()

Returns:: the label offset.

getAxisOffset

public java.lang.String getAxisOffset()

setAxisOffset
```
public void setAxisOffset(java.lang.String axisOffset)
```
set the offset of the axis from the plot.

Parameters:

axisOffset -

getTitlePositionOffset
```
protected int getTitlePositionOffset()
```
get the offset of the label from the baseline in pixels.

Returns:

the offset.

getLineSpacing
```
public int getLineSpacing()
```
calculate the spacing (whitespace) between the TCA items.

Returns:

the spacing between lines.

drawLabel

protected void drawLabel(java.awt.Graphics2D g,
                         Datum value,
                         java.lang.String label,
                         int index,
                         int x,
                         int y)

Draw each label of the axis.

Parameters:: g - graphics context; value - value to look up.; label - the label; index - the index. The default does not use this, but overriding methods may use it.; x - tick position relative to the canvas; y - tick position relative to the canvas

getTickLabelFont
```
public java.awt.Font getTickLabelFont()
```
get the font for tick labels. If the component currently has null for the font, then Font.decode("sans-12") is used and a warning logged.

Returns:

the font to use for ticks.

getLabelFont
```
public java.awt.Font getLabelFont()
```
get the font for labels. If the component currently has null for the font, then Font.decode("sans-12") is used.

Returns:

the font to use for labels.

getFontSize
```
public java.lang.String getFontSize()
```

setFontSize

public void setFontSize(java.lang.String fontSize)

getMemento
```
public DasAxis.Memento getMemento()
```
get the memento object which identifies the state of the axis transformation.

Returns:

the momento.

getAffineTransform
```
public java.awt.geom.AffineTransform getAffineTransform(DasAxis.Memento memento,
                                                        java.awt.geom.AffineTransform at)
```
return the AffineTransform, or null. The transform will be applied after the input transform is applied. So to just get the transform, pass in identity.

Parameters:

memento - memento from another axis state.

at - initial transform

Returns:

the transform from that state to this state, or null if no transform can be created.

clone
```
public java.lang.Object clone()
```
Overrides:

clone in class java.lang.Object

Returns:

a copy of the axis, also cloning the dataRange that backs the axis.

getMaxLabelWidth
```
protected int getMaxLabelWidth(java.awt.FontMetrics fm)
```
Deprecated. use getMaxLabelWidth()

calculate the biggest label width

Parameters:

fm - the font metrics.

Returns:

the width in pixels of the widest label.

See Also:

getMaxLabelWidth()

resize
```
public void resize()
```
reset bounds (and unused transform), invalidate the tickV, etc.

Overrides:

resize in class DasCanvasComponent

getLabelBounds
```
protected java.awt.Rectangle getLabelBounds(java.awt.Rectangle bounds)
```
calculate the bounds of the labels. This should including regions that the labels could occupy if the axis were panned, so that result doesn't change during panning.

Parameters:

bounds - the bounds which will be enlarged, or null.

Returns:

Rectangle in the canvas coordinate frame.

getAxisBounds
```
public java.awt.Rectangle getAxisBounds()
```
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.

Returns:

Rectangle containing the axes and its labels.

getTickLines
```
public int getTickLines()
```
return the number of lines that the ticks use, considering the ephemeris (TCAs) loaded.

Returns:

the number of lines that the ticks use.

getOrientation
```
public int getOrientation()
```
returns the orientation of the axis, which is one of BOTTOM,TOP,LEFT or RIGHT.

Returns:

BOTTOM,TOP,LEFT or RIGHT.

isHorizontal
```
public boolean isHorizontal()
```
test if the axis is horizontal.

Returns:

true if the orientation is BOTTOM or TOP.

getTickDirection
```
public int getTickDirection()
```
return the tick direction, 1=down or left, -1=up or right

Returns:

1=down or left, -1=up or right

getDatumFormatter
```
public DatumFormatter getDatumFormatter()
```
return the formatter which converts Datum tick positions to a string.

Returns:

the formatter which converts Datum tick positions to a string.

transform
```
public double transform(Datum datum)
```
Transforms a Datum in data coordinates to a horizontal or vertical position on the parent canvas.

Parameters:

datum - a data value

Returns:

Horizontal or vertical position on the canvas.

Throws:

InconvertibleUnitsException

transformFast
```
protected double transformFast(double data,
                               Units units)
```
this was never utilized, but at_m and at_b could be used to speed up transformation.

Parameters:

data - the data location

units - the units

Returns:

the pixel location.

transform
```
public double transform(double data,
                        Units units)
```
Transforms a double in the given units in data coordinates to a horizontal or vertical position on the parent canvas.

Parameters:

data - a data value

units - the units of the given data value.

Returns:

Horizontal or vertical position on the canvas.

Throws:

InconvertibleUnitsException

transform
```
public double transform(QDataSet data,
                        Units units)
```
Transforms the rank 0 dataset a horizontal or vertical position on the parent canvas. This was introduced to support when the rank 1 iterator would return QDataSets instead of doubles.

Parameters:

data - a data value

units - the units of the given data value.

Returns:

Horizontal or vertical position on the canvas.

Throws:

InconvertibleUnitsException

transform
```
public double transform(QDataSet data)
```
Transforms the rank 0 dataset a horizontal or vertical position on the parent canvas.

Parameters:

data - a data value

Returns:

Horizontal or vertical position on the canvas.

Throws:

InconvertibleUnitsException

transform
```
protected double transform(double data,
                           Units units,
                           int dmin,
                           int dmax)
```
Transforms a double in the given units in data coordinates to a horizontal or vertical position on the parent canvas.

Parameters:

data - a data value

units - the units of the given data value.

dmin - the axis minimum.

dmax - the axis maximum.

Returns:

Horizontal or vertical position on the canvas.

Throws:

InconvertibleUnitsException

invTransform
```
public DatumRange invTransform(double idata1,
                               double idata2)
```
get the range covered by the two points. This allows clients to get a range without having to worry about the flipped property.

Parameters:

idata1 - pixel position on the axis, in the canvas frame.

idata2 - pixel position on the axis, in the canvas frame.

Returns:

DatumRange implied by the two pixel positions.

Throws:

InconvertibleUnitsException

invTransform
```
public Datum invTransform(double idata)
```
return the data location for the given pixel position. Plot coordinates have 0,0 at the upper-left hand corner of the screen.

Parameters:

idata - the pixel location on the axis, in the canvas frame.

Returns:

the data location.

Throws:

InconvertibleUnitsException

tickFormatter
```
protected java.lang.String tickFormatter(Datum d)
```
return a label for this datum and visible range. This is intended to be overridden to change behavior. Note that both tickFormatter methods should be overridden.

Parameters:

d - the location

Returns:

string, possibly with Granny control characters.

tickFormatter
```
protected java.lang.String[] tickFormatter(DatumVector tickV,
                                           DatumRange datumRange)
```
return the tick labels for these datums and visible range. This is intended to be overridden to change behavior. Note that both tickFormatter methods should be overridden.

Parameters:

tickV - the ticks

datumRange - the range

Returns:

Strings, possibly with Granny control characters.

dataRangeSelected
```
public void dataRangeSelected(DataRangeSelectionEvent e)
```
target event handlers to reset the axis bounds.

Specified by:

dataRangeSelected in interface DataRangeSelectionListener

Parameters:

e - the event

findTick
```
public Datum findTick(Datum xDatum,
                      double direction,
                      boolean minor)
```
Deprecated. Use getTickVDescriptor.findTick

Locates the next or previous tick starting at xDatum.

Parameters:

xDatum - find the tick closest to this.

direction - -1 previous, 1 next, 0 closest

minor - find closest minor tick, major if false.

Returns:

the closest tick. If there is no tick in the given direction, then the behavior is undefined.

updateImmediately
```
protected void updateImmediately()
```
reset the transform and update the tick locations.

Overrides:

updateImmediately in class DasCanvasComponent

isTickLabelsVisible
```
public boolean isTickLabelsVisible()
```
true if the tick labels should be drawn.

Returns:

true if the tick labels should be drawn.

setTickLabelsVisible
```
public void setTickLabelsVisible(boolean b)
```
set true if the tick labels should be drawn.

Parameters:

b - true if the tick labels should be drawn.

installComponent
```
protected void installComponent()
```
perform actions necessary when starting the component, such as handling TCA.

Overrides:

installComponent in class DasCanvasComponent

uninstallComponent
```
protected void uninstallComponent()
```
remove the component row and column update listener.

Overrides:

uninstallComponent in class DasCanvasComponent

createAttachedAxis
```
public DasAxis createAttachedAxis()
```
create another axis that follows this axis. It will have the same range and orientation.

Returns:

attached axis.

createAttachedAxis
```
public DasAxis createAttachedAxis(int orientation)
```
create another axis that follows this axis. It will have the same range.

Parameters:

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

Returns:

attached axis.

setPlot
```
public void setPlot(DasPlot p)
```
set the plot that will get updates

Parameters:

p - plot object.

scanPrevious
```
public void scanPrevious()
```
scan to the previous interval. If we were looking at a day with fuzz, then scan to the previous day.

scanNext
```
public void scanNext()
```
scan to the next interval. If we were looking at a day with fuzz, then scan to the next day.

getActiveRegion
```
public java.awt.Shape getActiveRegion()
```
get the region containing the axis.

Overrides:

getActiveRegion in class DasCanvasComponent

Returns:

the region containing the axis.

addMouseWheelListener
```
public void addMouseWheelListener(java.awt.event.MouseWheelListener l)
```
Adds a MouseWheelListener to the DasAxis. Special care must be taken with the DasAxis, because it is composed of two sub panels, and their parent panel (this), must not recieve the events. (This is because the DasPlot between them should get the events, and the DasPlot does not have a simple rectangular boundary.

Overrides:

addMouseWheelListener in class java.awt.Component

Parameters:

l - the listener

removeMouseWheelListener
```
public void removeMouseWheelListener(java.awt.event.MouseWheelListener l)
```
remove mouse wheel listener.

Overrides:

removeMouseWheelListener in class java.awt.Component

Parameters:

l - the listener

See Also:

maybeInitializeInputPanels()

addMouseListener
```
public void addMouseListener(java.awt.event.MouseListener l)
```
add mouse wheel listener.

Overrides:

addMouseListener in class java.awt.Component

Parameters:

l - the listener

See Also:

maybeInitializeInputPanels()

removeMouseListener
```
public void removeMouseListener(java.awt.event.MouseListener l)
```
remove mouse motion listener.

Overrides:

removeMouseListener in class java.awt.Component

Parameters:

l - the listener

See Also:

maybeInitializeInputPanels()

addMouseMotionListener
```
public void addMouseMotionListener(java.awt.event.MouseMotionListener l)
```
add mouse motion listener.

Overrides:

addMouseMotionListener in class java.awt.Component

Parameters:

l - the listener

See Also:

maybeInitializeInputPanels()

removeMouseMotionListener
```
public void removeMouseMotionListener(java.awt.event.MouseMotionListener l)
```
remove mouse motion listener.

Overrides:

removeMouseMotionListener in class java.awt.Component

Parameters:

l - the listener

See Also:

maybeInitializeInputPanels()

timeRangeSelected
```
public void timeRangeSelected(TimeRangeSelectionEvent e)
```
call back for time range selection event.

Specified by:

timeRangeSelected in interface TimeRangeSelectionListener

Parameters:

e - the event

addTimeRangeSelectionListener
```
public void addTimeRangeSelectionListener(TimeRangeSelectionListener listener)
```
Registers TimeRangeSelectionListener to receive events.

Parameters:

listener - The listener to register.

removeTimeRangeSelectionListener
```
public void removeTimeRangeSelectionListener(TimeRangeSelectionListener listener)
```
Removes TimeRangeSelectionListener from the list of listeners.

Parameters:

listener - The listener to remove.

toString
```
public java.lang.String toString()
```
Overrides:

toString in class DasCanvasComponent

Returns:

a concise String representation of the object.

setNextActionLabel

public void setNextActionLabel(java.lang.String label,
                               java.lang.String tooltip)

set the label for the popup button

Parameters:: label - concise label; tooltip - text for popup tooltip

setPreviousActionLabel

public void setPreviousActionLabel(java.lang.String label,
                                   java.lang.String tooltip)

set the label for the popup button

Parameters:: label - concise label; tooltip - text for popup tooltip

repaint
```
public void repaint()
```
Overrides:

repaint in class java.awt.Component

getTickLength
```
public java.lang.String getTickLength()
```
get the tick length string, for example "0.66em"

Returns:

the tick length string

setTickLength
```
public void setTickLength(java.lang.String tickLengthStr)
```
set the tick length string, for example "0.33em" "5px" "-0.33em"

Parameters:

tickLengthStr - the tick length string.

getLineThickness

public java.lang.String getLineThickness()

setLineThickness
```
public void setLineThickness(java.lang.String lineThickness)
```
set the thickness of the lines drawn.

Parameters:

lineThickness -

isFlipped
```
public boolean isFlipped()
```
return true if the axis is flipped.

Returns:

true if the axis is flipped.

setFlipped
```
public void setFlipped(boolean b)
```
flip over the axis.

Parameters:

b -

getFormat
```
public java.lang.String getFormat()
```
return the format string for each tick.

Returns:

the format string for each tick.

isFlipLabel
```
public boolean isFlipLabel()
```
true if the right vertical label should be flipped.

Returns:

true if the right vertical label should be flipped.

setFlipLabel
```
public void setFlipLabel(boolean flipLabel)
```
true if the right vertical label should be flipped.

Parameters:

flipLabel - true if the right vertical label should be flipped.

getDividerDatumFormatter

public DatumFormatter getDividerDatumFormatter()

setDividerDatumFormatter

public void setDividerDatumFormatter(DatumFormatter dividerDatumFormatter)

getMinorTicksDomainDivider
```
public DomainDivider getMinorTicksDomainDivider()
```
return the domain divider for minor ticks, or null.

Returns:

the domain divider for minor ticks, or null.

setMinorTicksDomainDivider

public void setMinorTicksDomainDivider(DomainDivider minorTicksDomainDivider)

getMajorTicksDomainDivider
```
public DomainDivider getMajorTicksDomainDivider()
```
return the domain divider for major ticks, or null.

Returns:

the domain divider for major ticks, or null.

setMajorTicksDomainDivider

public void setMajorTicksDomainDivider(DomainDivider majorTicksDomainDivider)

isUseDomainDivider
```
public boolean isUseDomainDivider()
```
true if the domain divider should be used. This is a new object that locates ticks.

Returns:

true if the domain divider should be used.

setUseDomainDivider
```
public void setUseDomainDivider(boolean useDomainDivider)
```
true if the domain divider should be used. This is a new object that locates ticks.

Parameters:

useDomainDivider - true if the domain divider should be used.

isLockDomainDivider
```
public boolean isLockDomainDivider()
```

setLockDomainDivider
```
public void setLockDomainDivider(boolean lockDomainDivider)
```
don't allow the domain divider to adjust.

Parameters:

lockDomainDivider -

setVisible
```
public void setVisible(boolean aFlag)
```
set the component visible or invisible. The axis bounds are updated. So in addition to the JComponent visibility, this also makes a useful property to completely hide the axis. drawTickLabels hides the labels but still draws the ticks, this completely hides the axis. Note too that even though it is not visible, tick positions are still updated to support drawing a grid on the plot.

Overrides:

setVisible in class javax.swing.JComponent

Parameters:

aFlag -

setFormat
```
public void setFormat(java.lang.String formatString)
```
set a hint at the format string. Examples include:
- 0.000
- %H:%M!c%Y-%j
- 0
Parameters:

formatString -

mutatorLock
```
public DasAxis.Lock mutatorLock()
```
get an object to lock the axis for multiple operations.

Returns:

valueIsAdjusting
```
public boolean valueIsAdjusting()
```
true if a lock is out and an object is rapidly mutating the object. clients listening for property changes can safely ignore property changes while valueIsAdjusting is true, as they should receive a final propertyChangeEvent after the lock is released. (note it's not clear who is responsible for this. See http://das2.org/wiki/index.php/Das2.valueIsAdjusting)

Returns:

true if valueIsAdjusting

Class DasAxis

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class org.das2.graph.DasCanvasComponent

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class org.das2.graph.DasCanvasComponent

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

PROP_LABEL

PROP_LOG

PROP_OPPOSITE_AXIS_VISIBLE

PROP_BOUNDS

PROP_SCAN_RANGE

PROP_UNITS

PROPERTY_TICKS

MAX_TCA_LINES

TOP

BOTTOM

LEFT

RIGHT

HORIZONTAL

VERTICAL

dataRange

axisLabel

tickV

datumFormatter

primaryInputPanel

secondaryInputPanel

PROPERTY_DATUMRANGE

enableHistory

PROP_ENABLEHISTORY

PROP_REFERENCE

PROP_TCAROWS

PROP_TCALABELS

PROP_TICKVALUES

PROP_AXISOFFSET

PROP_FONTSIZE

PROP_LINETHICKNESS

PROP_FLIPPED

formatString

PROP_FORMATSTRING

flipLabel

PROP_FLIPLABEL

dividerDatumFormatter

PROP_DIVIDERDATUMFORMATTER

minorTicksDomainDivider

PROP_MINORTICKSDOMAINDIVIDER

majorTicksDomainDivider

PROP_MAJORTICKSDOMAINDIVIDER

useDomainDivider

PROP_USEDOMAINDIVIDER

PROP_LOCKDOMAINDIVIDER

Constructor Detail

DasAxis

DasAxis

DasAxis

DasAxis

Method Detail

getUserDatumFormatter

setUserDatumFormatter

setNextAction

setPreviousAction

addToFavorites

removeFromFavorites

isEnableHistory

setEnableHistory

setOrientation

setDatumRange

getDatumRange