com.lobsterman.JavaGrinders

Class Presenter

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

com.lobsterman.JavaGrinders.Presenter

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

DataTablePresenter

public class Presenter
extends javax.swing.JFrame
implements java.awt.event.ActionListener

root class for all kinds of objects that visualize data

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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
javax.swing.JComponent	itsCanvas
java.awt.Rectangle	itsDefaultCoordinateMap
PresenterPanel	itsPresenterPanel
static int	kMenuBarHeight
protected int	kPaspart
protected javax.swing.JMenuItem	miClear
protected javax.swing.JMenuItem	miClose
protected javax.swing.JMenuItem	miCopy
protected javax.swing.JMenuItem	miCut
protected javax.swing.JMenuItem	miNew
protected javax.swing.JMenuItem	miOpen
protected javax.swing.JMenuItem	miPaste
protected javax.swing.JMenuItem	miSave
protected javax.swing.JMenuItem	miSaveAs
protected javax.swing.JMenuItem	miSelectAll
protected javax.swing.JMenuItem	miUndo

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
Presenter() Constructor for the Presenter class
Presenter(double sizingValue) Constructor for the Presenter class
Presenter(java.lang.String frameTitle) Constructor for the Presenter class
Presenter(java.lang.String frameTitle, double sizingValue) Standard constructor for the Presenter class
Presenter(java.lang.String frameTitle, double sizingValue, PresenterPanel aPanel) Standard constructor for the Presenter class
Presenter(java.lang.String frameTitle, PresenterPanel aPanel) Standard constructor for the Presenter class

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent newEvent) ActionListener interface (for menus)
void	addEditMenuItems()
void	addFileMenuItems() adds the file menu items
void	addMenus() adds menus to the JFrame
void	asCircularGraph(com.lobsterman.JavaGrinders.spatial.AngleVariable theAngles) coordinates a JFrame with a circular graph for the provided angles
void	asColorHistogram(ContingencyTable theTable) coordinates a JFrame with a histogram for the provided table
void	asColorHistogram(ContingencyTable theTable, boolean labelBars) coordinates a JFrame with a histogram for the provided table
void	asHistogram(ContingencyTable theTable) coordinates a JFrame with a circular graph for the provided angles
void	asSpatialMap(com.lobsterman.JavaGrinders.spatial.CaptureVariable theCaptures, boolean xDir, boolean yDir) coordinates a JFrame with a spatial map graph for the provided captures
void	asSpatialMap(com.lobsterman.JavaGrinders.spatial.CaptureVariable theCaptures, com.lobsterman.JavaGrinders.spatial.GridSpace3D theGridSpace) coordinates a JFrame with a spatial map graph for the provided captures
void	asXYPlot(com.lobsterman.JavaGrinders.spatial.GridSpace3D theGridSpace) coordinates a JFrame with a spatial map graph for the provided captures
void	asXYPlot(NumberVariable theXs, NumberVariable theYs) coordinates a JFrame with a spatial map graph for the provided captures
void	asXYPlot(NumberVariable theXs, NumberVariable theYs, boolean xDir, boolean yDir) coordinates a JFrame with a spatial map graph for the provided captures
void	asXYPlot(NumberVariable theXs, NumberVariable theYs, com.lobsterman.JavaGrinders.spatial.GridSpace3D theGridSpace) coordinates a JFrame with a spatial map graph for the provided captures
void	asXYPlot(NumberVariable theXs, NumberVariable theYs, com.lobsterman.JavaGrinders.spatial.GridSpace3D theGridSpace, boolean connected) coordinates a JFrame with a spatial map graph for the provided captures
void	doClear() handles a clear event
void	doClose() handles a close Document event
void	doCopy() handles a copy event
void	doCut() handles a cut event
void	doNew() handles a new Document event
void	doOpen() handles an open Document event
void	doPaste() handles a paste event
void	doSave() handles a save Document event
void	doSaveAs() handles a save as ...
void	doSelectAll() handles a select all event
void	doUndo() handles an undo event
void	handleQuit() handles a quit event
void	initializeCanvas() initializes the canvas
static void	main(java.lang.String[] args) main routine
javax.swing.JComponent	makeCanvasPanel() makes the main canvas panel
PresenterPanel	makePresenterPanel() creates the Panel for presenting the active data
java.awt.Dimension	maxWindowRatioSize(double aWidthHeightRatio) scales the frame with a given width/height ratio to the full screen
java.awt.Dimension	maxWindowSize() scales the frame to the full screen available
void	saveToSVGFile(java.lang.String filePath) saves the content of the PresenterPanel to an SVG file
void	setFrameSize(double sizeValue) scales the frame to a given screen size
void	setPlotDimensions() sets the plot dimensions
void	setPresenterPanel(PresenterPanel aPanel) sets the panel for the presenter
void	setScalesForPanel(PresenterPanel aPanel) creates the Panel for presenting the active data

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

miNew

protected javax.swing.JMenuItem miNew

miOpen

protected javax.swing.JMenuItem miOpen

miClose

protected javax.swing.JMenuItem miClose

miSave

protected javax.swing.JMenuItem miSave

miSaveAs

protected javax.swing.JMenuItem miSaveAs

miUndo

protected javax.swing.JMenuItem miUndo

miCut

protected javax.swing.JMenuItem miCut

miCopy

protected javax.swing.JMenuItem miCopy

miPaste

protected javax.swing.JMenuItem miPaste

miClear

protected javax.swing.JMenuItem miClear

miSelectAll

protected javax.swing.JMenuItem miSelectAll

itsCanvas

public javax.swing.JComponent itsCanvas

itsPresenterPanel

public PresenterPanel itsPresenterPanel

itsDefaultCoordinateMap

public java.awt.Rectangle itsDefaultCoordinateMap

kMenuBarHeight

public static int kMenuBarHeight

kPaspart

protected final int kPaspart

See Also:

Constant Field Values

Constructor Detail

Presenter

public Presenter()
          throws java.lang.Exception

Constructor for the Presenter class

Throws:

java.lang.Exception

Presenter

public Presenter(java.lang.String frameTitle)
          throws java.lang.Exception

Constructor for the Presenter class

Parameters:

frameTitle - the title on the presenter's frame

Throws:

java.lang.Exception

Presenter

public Presenter(double sizingValue)
          throws java.lang.Exception

Constructor for the Presenter class

Parameters:

sizingValue - controls whether sizing occurs with a width/height ratio (greater than 0), to the full screen (0), or not at all (less than 0);

Throws:

java.lang.Exception

Presenter

public Presenter(java.lang.String frameTitle,
                 double sizingValue)
          throws java.lang.Exception

Standard constructor for the Presenter class

Parameters:

frameTitle - title for the frame

sizingValue - controls whether sizing occurs with a width/height ratio (greater than 0), to the full screen (0), or not at all (less than 0);

Throws:

java.lang.Exception

Presenter

public Presenter(java.lang.String frameTitle,
                 PresenterPanel aPanel)
          throws java.lang.Exception

Standard constructor for the Presenter class

Parameters:

frameTitle - title for the frame

aPanel - the panel to display the content

Throws:

java.lang.Exception

Presenter

public Presenter(java.lang.String frameTitle,
                 double sizingValue,
                 PresenterPanel aPanel)
          throws java.lang.Exception

Standard constructor for the Presenter class

Parameters:

frameTitle - title for the frame

sizingValue - controls whether sizing occurs with a width/height ratio (greater than 0), to the full screen (0), or not at all (less than 0);

aPanel - the panel to display the content

Throws:

java.lang.Exception

Method Detail

initializeCanvas

public void initializeCanvas()
                      throws java.lang.Exception

initializes the canvas

Throws:

java.lang.Exception

makeCanvasPanel

public javax.swing.JComponent makeCanvasPanel()
                                       throws java.lang.Exception

makes the main canvas panel

Throws:

java.lang.Exception

makePresenterPanel

public PresenterPanel makePresenterPanel()
                                  throws java.lang.Exception

creates the Panel for presenting the active data

Throws:

java.lang.Exception

setScalesForPanel

public void setScalesForPanel(PresenterPanel aPanel)
                       throws java.lang.Exception

creates the Panel for presenting the active data

Throws:

java.lang.Exception

setPresenterPanel

public void setPresenterPanel(PresenterPanel aPanel)
                       throws java.lang.Exception

sets the panel for the presenter

Parameters:

aPanel - the panel to display the content

Throws:

java.lang.Exception

addFileMenuItems

public void addFileMenuItems()

adds the file menu items

addEditMenuItems

public void addEditMenuItems()

addMenus

public void addMenus()

adds menus to the JFrame

handleQuit

public void handleQuit()

handles a quit event

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent newEvent)

ActionListener interface (for menus)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

newEvent - the event to handle

doNew

public void doNew()

handles a new Document event

doOpen

public void doOpen()

handles an open Document event

doClose

public void doClose()

handles a close Document event

saveToSVGFile

public void saveToSVGFile(java.lang.String filePath)

saves the content of the PresenterPanel to an SVG file

doSave

public void doSave()

handles a save Document event

doSaveAs

public void doSaveAs()

handles a save as ... Document event

doUndo

public void doUndo()

handles an undo event

doCut

public void doCut()

handles a cut event

doCopy

public void doCopy()

handles a copy event

doPaste

public void doPaste()

handles a paste event

doClear

public void doClear()

handles a clear event

doSelectAll

public void doSelectAll()

handles a select all event

maxWindowSize

public java.awt.Dimension maxWindowSize()

scales the frame to the full screen available

maxWindowRatioSize

public java.awt.Dimension maxWindowRatioSize(double aWidthHeightRatio)

scales the frame with a given width/height ratio to the full screen

Parameters:

aWidthHeightRatio - the requested ratio for width to height of the frame

setFrameSize

public void setFrameSize(double sizeValue)
                  throws java.lang.Exception

scales the frame to a given screen size

Parameters:

sizeValue - controls whether sizing occurs with a width/height ratio (greater than 0), to the full screen (0), or not at all (less than 0);

Throws:

java.lang.Exception

setPlotDimensions

public void setPlotDimensions()
                       throws java.lang.Exception

sets the plot dimensions

Throws:

java.lang.Exception

asHistogram

public void asHistogram(ContingencyTable theTable)
                 throws java.lang.Exception

coordinates a JFrame with a circular graph for the provided angles

Parameters:

theTable - the distribution of angles

Throws:

java.lang.Exception

asColorHistogram

public void asColorHistogram(ContingencyTable theTable)
                      throws java.lang.Exception

coordinates a JFrame with a histogram for the provided table

Parameters:

theTable - the distribution of angles

Throws:

java.lang.Exception

asColorHistogram

public void asColorHistogram(ContingencyTable theTable,
                             boolean labelBars)
                      throws java.lang.Exception

coordinates a JFrame with a histogram for the provided table

Parameters:

theTable - the distribution of angles

labelBars - plot labels for the bars

Throws:

java.lang.Exception

asXYPlot

public void asXYPlot(NumberVariable theXs,
                     NumberVariable theYs)
              throws java.lang.Exception

coordinates a JFrame with a spatial map graph for the provided captures

Parameters:

theXs - the x coordinates of the captures to plot

theYs - the y coordinates of the captures to plot

Throws:

java.lang.Exception

asXYPlot

public void asXYPlot(NumberVariable theXs,
                     NumberVariable theYs,
                     boolean xDir,
                     boolean yDir)
              throws java.lang.Exception

coordinates a JFrame with a spatial map graph for the provided captures

Parameters:

theXs - the x coordinates of the captures to plot

theYs - the y coordinates of the captures to plot

xDir - is the direction of the grid

yDir - is the direction of the grid

Throws:

java.lang.Exception

asXYPlot

public void asXYPlot(com.lobsterman.JavaGrinders.spatial.GridSpace3D theGridSpace)
              throws java.lang.Exception

coordinates a JFrame with a spatial map graph for the provided captures

Parameters:

theGridSpace - the Gridspace3D to use

Throws:

java.lang.Exception

asXYPlot

public void asXYPlot(NumberVariable theXs,
                     NumberVariable theYs,
                     com.lobsterman.JavaGrinders.spatial.GridSpace3D theGridSpace)
              throws java.lang.Exception

coordinates a JFrame with a spatial map graph for the provided captures

Parameters:

theXs - the x coordinates of the captures to plot

theYs - the y coordinates of the captures to plot

theGridSpace - the Gridspace3D to use

Throws:

java.lang.Exception

asXYPlot

public void asXYPlot(NumberVariable theXs,
                     NumberVariable theYs,
                     com.lobsterman.JavaGrinders.spatial.GridSpace3D theGridSpace,
                     boolean connected)
              throws java.lang.Exception

coordinates a JFrame with a spatial map graph for the provided captures

Parameters:

theXs - the x coordinates of the captures to plot

theYs - the y coordinates of the captures to plot

theGridSpace - the Gridspace3D to use

Throws:

java.lang.Exception

asCircularGraph

public void asCircularGraph(com.lobsterman.JavaGrinders.spatial.AngleVariable theAngles)
                     throws java.lang.Exception

coordinates a JFrame with a circular graph for the provided angles

Parameters:

theAngles - the angles to plot

Throws:

java.lang.Exception

asSpatialMap

public void asSpatialMap(com.lobsterman.JavaGrinders.spatial.CaptureVariable theCaptures,
                         boolean xDir,
                         boolean yDir)
                  throws java.lang.Exception

coordinates a JFrame with a spatial map graph for the provided captures

Parameters:

theCaptures - the captures to plot

Throws:

java.lang.Exception

asSpatialMap

public void asSpatialMap(com.lobsterman.JavaGrinders.spatial.CaptureVariable theCaptures,
                         com.lobsterman.JavaGrinders.spatial.GridSpace3D theGridSpace)
                  throws java.lang.Exception

coordinates a JFrame with a spatial map graph for the provided captures

Parameters:

theCaptures - the captures to plot

theGridSpace - the GridSpace to use

Throws:

java.lang.Exception

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

main routine

Throws:

java.lang.Exception