Package adams.gui.visualization.core

Class PaintablePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.visualization.core.PaintablePanel

All Implemented Interfaces:

PaintListener, PaintletManager, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

AbstractScatterPlot, DataContainerPanel, DataPoolPanel, Histogram, NormalPlot, ProbabilityPlot, VersusFit, VersusOrder, ZScore

public abstract class PaintablePanel
extends BasePanel
implements PaintListener, PaintletManager

An abstract superclass for panels that paint "stuff", e.g., plots.

Version:

$Revision$

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 HashSet<Paintlet>	m_Paintlets	additional paintlets to execute.

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
PaintablePanel()

Method Summary

Modifier and Type	Method	Description
void	addPaintlet(Paintlet p)	Adds the paintlet to the internal list.
boolean	canHandleFixedLabels()	Returns whether the panel can handle fixed lables for its axes.
protected abstract boolean	canPaint(Graphics g)	Returns true if the paintlets can be executed.
protected void	check()	Performs some setup checks.
abstract PlotPanel	getPlot()	Returns the plot panel of the panel, null if no panel present.
protected void	initialize()	Initializes the members.
protected void	paint(Graphics g, PaintEvent.PaintMoment moment)	Executes all paintlets of the specified paint moment.
void	painted(PaintEvent e)	draws the data.
Iterator<Paintlet>	paintlets()	Returns an iterator over all currently stored paintlets.
protected void	performUpdate()	Performs the actual update.
protected void	postUpdate()	Hook method, called after the update was performed.
protected abstract void	prepareUpdate()	Prepares the update, i.e., calculations etc.
void	printAll(Graphics g)	Invoke this method to print the component.
void	removePaintlet(Paintlet p)	Removes this paintlet from its internal list.
void	update()	Updates the display.

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, finishInit, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, initGUI, 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, 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, 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

Field Detail

m_Paintlets

protected HashSet<Paintlet> m_Paintlets

additional paintlets to execute.

Constructor Detail

PaintablePanel

public PaintablePanel()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class BasePanel

addPaintlet

public void addPaintlet(Paintlet p)

Adds the paintlet to the internal list.

Specified by:

addPaintlet in interface PaintletManager

Parameters:

p - the paintlet to add.

removePaintlet

public void removePaintlet(Paintlet p)

Removes this paintlet from its internal list.

Specified by:

removePaintlet in interface PaintletManager

Parameters:

p - the paintlet to remove

paintlets

public Iterator<Paintlet> paintlets()

Returns an iterator over all currently stored paintlets.

Specified by:

paintlets in interface PaintletManager

Returns:

the paintlets

canHandleFixedLabels

public boolean canHandleFixedLabels()

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

Default implementation returns false.

Returns:

true if panel can handle it

getPlot

public abstract PlotPanel getPlot()

Returns the plot panel of the panel, null if no panel present.

Returns:

the plot panel

check

protected void check()

Performs some setup checks.

prepareUpdate

protected abstract void prepareUpdate()

Prepares the update, i.e., calculations etc.

performUpdate

protected void performUpdate()

Performs the actual update.

postUpdate

protected void postUpdate()

Hook method, called after the update was performed.

Default implementation does nothing.

update

public void update()

Updates the display.

canPaint

protected abstract boolean canPaint(Graphics g)

Returns true if the paintlets can be executed.

Parameters:

g - the graphics context

Returns:

true if painting can go ahead

paint

protected void paint(Graphics g,
                     PaintEvent.PaintMoment moment)

Executes all paintlets of the specified paint moment.

Parameters:

g - the graphics context

moment - the paint moment

painted

public void painted(PaintEvent e)

draws the data.

Specified by:

painted in interface PaintListener

Parameters:

e - the paint event

printAll

public void printAll(Graphics g)

Invoke this method to print the component. This method invokes print on the component.

Overrides:

printAll in class JComponent

Parameters:

g - the Graphics context in which to paint