org.opensourcephysics.tools

Class FunctionTool

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.opensourcephysics.tools.FunctionTool

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class FunctionTool
extends javax.swing.JDialog

This tool allows users to create and manage editable Functions.

Author:

Douglas Brown

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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 javax.swing.JPanel	buttonbar
protected javax.swing.JButton	closeButton
protected javax.swing.JPanel	contentPane
protected javax.swing.JButton[]	customButtons
protected static java.awt.Dimension	dim
protected java.util.HashSet	forbiddenNames
protected java.awt.event.ActionListener	helpAction
protected java.lang.String	helpBase
protected javax.swing.JButton	helpButton
protected TextFrame	helpFrame
protected java.lang.String	helpPath
protected javax.swing.JPanel	noData
protected javax.swing.JPanel	north
protected java.util.Map	panels
protected FunctionPanel	selectedPanel
protected javax.swing.JSpinner	spinner
protected javax.swing.JLabel	spinnerLabel
protected org.opensourcephysics.tools.FunctionTool.SpinnerRollingListModel	spinnerModel
protected javax.swing.JToolBar	toolbar

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
FunctionTool(java.awt.Component comp) Constructs a tool for the specified component (may be null)
FunctionTool(java.awt.Component comp, javax.swing.JButton[] buttons) Constructs a tool with custom buttons.

Method Summary

Methods

Modifier and Type	Method and Description
void	addForbiddenNames(java.lang.String[] names) Adds names to the forbidden set.
FunctionPanel	addPanel(java.lang.String name, FunctionPanel panel) Adds a FunctionPanel.
void	clearPanels() Clears all FunctionPanels.
protected void	firePropertyChange(java.lang.String name, java.lang.Object oldObj, java.lang.Object newObj) Fires a property change.
FunctionPanel	getPanel(java.lang.String name) Returns the named FunctionPanel.
java.lang.String	getSelectedName() Returns the name of the selected FunctionPanel.
FunctionPanel	getSelectedPanel() Returns the selected FunctionPanel.
protected java.lang.String	getUniqueName(java.lang.String proposedName) Gets a unique name.
boolean	isEmpty() Reports if this is empty.
protected void	refreshGUI() Refreshes the GUI.
FunctionPanel	removePanel(java.lang.String name) Removes a named FunctionPanel.
FunctionPanel	renamePanel(java.lang.String prevName, java.lang.String newName) Renames a FunctionPanel.
void	setHelpAction(java.awt.event.ActionListener action) Sets the help action.
void	setHelpPath(java.lang.String path) Sets the path of the help file.
void	setSelectedPanel(java.lang.String name) Selects a FunctionPanel by name.
void	setVisible(boolean vis) Overrides JDialog setVisible method.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, 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

dim

protected static java.awt.Dimension dim

panels

protected java.util.Map panels

forbiddenNames

protected java.util.HashSet forbiddenNames

contentPane

protected javax.swing.JPanel contentPane

noData

protected javax.swing.JPanel noData

toolbar

protected javax.swing.JToolBar toolbar

spinnerLabel

protected javax.swing.JLabel spinnerLabel

spinnerModel

protected org.opensourcephysics.tools.FunctionTool.SpinnerRollingListModel spinnerModel

spinner

protected javax.swing.JSpinner spinner

north

protected javax.swing.JPanel north

selectedPanel

protected FunctionPanel selectedPanel

helpButton

protected javax.swing.JButton helpButton

closeButton

protected javax.swing.JButton closeButton

buttonbar

protected javax.swing.JPanel buttonbar

customButtons

protected javax.swing.JButton[] customButtons

helpPath

protected java.lang.String helpPath

helpBase

protected java.lang.String helpBase

helpFrame

protected TextFrame helpFrame

helpAction

protected java.awt.event.ActionListener helpAction

Constructor Detail

FunctionTool

public FunctionTool(java.awt.Component comp)

Constructs a tool for the specified component (may be null)

Parameters:

comp - Component used to get Frame owner of this Dialog

FunctionTool

public FunctionTool(java.awt.Component comp,
            javax.swing.JButton[] buttons)

Constructs a tool with custom buttons.

Parameters:

comp - Component used to get Frame owner of this Dialog

buttons - an array of custom buttons

Method Detail

addPanel

public FunctionPanel addPanel(java.lang.String name,
                     FunctionPanel panel)

Adds a FunctionPanel.

Parameters:

name - a descriptive name

panel - the FunctionPanel

Returns:

the added panel

removePanel

public FunctionPanel removePanel(java.lang.String name)

Removes a named FunctionPanel.

Parameters:

name - the name

Returns:

the removed panel, if any

renamePanel

public FunctionPanel renamePanel(java.lang.String prevName,
                        java.lang.String newName)

Renames a FunctionPanel.

Parameters:

prevName - the previous name

newname - the new name

Returns:

the renamed panel

setSelectedPanel

public void setSelectedPanel(java.lang.String name)

Selects a FunctionPanel by name.

Parameters:

name - the name

getSelectedName

public java.lang.String getSelectedName()

Returns the name of the selected FunctionPanel.

Returns:

the name

getSelectedPanel

public FunctionPanel getSelectedPanel()

Returns the selected FunctionPanel.

Parameters:

name - the name

Returns:

the FunctionPanel

getPanel

public FunctionPanel getPanel(java.lang.String name)

Returns the named FunctionPanel.

Parameters:

name - the name

Returns:

the FunctionPanel

clearPanels

public void clearPanels()

Clears all FunctionPanels.

addForbiddenNames

public void addForbiddenNames(java.lang.String[] names)

Adds names to the forbidden set.

setVisible

public void setVisible(boolean vis)

Overrides JDialog setVisible method.

Overrides:

setVisible in class java.awt.Dialog

Parameters:

vis - true to show this inspector

setHelpPath

public void setHelpPath(java.lang.String path)

Sets the path of the help file.

Parameters:

path - a filename or url

setHelpAction

public void setHelpAction(java.awt.event.ActionListener action)

Sets the help action. this will replace the current help action

Parameters:

action - a custom help action

isEmpty

public boolean isEmpty()

Reports if this is empty.

Returns:

true if empty

firePropertyChange

protected void firePropertyChange(java.lang.String name,
                      java.lang.Object oldObj,
                      java.lang.Object newObj)

Fires a property change. This makes this method visible to the tools package.

Overrides:

firePropertyChange in class java.awt.Component

refreshGUI

protected void refreshGUI()

Refreshes the GUI.

getUniqueName

protected java.lang.String getUniqueName(java.lang.String proposedName)

Gets a unique name.

Parameters:

proposedName - the proposed name

Returns:

the unique name