rocca

Class RoccaSidePanel.SidePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

PamView.PamPanel

PamView.PamBorderPanel

rocca.RoccaSidePanel.SidePanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, ColorManaged

Enclosing class:

RoccaSidePanel

public class RoccaSidePanel.SidePanel
extends PamBorderPanel

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, 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

Constructors

Constructor and Description
RoccaSidePanel.SidePanel()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	addASighting(boolean duplicatesOk) Ask the user for a new sighting number, and add it to the side panel
java.lang.String	addASighting(java.lang.String newSNum) Add the new sighting number to the sidepanel
void	clearSpeciesCount()
java.lang.String	createDetectionStatsHeader() Creates a string containing the header information for the detection stats file serialVersionUID=15 2014/11/12 add time parameters to header
java.lang.String	createDetectionStatsString(RoccaSightingDataUnit unit) Creates a string containing the data for the passed detection.
void	deleteSighting() Delete a detection Currently untested and not attached to any buttons
void	drawThePanel()
void	enableFlipButtons() enable/disable the sighting scroll buttons, depending on where we are in the sighting list
void	loadSighting() Load the sighting information from an existing file.
void	nextSighting()
void	prevSighting()
void	renameSightingAndFiles() Rename the sighting number and the files with that sighting number as well.
void	saveSighting() Save the sighting information immediately
void	setBackground(java.awt.Color bg)

Methods inherited from class PamView.PamBorderPanel

addComponent, getColorId, setBorder

Methods inherited from class PamView.PamPanel

getDefaultColor, getFrame, getPreferredBorderColours, layoutGrid, setDefaultColor, setPreferredBorderColour

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

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

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RoccaSidePanel.SidePanel

public RoccaSidePanel.SidePanel()

Method Detail

setBackground

public void setBackground(java.awt.Color bg)

Overrides:

setBackground in class PamPanel

drawThePanel

public void drawThePanel()

enableFlipButtons

public void enableFlipButtons()

enable/disable the sighting scroll buttons, depending on where we are in the sighting list

prevSighting

public void prevSighting()

nextSighting

public void nextSighting()

clearSpeciesCount

public void clearSpeciesCount()

renameSightingAndFiles

public void renameSightingAndFiles()

Rename the sighting number and the files with that sighting number as well. This routine sets the current sighting number to NONE, and then calls the addASighting method. Since the current sighting number is NONE, addASighting will simply change the text of the current sighting instead of creating a whole new sighting.

saveSighting

public void saveSighting()

Save the sighting information immediately

createDetectionStatsHeader

public java.lang.String createDetectionStatsHeader()

Creates a string containing the header information for the detection stats file serialVersionUID=15 2014/11/12 add time parameters to header

Returns:

a String containing the header

createDetectionStatsString

public java.lang.String createDetectionStatsString(RoccaSightingDataUnit unit)

Creates a string containing the data for the passed detection. The data includes the detection number, the counts for the current species list, the tree votes for the current species list, a species list combined into a single column as a double-check against the column headers (in case the classifier has changed), and finally the detection classification

Note that the loadSighting() method reads in the sighting stats information in the same order as shown here; if this format is changed, the loadSighting() method must be changed as well.

serialVersionUID=15 2014/11/12 tell the data unit to calculate the time params and include them in the output

Parameters:

unit - the RoccaSightingDataUnit to get the data from

Returns:

a string containing the current detection data

loadSighting

public void loadSighting()

Load the sighting information from an existing file. Note that this method assumes the csv file has the same format as the one specified in the (RoccaSightingDataUnit unit) createDetectionStatsString method. If the format in that method is ever changed, it should be changed here as well. Note also that this method does not check the existing datablock for duplicate sighting numbers. Since (at the moment) this method is only called to load a file when Pamguard starts and the datablock is empty, this isn't a problem.

serialVersionUID=15 2014/11/12 include the time parameters

deleteSighting

public void deleteSighting()

Delete a detection Currently untested and not attached to any buttons

addASighting

public java.lang.String addASighting(boolean duplicatesOk)

Ask the user for a new sighting number, and add it to the side panel

Parameters:

duplicatesOk - Boolean indicating whether or not it's ok to use duplicate sighting numbers

Returns:

the new sighting number

addASighting

public java.lang.String addASighting(java.lang.String newSNum)

Add the new sighting number to the sidepanel

Parameters:

newSNum - the new sighting number to be used

Returns:

the sighting number