Layout
Class PamAxisPanel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by Layout.PamAxisPanel
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, ColorManaged
Direct Known Subclasses:
ClassifierHistoryWindow.HistoryAxisPanel, ClickSpectrum.SpectrumAxis, ClickWaveform.WaveAxis, DepthSidePanel.GraphAxisPanel, HistogramDisplay.HistoAxisPanel, HydrophoneDiagram.AxisPanel, NoiseTabPanel.PlotAxesPanel, NoiseTabPanel.SpecPlotAxesPanel, RadarDisplay.RadarAxis, SpectrogramDisplay.AmplitudePanel, SpectrogramDisplay.SpectrogramAxis, WignerPlot.WignerAxes

public class PamAxisPanel
extends javax.swing.JPanel
implements ColorManaged

Author:
Doug Gillespie

PamAxisPanel is used to lay out a panel with surrounding axis.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
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
private  boolean autoInsets
           
private  javax.swing.border.Border border
           
private  PamAxis eastAxis
          axis to be displayed on any or all of the four sides of a plot window (innerPanel below)
private  javax.swing.JPanel innerPanel
          The main plot panel that the axis are drawn around.
private  int minEast
           
private  int minNorth
           
private  int minSouth
           
private  int minWest
           
private  PamAxis northAxis
          axis to be displayed on any or all of the four sides of a plot window (innerPanel below)
private  javax.swing.JComponent plotPanel
          If the plot panel contains border components such as a scroll bar, then the axis may need to be drawn relative to a slightly different panel.
private  PamAxis southAxis
          axis to be displayed on any or all of the four sides of a plot window (innerPanel below)
private  javax.swing.JLabel titleLabel
           
private  PamAxis westAxis
          axis to be displayed on any or all of the four sides of a plot window (innerPanel below)
 
Fields inherited from class javax.swing.JComponent
accessibleContext, 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
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
PamAxisPanel()
           
 
Method Summary
 PamColors.PamColor getColorId()
          The components colour scheme.
 PamAxis getEastAxis()
           
 javax.swing.JPanel getInnerPanel()
           
 int getMinEast()
           
 int getMinNorth()
           
 int getMinSouth()
           
 int getMinWest()
           
 PamAxis getNorthAxis()
           
 javax.swing.JComponent getPlotPanel()
           
 PamAxis getSouthAxis()
           
 PamAxis getWestAxis()
           
 boolean isAutoInsets()
           
 void paintComponent(java.awt.Graphics g)
           
 void setAutoInsets(boolean autoInsets)
           
 void setAutoInsets(java.awt.Graphics g)
          Work out how much space is required around the central plot for axis.
 void SetBorderMins(int minNorth, int minWest, int minSouth, int minEast)
           
 void setEastAxis(PamAxis eastAxis)
           
 void setInnerPanel(javax.swing.JPanel innerPanel)
           
 void setMinEast(int minEast)
           
 void setMinNorth(int minNorth)
           
 void setMinSouth(int minSouth)
           
 void setMinWest(int minWest)
           
 void setNorthAxis(PamAxis northAxis)
           
 void setPlotPanel(javax.swing.JComponent plotPanel)
           
 void setSouthAxis(PamAxis southAxis)
           
 void setWestAxis(PamAxis westAxis)
           
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, 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
 
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, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
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, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

northAxis

private PamAxis northAxis
axis to be displayed on any or all of the four sides of a plot window (innerPanel below)


southAxis

private PamAxis southAxis
axis to be displayed on any or all of the four sides of a plot window (innerPanel below)


westAxis

private PamAxis westAxis
axis to be displayed on any or all of the four sides of a plot window (innerPanel below)


eastAxis

private PamAxis eastAxis
axis to be displayed on any or all of the four sides of a plot window (innerPanel below)


minNorth

private int minNorth

minSouth

private int minSouth

minEast

private int minEast

minWest

private int minWest

border

private javax.swing.border.Border border

titleLabel

private javax.swing.JLabel titleLabel

innerPanel

private javax.swing.JPanel innerPanel
The main plot panel that the axis are drawn around.


plotPanel

private javax.swing.JComponent plotPanel
If the plot panel contains border components such as a scroll bar, then the axis may need to be drawn relative to a slightly different panel. Plot panel is basically a component of innerPanel and if it is not null, axis will be drawn outside the inner panel, but lined up with the plotPanel.


autoInsets

private boolean autoInsets
Constructor Detail

PamAxisPanel

public PamAxisPanel()
Method Detail

getPlotPanel

public javax.swing.JComponent getPlotPanel()
Returns:
the plotPanel or if the plotPanel is null, return the innerPanel

setPlotPanel

public void setPlotPanel(javax.swing.JComponent plotPanel)
Parameters:
plotPanel - the plotPanel to set Note that the plot panel is not necessarily the same as the inner panel which is the main component held within the axis panel. The actual plot panel may be smaller than the inner panel since the inner panel may contain scroll bars or other components around the plot panel.

getColorId

public PamColors.PamColor getColorId()
Description copied from interface: ColorManaged
The components colour scheme.

Specified by:
getColorId in interface ColorManaged
Returns:
PamColor

paintComponent

public void paintComponent(java.awt.Graphics g)
Overrides:
paintComponent in class javax.swing.JComponent

setAutoInsets

public void setAutoInsets(java.awt.Graphics g)
Work out how much space is required around the central plot for axis.


SetBorderMins

public void SetBorderMins(int minNorth,
                          int minWest,
                          int minSouth,
                          int minEast)

getInnerPanel

public javax.swing.JPanel getInnerPanel()

setInnerPanel

public void setInnerPanel(javax.swing.JPanel innerPanel)

getEastAxis

public PamAxis getEastAxis()

setEastAxis

public void setEastAxis(PamAxis eastAxis)

getNorthAxis

public PamAxis getNorthAxis()

setNorthAxis

public void setNorthAxis(PamAxis northAxis)

getSouthAxis

public PamAxis getSouthAxis()

setSouthAxis

public void setSouthAxis(PamAxis southAxis)

getWestAxis

public PamAxis getWestAxis()

setWestAxis

public void setWestAxis(PamAxis westAxis)

isAutoInsets

public boolean isAutoInsets()

setAutoInsets

public void setAutoInsets(boolean autoInsets)

getMinEast

public int getMinEast()

setMinEast

public void setMinEast(int minEast)

getMinNorth

public int getMinNorth()

setMinNorth

public void setMinNorth(int minNorth)

getMinSouth

public int getMinSouth()

setMinSouth

public void setMinSouth(int minSouth)

getMinWest

public int getMinWest()

setMinWest

public void setMinWest(int minWest)