uk.ac.starlink.topcat.plot

Class AnnotationPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

uk.ac.starlink.topcat.plot.AnnotationPanel

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener

public class AnnotationPanel
extends JComponent
implements ActionListener

Transparent component for adding additional decoration to an existing plot component.

Since:

8 Apr 2008

Author:

Mark Taylor

See Also:

Serialized Form

Nested Class Summary

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 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 and Description
AnnotationPanel() Constructor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent evt)
void	clear() Removes any decorations associated with this panel.
void	dropInvisibles() Removes any indexes from the active point list which are not currently visible.
int[]	getActivePoints() Returns the current list of active points.
uk.ac.starlink.ttools.plot.PointPlacer	getPlacer() Returns the PointPlacer which maps from PlotData coordinates to screen positions.
protected boolean	isIncluded(uk.ac.starlink.ttools.plot.PointSequence pseq) Indicates whether the current point in a given point sequence is to be included for the purposes of annotations.
protected void	paintComponent(Graphics g)
void	setActivePoints(int[] ipoints) Sets points which should be marked as "active" by drawing a cursor or something over them.
void	setPlacer(uk.ac.starlink.ttools.plot.PointPlacer placer) Sets the PointPlacer which maps from PlotData coordinates to screen positions.
void	setPlotData(uk.ac.starlink.ttools.plot.PlotData data) Sets the data used by this panel.
void	setPulsing(boolean isPulsing) Sets whether active points should pulse or not.

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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, 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, setVisible, unregisterKeyboardAction, update, updateUI

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

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

Constructor Detail

AnnotationPanel

public AnnotationPanel()

Constructor.

Method Detail

setActivePoints

public void setActivePoints(int[] ipoints)

Sets points which should be marked as "active" by drawing a cursor or something over them.

Parameters:

ipoints - array of point indexes (indexes into current PlotData sequence)

getActivePoints

public int[] getActivePoints()

Returns the current list of active points.

Returns:

array of point indexes (indexes into current PlotData sequence)

clear

public void clear()

Removes any decorations associated with this panel.

setPlotData

public void setPlotData(uk.ac.starlink.ttools.plot.PlotData data)

Sets the data used by this panel.

Parameters:

data - plot data

setPlacer

public void setPlacer(uk.ac.starlink.ttools.plot.PointPlacer placer)

Sets the PointPlacer which maps from PlotData coordinates to screen positions.

Parameters:

placer - point placer

getPlacer

public uk.ac.starlink.ttools.plot.PointPlacer getPlacer()

Returns the PointPlacer which maps from PlotData coordinates to screen positions. This method may be overridden by subclases (in which case setPlacer(uk.ac.starlink.ttools.plot.PointPlacer) might not work).

Returns:

point placer

isIncluded

protected boolean isIncluded(uk.ac.starlink.ttools.plot.PointSequence pseq)

Indicates whether the current point in a given point sequence is to be included for the purposes of annotations.

Parameters:

pseq - point sequence

Returns:

true iff the current point of pseq is included

dropInvisibles

public void dropInvisibles()

Removes any indexes from the active point list which are not currently visible.

setPulsing

public void setPulsing(boolean isPulsing)

Sets whether active points should pulse or not.

Parameters:

isPulsing - true iff you want points to pulse

actionPerformed

public void actionPerformed(ActionEvent evt)

Specified by:

actionPerformed in interface ActionListener

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent