Layout
Class PamFramePlots

java.lang.Object
  extended by Layout.PamFramePlots
Direct Known Subclasses:
ClickDisplay, UserFramePlots

public abstract class PamFramePlots
extends java.lang.Object

Author:
Doug Gillespie

Abstract class PamFramePlots is used to layout graphics windows which have a border (generally grey) and some kind of inner display panel. Normally the outer panel will contain the axis and the inner panel any other graphics, such as a spectrogram.

For an example see SpectrogramDisplay which is a subclass of PamFramePlots SpectrogramDisplay sets axisPanel to a SpectrogramAxis, which is in turn subclassed from PamAxisPanel. it also sets plotPanel to SpectrogramPlotPanel, which is a subclass of JPanel and it sets eastPanel to AmplitudePanel which is used for drawing a colour bar representing amplitude.

See Also:
PamInternalFrame, PamAxisPanel, PamAxis, BorderLayout, SpectrogramDisplay

Field Summary
private  java.awt.Component axisPanel
          The panel filling the entire PamInternalFrame
private  ClipboardCopier clipboardCopier
           
private  java.awt.Component eastPanel
           
private  java.awt.Component northPanel
           
private  PamInternalFrame pamFrame
           
private  java.awt.Component plotPanel
          Inner panel nested inside axisPanel with a border large enough to contain any required axis.
private  java.awt.Component southPanel
           
private  java.awt.Component westPanel
           
 
Constructor Summary
PamFramePlots()
           
 
Method Summary
 java.awt.Component getAxisPanel()
           
 javax.swing.JMenuItem getCopyMenuItem()
           
 java.awt.Component getEastPanel()
           
 PamInternalFrame getFrame()
           
abstract  java.lang.String getName()
           
 java.awt.Component getNorthPanel()
           
 java.awt.Component getPlotPanel()
           
 java.awt.Component getSouthPanel()
           
 java.awt.Component getWestPanel()
           
 void repaint(int tm)
          Repaint all windows in the frame plot with delay tm
 void setAxisPanel(java.awt.Component axisPanel)
           
 void setEastPanel(java.awt.Component eastPanel)
           
 void setFrame(PamInternalFrame pamFrame)
           
 void setNorthPanel(java.awt.Component northPanel)
           
 void setPlotPanel(java.awt.Component plotPanel)
           
 void setSouthPanel(java.awt.Component southPanel)
           
 void setWestPanel(java.awt.Component westPanel)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

axisPanel

private java.awt.Component axisPanel
The panel filling the entire PamInternalFrame


plotPanel

private java.awt.Component plotPanel
Inner panel nested inside axisPanel with a border large enough to contain any required axis.

See Also:
BorderLayout

northPanel

private java.awt.Component northPanel
See Also:
BorderLayout

southPanel

private java.awt.Component southPanel
See Also:
BorderLayout

eastPanel

private java.awt.Component eastPanel
See Also:
BorderLayout

westPanel

private java.awt.Component westPanel
See Also:
BorderLayout

pamFrame

private PamInternalFrame pamFrame

clipboardCopier

private ClipboardCopier clipboardCopier
Constructor Detail

PamFramePlots

public PamFramePlots()
Method Detail

getName

public abstract java.lang.String getName()

getFrame

public PamInternalFrame getFrame()

getCopyMenuItem

public javax.swing.JMenuItem getCopyMenuItem()

setFrame

public void setFrame(PamInternalFrame pamFrame)

repaint

public void repaint(int tm)
Repaint all windows in the frame plot with delay tm

Parameters:
tm - time delay in millis

getAxisPanel

public java.awt.Component getAxisPanel()

setAxisPanel

public void setAxisPanel(java.awt.Component axisPanel)

getEastPanel

public java.awt.Component getEastPanel()

setEastPanel

public void setEastPanel(java.awt.Component eastPanel)

getNorthPanel

public java.awt.Component getNorthPanel()

setNorthPanel

public void setNorthPanel(java.awt.Component northPanel)

getPlotPanel

public java.awt.Component getPlotPanel()

setPlotPanel

public void setPlotPanel(java.awt.Component plotPanel)

getSouthPanel

public java.awt.Component getSouthPanel()

setSouthPanel

public void setSouthPanel(java.awt.Component southPanel)

getWestPanel

public java.awt.Component getWestPanel()

setWestPanel

public void setWestPanel(java.awt.Component westPanel)