Package org.opensourcephysics.tools

Class AbstractAutoloadManager

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.opensourcephysics.tools.AbstractAutoloadManager

public abstract class AbstractAutoloadManager
extends javax.swing.JDialog

A dialog for managing autoloadable functions for a FunctionTool. The functions are organized by directory and fileName. Each function is described by a name, expression and optional descriptor (eg track type for TrackDataBuilder.AutoloadManager).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractAutoloadManager.SearchPathDialog	A dialog to add and remove search paths

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

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

java.awt.Container.AccessibleAWTContainer

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 javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	initialized

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from interface java.awt.image.ImageObserver

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

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAutoloadManager(javax.swing.JDialog dialog)	Constructor for a dialog, typically a FunctionTool.

Method Summary

Modifier and Type	Method	Description
void	addSearchPath(java.lang.String dir)	Add a search path.
protected void	createGUI()	Creates the GUI.
protected abstract TristateCheckBox.State	getFileSelectionState(java.lang.String filePath)	Gets the selection state of a file.
java.util.Collection<java.lang.String>	getSearchPaths()	Gets the collection (shallow clone) of search paths.
protected abstract boolean	isFunctionSelected(java.lang.String filePath, java.lang.String[] function)	Gets the selection state of a function.
protected abstract void	refreshAutoloadData()	Refreshes the autoload data.
protected void	refreshFunctionList()	Refreshes the function list.
protected void	refreshGUI()	Refreshes the GUI including locale-based resource strings.
void	setAutoloadData(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.ArrayList<java.lang.String[]>>> data)	Sets the autoload data.
protected abstract void	setFileSelected(java.lang.String filePath, boolean select)	Sets the selection state of a file.
void	setFontLevel(int level)	Sets the font level.
protected abstract void	setFunctionSelected(java.lang.String filePath, java.lang.String[] function, boolean select)	Sets the selection state of a function.
void	setInstructions(java.lang.String instructions)	Sets the instructions describing how to use this manager.

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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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.Dialog

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

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.lang.Object

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

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

Field Detail

initialized

protected boolean initialized

Constructor Detail

AbstractAutoloadManager

protected AbstractAutoloadManager(javax.swing.JDialog dialog)

Constructor for a dialog, typically a FunctionTool.

Parameters:

dialog - the dialog

Method Detail

setAutoloadData

public void setAutoloadData(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.ArrayList<java.lang.String[]>>> data)

Sets the autoload data. The data is a map of directory path to directory contents, where directory contents is a map of file path to file contents, file contents is a list of function arrays, and each function array is {String name, String expression, optional String descriptor)

Parameters:

data - the data

setInstructions

public void setInstructions(java.lang.String instructions)

Sets the instructions describing how to use this manager.

Parameters:

instructions - the instructions

addSearchPath

public void addSearchPath(java.lang.String dir)

Add a search path.

Parameters:

dir - the (directory) search path to add

getSearchPaths

public java.util.Collection<java.lang.String> getSearchPaths()

Gets the collection (shallow clone) of search paths.

Returns:

the search paths

createGUI

protected void createGUI()

Creates the GUI.

refreshGUI

protected void refreshGUI()

Refreshes the GUI including locale-based resource strings.

refreshFunctionList

protected void refreshFunctionList()

Refreshes the function list.

setFontLevel

public void setFontLevel(int level)

Sets the font level.

Parameters:

level - the desired font level

setFunctionSelected

protected abstract void setFunctionSelected(java.lang.String filePath,
                                            java.lang.String[] function,
                                            boolean select)

Sets the selection state of a function.

Parameters:

filePath - the path to the file defining the function

function - the function {name, expression, optional descriptor}

select - true to select the function

isFunctionSelected

protected abstract boolean isFunctionSelected(java.lang.String filePath,
                                              java.lang.String[] function)

Gets the selection state of a function.

Parameters:

filePath - the path to the file defining the function

function - the function {name, expression, optional descriptor}

Returns:

true if the function is selected

setFileSelected

protected abstract void setFileSelected(java.lang.String filePath,
                                        boolean select)

Sets the selection state of a file.

Parameters:

filePath - the path to the file

select - true to select the file

getFileSelectionState

protected abstract TristateCheckBox.State getFileSelectionState(java.lang.String filePath)

Gets the selection state of a file.

Parameters:

filePath - the path to the file

Returns:

TristateCheckBox.SELECTED, NOT_SELECTED or PART_SELECTED

refreshAutoloadData

protected abstract void refreshAutoloadData()

Refreshes the autoload data.