Package adams.gui.visualization.sequence

Class XYSequencePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.visualization.core.PaintablePanel

adams.gui.visualization.container.DataContainerPanel<T,M>

adams.gui.visualization.container.DataContainerPanelWithSidePanel<T,M>

adams.gui.visualization.container.DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>

adams.gui.visualization.sequence.XYSequencePanel

All Implemented Interfaces:

CleanUpHandler, StatusMessageHandler, DatabaseConnectionHandler, DatabaseConnectionProvider, DatabaseConnectionUser, DatabaseConnectionChangeListener, PopupMenuCustomizer<MouseEvent>, DataChangeListener, PaintListener, ScriptingEngineHandler, SendToActionSupporter, ContainerListManager<XYSequenceContainerManager>, ContainerListPopupMenuSupplier<XYSequenceContainerManager,XYSequenceContainer>, PaintletManager, TipTextCustomizer, PopupMenuCustomizer, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

SequencePlotterPanel

public class XYSequencePanel
extends DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>
implements PaintListener, TipTextCustomizer

A panel for displaying XY sequences.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_AdjustToVisibleData	whether to adjust to visible data or not.
protected boolean	m_AllowResize	whether user can resize dialog.
protected CoordinatesPaintlet	m_CoordinatesPaintlet	paintlet for drawing the X-axis.
protected XYSequenceExportDialog	m_ExportDialog	the GOE dialog for saving the visible sequences.
protected SpreadSheetFileChooser	m_FileChooser	the file chooser for saving a specific sequence.
protected Undo	m_Undo	the undo manager.
protected List<SpreadSheetDialog>	m_ViewDialogs	the dialog for displaying a sequence.
protected XYSequencePaintlet	m_XYSequencePaintlet	paintlet for drawing the sequence data.

Fields inherited from class adams.gui.visualization.container.DataContainerPanelWithContainerList

m_ContainerList, m_ContainerListCustomizers, m_PlotCustomizers

Fields inherited from class adams.gui.visualization.container.DataContainerPanelWithSidePanel

m_FirstRevalidate, m_SidePanel, m_SplitPane

Fields inherited from class adams.gui.visualization.container.DataContainerPanel

m_DatabaseConnection, m_DataChangeListeners, m_Manager, m_PanelProperties, m_PlotPanel, m_PlotWrapperPanel, m_StatusMessageHandler, m_Title

Fields inherited from class adams.gui.visualization.core.PaintablePanel

m_Paintlets

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

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

Constructor Summary

Constructors

Constructor	Description
XYSequencePanel()	Initializes the panel with no title.
XYSequencePanel(String title)	Initializes the panel with the specified title.

Method Summary

Modifier and Type	Method	Description
boolean	canHandleFixedLabels()	Returns whether the panel can handle fixed lables for its axes.
protected boolean	canPaint(Graphics g)	Returns true if the paintlets can be executed.
void	cleanUp()	Cleans up data structures, frees up memory.
protected XYSequenceContainerList	createContainerList()	Returns the container list.
boolean	getAdjustToVisibleData()	Returns whether the display is adjusted to only the visible spectrums or all of them.
boolean	getAllowResize()	Returns whether the user can reize the plot (actually the parent dialog/frame) via the popup menu.
BasePopupMenu	getContainerListPopupMenu(ContainerTable table, int row)	Returns a popup menu for the table of the spectrum list.
XYSequencePaintlet	getContainerPaintlet()	Returns the paintlet used for painting the containers.
XYSequencePaintlet	getDataPaintlet()	Returns the paintlet used for painting the data.
protected AbstractDatabaseConnection	getDefaultDatabaseConnection()	Returns the default database connection.
AbstractScriptingEngine	getScriptingEngine()	Returns the current scripting engine, can be null.
AbstractContainerManager	getSequenceManager()	Returns the current container manager.
Undo	getUndo()	Returns the current undo manager, can be null.
protected void	initGUI()	Initializes the GUI.
protected void	initialize()	Initializes the members.
boolean	isAntiAliasingEnabled()	Returns whether anti-aliasing is used.
boolean	isUndoSupported()	Returns whether an Undo manager is currently available.
protected XYSequenceContainerManager	newContainerManager()	Returns the container manager to use.
void	prepareUpdate()	Updates the axes with the min/max of the new data.
String	processTipText(PlotPanel panel, Point mouse, String tiptext)	Processes the given tip text.
void	resizePlot(Dimension size)	Resizes the plot (actually the parent dialog/frame) to the new dimensions.
void	saveSequence(XYSequenceContainer cont)	Saves the specified sequence as spreadsheet file.
protected void	saveVisible(double[] xRange, double[] yRange)	Saves all the visible sequences to a directory with a user-specified spreadsheet writer.
void	saveVisibleDataPoints()	Saves all the visible data points to a directory with a user-specified spreadsheet writer.
void	saveVisibleSequences()	Saves all the visible sequences to a directory with a user-specified spreadsheet writer.
void	setAdjustToVisibleData(boolean value)	Sets whether the display is adjusted to only the visible data or everything currently loaded.
void	setAllowResize(boolean value)	Sets whether the user can resize the plot (actually the parent dialog/frame) via the popup menu.
void	setAntiAliasingEnabled(boolean value)	Sets whether to use anti-aliasing.
void	setDataPaintlet(Paintlet value)	Sets the paintlet to use for painting the data.
void	setUndo(Undo value)	Sets the undo manager to use, can be null if no undo-support wanted.
void	showResizeDialog()	Shows a dialog that allows the user to resize the plot.
void	storeColorInReport(int[] indices, String name)	Does nothing.
void	storeValueInReport(int[] indices, AbstractField field, Object value)	Stores the value in the report of container's data object.
boolean	supportsStoreColorInReport()	Returns true if storing the color in the report of container's data object is supported.
boolean	supportsStoreValueInReport()	Returns true if storing a value in the report of container's data object is supported.
void	viewSequence(XYSequenceContainer cont)	Views the specified sequence in a table.

Methods inherited from class adams.gui.visualization.container.DataContainerPanelWithContainerList

customizePopupMenu, getActualSelectedContainerIndices, getContainerList, getSelectedContainerIndices, getTableModelContainers, getTableModelIndices, processAction, showNotes

Methods inherited from class adams.gui.visualization.container.DataContainerPanelWithSidePanel

getDividerLocation, getSidePanel, isSidePanelVisible, revalidate, setDividerLocation, setDividerLocation, setSidePanelVisible

Methods inherited from class adams.gui.visualization.container.DataContainerPanel

databaseConnectionStateChanged, dataChanged, finishInit, getBackgroundColor, getContainerManager, getDatabaseConnection, getForegroundColor, getPlot, getProperties, getSendToClasses, getSendToItem, getStatusMessageHandler, getTitle, hasSendToItem, reset, setBackgroundColor, setContainerManager, setDatabaseConnection, setForegroundColor, setStatusMessageHandler, setTitle, showStatus

Methods inherited from class adams.gui.visualization.core.PaintablePanel

addPaintlet, check, paint, painted, paintlets, performUpdate, postUpdate, printAll, removePaintlet, update

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, main, printErrorMessage, printException, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, 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, 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, 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, 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.lang.Object

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

Methods inherited from interface adams.gui.event.PaintListener

painted

Field Detail

m_XYSequencePaintlet

protected XYSequencePaintlet m_XYSequencePaintlet

paintlet for drawing the sequence data.

m_CoordinatesPaintlet

protected CoordinatesPaintlet m_CoordinatesPaintlet

paintlet for drawing the X-axis.

m_Undo

protected Undo m_Undo

the undo manager.

m_AdjustToVisibleData

protected boolean m_AdjustToVisibleData

whether to adjust to visible data or not.

m_AllowResize

protected boolean m_AllowResize

whether user can resize dialog.

m_FileChooser

protected SpreadSheetFileChooser m_FileChooser

the file chooser for saving a specific sequence.

m_ExportDialog

protected XYSequenceExportDialog m_ExportDialog

the GOE dialog for saving the visible sequences.

m_ViewDialogs

protected List<SpreadSheetDialog> m_ViewDialogs

the dialog for displaying a sequence.

Constructor Detail

XYSequencePanel

public XYSequencePanel()

Initializes the panel with no title.

XYSequencePanel

public XYSequencePanel(String title)

Initializes the panel with the specified title.

Parameters:

title - the title to use

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>

canHandleFixedLabels

public boolean canHandleFixedLabels()

Returns whether the panel can handle fixed lables for its axes.

Overrides:

canHandleFixedLabels in class PaintablePanel

Returns:

true if panel can handle it

getDefaultDatabaseConnection

protected AbstractDatabaseConnection getDefaultDatabaseConnection()

Returns the default database connection.

Specified by:

getDefaultDatabaseConnection in class DataContainerPanel<XYSequence,XYSequenceContainerManager>

Returns:

the default database connection

newContainerManager

protected XYSequenceContainerManager newContainerManager()

Returns the container manager to use.

Specified by:

newContainerManager in class DataContainerPanel<XYSequence,XYSequenceContainerManager>

Returns:

the container manager

getContainerPaintlet

public XYSequencePaintlet getContainerPaintlet()

Returns the paintlet used for painting the containers.

Specified by:

getContainerPaintlet in class DataContainerPanel<XYSequence,XYSequenceContainerManager>

Returns:

the paintlet

initGUI

protected void initGUI()

Initializes the GUI.

Overrides:

initGUI in class DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>

createContainerList

protected XYSequenceContainerList createContainerList()

Returns the container list.

Specified by:

createContainerList in class DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>

Returns:

the list

getSequenceManager

public AbstractContainerManager getSequenceManager()

Returns the current container manager.

Returns:

the manager

getDataPaintlet

public XYSequencePaintlet getDataPaintlet()

Returns the paintlet used for painting the data.

Specified by:

getDataPaintlet in class DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>

Returns:

the paintlet

setDataPaintlet

public void setDataPaintlet(Paintlet value)

Sets the paintlet to use for painting the data.

Specified by:

setDataPaintlet in class DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>

Parameters:

value - the paintlet

setUndo

public void setUndo(Undo value)

Sets the undo manager to use, can be null if no undo-support wanted.

Parameters:

value - the undo manager to use

getUndo

public Undo getUndo()

Returns the current undo manager, can be null.

Returns:

the undo manager, if any

isUndoSupported

public boolean isUndoSupported()

Returns whether an Undo manager is currently available.

Returns:

true if an undo manager is set

canPaint

protected boolean canPaint(Graphics g)

Returns true if the paintlets can be executed.

Specified by:

canPaint in class PaintablePanel

Parameters:

g - the graphics context

Returns:

true if painting can go ahead

setAdjustToVisibleData

public void setAdjustToVisibleData(boolean value)

Sets whether the display is adjusted to only the visible data or everything currently loaded.

Parameters:

value - if true then plot is adjusted to visible data

getAdjustToVisibleData

public boolean getAdjustToVisibleData()

Returns whether the display is adjusted to only the visible spectrums or all of them.

Returns:

true if the plot is adjusted to only the visible data

prepareUpdate

public void prepareUpdate()

Updates the axes with the min/max of the new data.

Specified by:

prepareUpdate in class PaintablePanel

getContainerListPopupMenu

public BasePopupMenu getContainerListPopupMenu(ContainerTable table,
                                               int row)

Returns a popup menu for the table of the spectrum list.

Specified by:

getContainerListPopupMenu in interface ContainerListPopupMenuSupplier<XYSequenceContainerManager,XYSequenceContainer>

Overrides:

getContainerListPopupMenu in class DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>

Parameters:

table - the affected table

row - the row the mouse is currently over

Returns:

the popup menu

setAntiAliasingEnabled

public void setAntiAliasingEnabled(boolean value)

Sets whether to use anti-aliasing.

Parameters:

value - if true then anti-aliasing is used

isAntiAliasingEnabled

public boolean isAntiAliasingEnabled()

Returns whether anti-aliasing is used.

Returns:

true if anti-aliasing is used

saveVisible

protected void saveVisible(double[] xRange,
                           double[] yRange)

Saves all the visible sequences to a directory with a user-specified spreadsheet writer.

Parameters:

xRange - optional limits for X values

yRange - optional limits for Y values

saveVisibleSequences

public void saveVisibleSequences()

Saves all the visible sequences to a directory with a user-specified spreadsheet writer.

saveVisibleDataPoints

public void saveVisibleDataPoints()

Saves all the visible data points to a directory with a user-specified spreadsheet writer.

saveSequence

public void saveSequence(XYSequenceContainer cont)

Saves the specified sequence as spreadsheet file.

Parameters:

cont - the sequence to save

viewSequence

public void viewSequence(XYSequenceContainer cont)

Views the specified sequence in a table.

Parameters:

cont - the sequence to save

processTipText

public String processTipText(PlotPanel panel,
                             Point mouse,
                             String tiptext)

Processes the given tip text. Among the current mouse position, the panel that initiated the call are also provided.

Specified by:

processTipText in interface TipTextCustomizer

Parameters:

panel - the content panel that initiated this call

mouse - the mouse position

tiptext - the tiptext so far

Returns:

the processed tiptext

supportsStoreColorInReport

public boolean supportsStoreColorInReport()

Returns true if storing the color in the report of container's data object is supported.

Specified by:

supportsStoreColorInReport in class DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>

Returns:

true if supported

storeColorInReport

public void storeColorInReport(int[] indices,
                               String name)

Does nothing.

Specified by:

storeColorInReport in class DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>

Parameters:

indices - the indices of the containers of the container manager

name - the field name to use

supportsStoreValueInReport

public boolean supportsStoreValueInReport()

Returns true if storing a value in the report of container's data object is supported.

Specified by:

supportsStoreValueInReport in class DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>

Returns:

true if supported

storeValueInReport

public void storeValueInReport(int[] indices,
                               AbstractField field,
                               Object value)

Stores the value in the report of container's data object.

Specified by:

storeValueInReport in class DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>

Parameters:

indices - the indices of the containers of the container manager

field - the field to use

value - the value to store

getScriptingEngine

public AbstractScriptingEngine getScriptingEngine()

Returns the current scripting engine, can be null.

Specified by:

getScriptingEngine in interface ScriptingEngineHandler

Specified by:

getScriptingEngine in class DataContainerPanel<XYSequence,XYSequenceContainerManager>

Returns:

the current engine

setAllowResize

public void setAllowResize(boolean value)

Sets whether the user can resize the plot (actually the parent dialog/frame) via the popup menu.

Parameters:

value - if true then user can resize the plot

getAllowResize

public boolean getAllowResize()

Returns whether the user can reize the plot (actually the parent dialog/frame) via the popup menu.

Returns:

true if the user can resize the plot

showResizeDialog

public void showResizeDialog()

Shows a dialog that allows the user to resize the plot.

resizePlot

public void resizePlot(Dimension size)

Resizes the plot (actually the parent dialog/frame) to the new dimensions.

Parameters:

size - the new size

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface CleanUpHandler

Overrides:

cleanUp in class DataContainerPanelWithContainerList<XYSequence,XYSequenceContainerManager,XYSequenceContainer>