xal.extension.widgets.apputils

Class SimpleChartPopupMenu

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPopupMenu

xal.extension.widgets.apputils.SimpleChartPopupMenu

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.MenuElement

public class SimpleChartPopupMenu
extends javax.swing.JPopupMenu
implements java.awt.event.MouseListener

Popup menu that can be attached to a Chart to provide common actions for the user. Supported chart types must have a ChartPopupAdaptor and an associated constructor in this class. If you want the menu to appear with a popup event, then you must add it as a mouse listener of the target view. Alternatively you can use one of the static convenience methods: addPopupMenuTo() to both create the popup menu and add it as a mouse listener to the chart.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPopupMenu.AccessibleJPopupMenu, javax.swing.JPopupMenu.Separator

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

javax.swing.JComponent.AccessibleJComponent

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
protected java.util.Map<java.lang.String,javax.swing.Action>	_actionTable
protected java.awt.Component	_chart
protected ChartPopupAdaptor	chartAdaptor
protected SimpleChartDialog	chartDialog
protected javax.swing.JFileChooser	fileChooser
static java.lang.String	IMAGE_CAPTURE_ID
protected javax.swing.Action	imageCaptureAction
static java.lang.String	OPTIONS_DIALOG_ID
protected javax.swing.Action	optionsAction
static java.lang.String	SCALE_ONCE_ID
protected javax.swing.Action	scaleOnceAction
static java.lang.String	X_AUTOSCALE_ID
static java.lang.String	X_GRID_ID
protected javax.swing.Action	xAutoScaleAction
protected javax.swing.Action	xGridAction
static java.lang.String	Y_AUTOSCALE_ID
static java.lang.String	Y_GRID_ID
protected javax.swing.Action	yAutoScaleAction
protected javax.swing.Action	yGridAction

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
SimpleChartPopupMenu(java.awt.Component aChart, ChartPopupAdaptor anAdaptor) Primary constructor
SimpleChartPopupMenu(FunctionGraphsJPanel aChart) Create a simple chart popup menu for a FunctionGraphsJPanel chart

Method Summary

Modifier and Type	Method and Description
static SimpleChartPopupMenu	addPopupMenuTo(java.awt.Component aChart, ChartPopupAdaptor anAdaptor) Convenience method for creating a SimpleChartPopupMenu and adding it as a menu listener to the chart.
static SimpleChartPopupMenu	addPopupMenuTo(FunctionGraphsJPanel aChart) Convenience method for creating a SimpleChartPopupMenu and adding it as a menu listener to the chart.
protected void	buildMenu() Build the popup menu by adding all of the defined actions
protected void	defineActions() Define the actions for the popup menu
void	handleMouseEvent(java.awt.event.MouseEvent event) handle the mouse event
protected void	initComponents() Create and initialize the GUI components
void	mouseClicked(java.awt.event.MouseEvent event) implement MouseListener interface
void	mouseEntered(java.awt.event.MouseEvent event) implement MouseListener interface
void	mouseExited(java.awt.event.MouseEvent event) implement MouseListener interface
void	mousePressed(java.awt.event.MouseEvent event) implement MouseListener interface
void	mouseReleased(java.awt.event.MouseEvent event) implement MouseListener interface
void	setActionEnabled(java.lang.String actionID, boolean enableState) Enable/Disable the action specified by the actionID.
protected void	setup() Initialize the popup menu.
protected void	storeActions() Put the actions in the table.
protected void	update() Update the components to reflect the state of the chart

Methods inherited from class javax.swing.JPopupMenu

add, add, add, addMenuKeyListener, addPopupMenuListener, addSeparator, createActionChangeListener, createActionComponent, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getComponent, getComponentAtIndex, getComponentIndex, getDefaultLightWeightPopupEnabled, getInvoker, getLabel, getMargin, getMenuKeyListeners, getPopupMenuListeners, getSelectionModel, getSubElements, getUI, getUIClassID, insert, insert, isBorderPainted, isLightWeightPopupEnabled, isPopupTrigger, isVisible, menuSelectionChanged, pack, paintBorder, paramString, processFocusEvent, processKeyEvent, processKeyEvent, processMouseEvent, remove, removeMenuKeyListener, removePopupMenuListener, setBorderPainted, setDefaultLightWeightPopupEnabled, setInvoker, setLabel, setLightWeightPopupEnabled, setLocation, setPopupSize, setPopupSize, setSelected, setSelectionModel, setUI, setVisible, show, 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, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, 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, 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, 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, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, 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, 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

SCALE_ONCE_ID

public static final java.lang.String SCALE_ONCE_ID

See Also:

Constant Field Values

X_AUTOSCALE_ID

public static final java.lang.String X_AUTOSCALE_ID

See Also:

Constant Field Values

Y_AUTOSCALE_ID

public static final java.lang.String Y_AUTOSCALE_ID

See Also:

Constant Field Values

X_GRID_ID

public static final java.lang.String X_GRID_ID

See Also:

Constant Field Values

Y_GRID_ID

public static final java.lang.String Y_GRID_ID

See Also:

Constant Field Values

OPTIONS_DIALOG_ID

public static final java.lang.String OPTIONS_DIALOG_ID

See Also:

Constant Field Values

IMAGE_CAPTURE_ID

public static final java.lang.String IMAGE_CAPTURE_ID

See Also:

Constant Field Values

chartAdaptor

protected ChartPopupAdaptor chartAdaptor

_actionTable

protected java.util.Map<java.lang.String,javax.swing.Action> _actionTable

scaleOnceAction

protected javax.swing.Action scaleOnceAction

xAutoScaleAction

protected javax.swing.Action xAutoScaleAction

yAutoScaleAction

protected javax.swing.Action yAutoScaleAction

xGridAction

protected javax.swing.Action xGridAction

yGridAction

protected javax.swing.Action yGridAction

optionsAction

protected javax.swing.Action optionsAction

imageCaptureAction

protected javax.swing.Action imageCaptureAction

_chart

protected java.awt.Component _chart

chartDialog

protected SimpleChartDialog chartDialog

fileChooser

protected javax.swing.JFileChooser fileChooser

Constructor Detail

SimpleChartPopupMenu

public SimpleChartPopupMenu(java.awt.Component aChart,
                            ChartPopupAdaptor anAdaptor)

Primary constructor

SimpleChartPopupMenu

public SimpleChartPopupMenu(FunctionGraphsJPanel aChart)

Create a simple chart popup menu for a FunctionGraphsJPanel chart

Method Detail

addPopupMenuTo

public static SimpleChartPopupMenu addPopupMenuTo(java.awt.Component aChart,
                                                  ChartPopupAdaptor anAdaptor)

Convenience method for creating a SimpleChartPopupMenu and adding it as a menu listener to the chart.

Parameters:

aChart - The chart to manage

anAdaptor - The chart popup adaptor to use

Returns:

The popup menu instance

addPopupMenuTo

public static SimpleChartPopupMenu addPopupMenuTo(FunctionGraphsJPanel aChart)

Convenience method for creating a SimpleChartPopupMenu and adding it as a menu listener to the chart.

Parameters:

aChart - The chart to manage

Returns:

The popup menu instance

setup

protected void setup()

Initialize the popup menu.

initComponents

protected void initComponents()

Create and initialize the GUI components

defineActions

protected void defineActions()

Define the actions for the popup menu

storeActions

protected void storeActions()

Put the actions in the table.

buildMenu

protected void buildMenu()

Build the popup menu by adding all of the defined actions

update

protected void update()

Update the components to reflect the state of the chart

setActionEnabled

public void setActionEnabled(java.lang.String actionID,
                             boolean enableState)

Enable/Disable the action specified by the actionID.

Parameters:

actionID - The id of the action to enable/disable.

enableState - The desired enable/disable state.

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent event)

implement MouseListener interface

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent event)

implement MouseListener interface

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent event)

implement MouseListener interface

Specified by:

mouseExited in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent event)

implement MouseListener interface

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent event)

implement MouseListener interface

Specified by:

mouseReleased in interface java.awt.event.MouseListener

handleMouseEvent

public void handleMouseEvent(java.awt.event.MouseEvent event)

handle the mouse event