Package org.opensourcephysics.tools

Class LaunchPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.opensourcephysics.tools.LaunchPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class LaunchPanel
extends JPanel

This is a panel that displays a tree with a LaunchNode root.

Version:

1.0

Author:

Douglas Brown

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 JPanel	dataPanel
protected JEditorPane	descriptionPane
protected JScrollPane	descriptionScroller
protected Map<String,String>	htmlSubstitutions
boolean	isSelectingNode
protected Launcher	launcher
protected boolean	rebuildingTabs
protected boolean	showAllNodes
protected JSplitPane	splitPane
protected JTabbedPane	tabbedPane
protected static final String	TEXT_TYPE
protected JTree	tree
protected DefaultTreeModel	treeModel
protected Map<LaunchNode,org.opensourcephysics.tools.LaunchPanel.VisibleNode>	visibleNodeMap

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
LaunchPanel(LaunchNode rootNode, Launcher launcher)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	createGUI()	Creates the GUI.
protected void	createTree(LaunchNode rootNode)	Creates the tree.
protected LaunchNode	getClone(LaunchNode node)	Returns the node with the same file name as the specified node.
protected Collection<String>	getExpandedNodes()	Returns a collection of nodes that are currently expanded.
Map<String,String>	getHTMLSubstitutionMap()	Gets the HTML substitution map.
LaunchNode	getRootNode()	Gets the root node.
int	getSelectedDisplayTab()	Gets the selected display tab.
LaunchNode	getSelectedNode()	Gets the selected node.
ArrayList<LaunchNode>	getSelectedNodes()	Gets the selected nodes.
protected void	launchHtml(Launcher.HTMLPane html, URL theURL, boolean nodeEnabled)
protected void	rebuildAndDisplayTabs(LaunchNode node)	Rebuilds the tabs from scratch in order to displays all tabs for the specified node.
protected void	setExpandedNodes(Collection<?> expanded)	Expands the specified nodes.
void	setSelectedNode(LaunchNode node, int tabNumber)	Sets the selected node.
void	setSelectedNode(LaunchNode node, int tabNumber, URL url)	Sets the selected node and displays a URL.
void	setTreeSelectionPath(LaunchNode node)	Sets the selected node.
void	setTreeSelectionPaths(ArrayList<LaunchNode> nodes)	Sets the selected nodes.

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

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 Details

TEXT_TYPE

protected static final String TEXT_TYPE

See Also:

• Constant Field Values

tree

protected JTree tree

treeModel

protected DefaultTreeModel treeModel

splitPane

protected JSplitPane splitPane

dataPanel

protected JPanel dataPanel

tabbedPane

protected JTabbedPane tabbedPane

descriptionPane

protected JEditorPane descriptionPane

descriptionScroller

protected JScrollPane descriptionScroller

showAllNodes

protected boolean showAllNodes

visibleNodeMap

protected Map<LaunchNode,org.opensourcephysics.tools.LaunchPanel.VisibleNode> visibleNodeMap

launcher

protected Launcher launcher

rebuildingTabs

protected boolean rebuildingTabs

htmlSubstitutions

protected Map<String,String> htmlSubstitutions

isSelectingNode

public boolean isSelectingNode

Constructor Details

LaunchPanel

public LaunchPanel(LaunchNode rootNode,
 Launcher launcher)

Constructor.

Parameters:

rootNode - the root node

launcher - the Launcher that is creating this panel

Method Details

setTreeSelectionPath

public void setTreeSelectionPath(LaunchNode node)

Sets the selected node.

Parameters:

node - the node to select

setTreeSelectionPaths

public void setTreeSelectionPaths(ArrayList<LaunchNode> nodes)

Sets the selected nodes.

Parameters:

nodes - the nodes to select

setSelectedNode

public void setSelectedNode(LaunchNode node,
 int tabNumber)

Sets the selected node.

Parameters:

node - the node to select

tabNumber - the tab to display

setSelectedNode

public void setSelectedNode(LaunchNode node,
 int tabNumber,
 URL url)

Sets the selected node and displays a URL. Detects if the url is a reference change only, as from a hyperlink on a page and, if so, just scrolls to that position on the page. Otherwise rebuilds the full tab system.

Parameters:

node - the node to select

tabNumber - the tab to display

url - the URL to display in the tab

getSelectedNode

public LaunchNode getSelectedNode()

Gets the selected node.

Returns:

the selected node

getSelectedNodes

public ArrayList<LaunchNode> getSelectedNodes()

Gets the selected nodes.

Returns:

the selected nodes

getSelectedDisplayTab

public int getSelectedDisplayTab()

Gets the selected display tab.

Returns:

the selected display tab

getRootNode

public LaunchNode getRootNode()

Gets the root node.

Returns:

the root node

getHTMLSubstitutionMap

public Map<String,String> getHTMLSubstitutionMap()

Gets the HTML substitution map. This maps target to replacement Strings to be substituted in HTML documents.

Returns:

the HTML substitution map

getClone

protected LaunchNode getClone(LaunchNode node)

Returns the node with the same file name as the specified node. May return null.

Parameters:

node - the node to match

Returns:

the first node with the same file name

rebuildAndDisplayTabs

protected void rebuildAndDisplayTabs(LaunchNode node)

Rebuilds the tabs from scratch in order to displays all tabs for the specified node.

Parameters:

node - the LaunchNode

launchHtml

protected void launchHtml(Launcher.HTMLPane html,
 URL theURL,
 boolean nodeEnabled)

createGUI

protected void createGUI()

Creates the GUI.

createTree

protected void createTree(LaunchNode rootNode)

Creates the tree.

Parameters:

rootNode - the root node

getExpandedNodes

protected Collection<String> getExpandedNodes()

Returns a collection of nodes that are currently expanded.

Returns:

the expanded nodes

setExpandedNodes

protected void setExpandedNodes(Collection<?> expanded)

Expands the specified nodes.

Parameters:

expanded - the nodes to expand