AuxLegend (Starjava TTOOLS API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - uk.ac.starlink.ttools.plot.AuxLegend

```
public class AuxLegend
extends javax.swing.JComponent
```
Displays a legend for an auxiliary (colour) axis.

Since:

14 Jun 2007

Author:

Mark Taylor

See Also:

Serialized Form

Nested Class Summary
- 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
- Nested classes/interfaces inherited from class java.awt.Container
  java.awt.Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent

Field Summary
- 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
- 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

Constructor Summary

Constructors
Constructor Description

AuxLegend(boolean horizontal, int iconDepth)
Constructor.

Constructors
Constructor	Description
`AuxLegend(boolean horizontal, int iconDepth)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`configure(PlotState state, int iaux)`	Configures this legend according to a given plot state.
`double`	`fractionToData(double frac)`	Converts a fractional value (where zero corresponds to current lower bound and 1 corresponds to current upper bound) into a corresponding data value.
`java.awt.Rectangle`	`getDataBounds()`	Returns the bounds of the region of this component containing the legend.
`java.awt.Dimension`	`getMaximumSize()`
`java.awt.Dimension`	`getMinimumSize()`
`java.awt.Dimension`	`getPreferredSize()`
`boolean`	`isHorizontal()`	Indicates the orientation of this legend.
`protected void`	`paintComponent(java.awt.Graphics g)`
`void`	`setLengthPadding(int preLength, int postLength)`	Configures the amount of padding left before and after the bar which can be used to carry half-labels etc.

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, 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, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, 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, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, 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, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AuxLegend
```
public AuxLegend(boolean horizontal,
                 int iconDepth)
```
    Constructor.
    
    Parameters:
    
    horizontal - true for a bar that runs horizontally, false for a bar that runs vertically
    
    iconDepth - preferred transverse size of the legend colour band
- Method Detail
  - setLengthPadding
```
public void setLengthPadding(int preLength,
                             int postLength)
```
    Configures the amount of padding left before and after the bar which can be used to carry half-labels etc.
    
    Parameters:
    
    preLength - number of padding pixels blank before the bar run
    
    postLength - number of padding pixels blank after the bar run
  - configure
```
public void configure(PlotState state,
                      int iaux)
```
    Configures this legend according to a given plot state.
    
    Parameters:
    
    state - plot state
    
    iaux - index of auxiliary axis to use
  - isHorizontal
```
public boolean isHorizontal()
```
    Indicates the orientation of this legend.
    
    Returns:
    
    true if the bar runs horizontally, false if it runs vertically
  - paintComponent
```
protected void paintComponent(java.awt.Graphics g)
```
    Overrides:
    
    paintComponent in class javax.swing.JComponent
  - getPreferredSize
```
public java.awt.Dimension getPreferredSize()
```
    Overrides:
    
    getPreferredSize in class javax.swing.JComponent
  - getMaximumSize
```
public java.awt.Dimension getMaximumSize()
```
    Overrides:
    
    getMaximumSize in class javax.swing.JComponent
  - getMinimumSize
```
public java.awt.Dimension getMinimumSize()
```
    Overrides:
    
    getMinimumSize in class javax.swing.JComponent
  - fractionToData
```
public double fractionToData(double frac)
```
    Converts a fractional value (where zero corresponds to current lower bound and 1 corresponds to current upper bound) into a corresponding data value.
    
    Parameters:
    
    frac - input fractional value
    
    Returns:
    
    corresponding data value
  - getDataBounds
```
public java.awt.Rectangle getDataBounds()
```
    Returns the bounds of the region of this component containing the legend. The ends of the region will be aligned with the ends of the data part of the painted bar. Currently the transverse bounds of this region include space for the numeric labels as well as the bar itself.
    
    Returns:
    
    data region bounds

Class AuxLegend

Nested Class Summary

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

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

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

Field Summary

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Fields inherited from class javax.swing.JComponent

Constructor Summary

Method Summary

Methods inherited from class java.awt.Component

Methods inherited from class java.awt.Container

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.lang.Object

Constructor Detail

AuxLegend

Method Detail

setLengthPadding

configure

isHorizontal

paintComponent

getPreferredSize

getMaximumSize

getMinimumSize

fractionToData

getDataBounds