|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
java.awt.Window
java.awt.Frame
javax.swing.JFrame
org.opensourcephysics.display.OSPFrame
public class OSPFrame
OSPFrame is the base class for Open Source Physics JFrames such as DrawingFrame and DataTableFrame. Copyright: Copyright (c) 2002
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.swing.JFrame |
---|
javax.swing.JFrame.AccessibleJFrame |
Nested classes/interfaces inherited from class java.awt.Frame |
---|
java.awt.Frame.AccessibleAWTFrame |
Nested classes/interfaces inherited from class java.awt.Window |
---|
java.awt.Window.AccessibleAWTWindow |
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 | |
---|---|
protected boolean |
animated
Set to true if a simulation should automatically render this frame after every animation step. |
protected boolean |
autoclear
Set to true if a simulation should automatically clear the data when it is initialized. |
protected javax.swing.JPanel |
buttonPanel
|
protected java.util.Collection<javax.swing.JFrame> |
childFrames
|
java.lang.ThreadGroup |
constructorThreadGroup
The thread group that created this object. |
protected java.util.ArrayList<javax.swing.JButton> |
customButtons
|
protected boolean |
keepHidden
|
protected java.awt.image.BufferStrategy |
strategy
|
Fields inherited from class javax.swing.JFrame |
---|
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled |
Fields inherited from class java.awt.Frame |
---|
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR |
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, HIDE_ON_CLOSE |
Fields inherited from interface java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
OSPFrame()
OSPFrame constructor. |
|
OSPFrame(java.awt.Container contentPane)
OSPFrame constructor with a new content pane. |
|
OSPFrame(java.lang.String title)
OSPFrame constructor with a title. |
Method Summary | |
---|---|
javax.swing.JButton |
addButton(java.lang.String methodName,
java.lang.String text,
java.lang.String toolTipText,
java.lang.Object target)
Adds a custom button to the control's frame. |
void |
addChildFrame(javax.swing.JFrame frame)
Adds a child frame that depends on this frame. |
void |
bufferStrategyShow()
Shows (repaints) the frame useing the current BufferStrategy. |
void |
clearChildFrames()
Clears all frames from the child frame list. |
void |
clearData()
Clears data from drawing objects within this frame. |
void |
clearDataAndRepaint()
Clears data and repaints the drawing panel within this frame. |
void |
createBufferStrategy()
Creates a BufferStrategy based on the capabilites of the hardware. |
void |
dispose()
Disposes all resources. |
java.util.Collection<javax.swing.JFrame> |
getChildFrames()
Gets a copy of the ChildFrames collection. |
static javax.swing.JFileChooser |
getChooser()
Deprecated. use OSPRuntime.getChooser()<\code>. |
java.lang.ThreadGroup |
getConstructorThreadGroup()
Gets the ThreadGroup that constructed this frame. |
javax.swing.JMenu |
getMenu(java.lang.String menuName)
Gets a menu with the given name from the menu bar. |
void |
invalidateImage()
Invalidates image buffers if a drawing panel is buffered. |
boolean |
isAnimated()
Reads the animated property. |
boolean |
isAutoclear()
Reads the animated property. |
boolean |
isIconified()
Gets the ICONIFIED flag for this frame. |
boolean |
isKeepHidden()
Reads the keepHidden flag. |
protected javax.swing.JMenu |
loadDisplayMenu()
Adds a Display menu to the menu bar. |
protected javax.swing.JMenu |
loadToolsMenu()
Adds a Tools menu to the menu bar. |
void |
parseXMLMenu(java.lang.String xmlMenu)
|
void |
parseXMLMenu(java.lang.String xmlMenu,
java.lang.Class<?> type)
|
protected void |
refreshGUI()
Refreshes the user interface in response to display changes such as Language. |
javax.swing.JMenu |
removeMenu(java.lang.String menuName)
Removes a menu with the given name from the menu bar and returns the removed item. |
javax.swing.JMenuItem |
removeMenuItem(java.lang.String menuName,
java.lang.String itemName)
Removes a menu item with the given name from the menu bar and returns the removed item. |
void |
render()
Renders the frame. |
void |
setAnimated(boolean animated)
Sets the animated property. |
void |
setAutoclear(boolean autoclear)
Sets the autoclear property. |
void |
setDefaultCloseOperation(int operation)
Overrides JFrame method. |
protected void |
setFontLevel(int level)
Sets the font level. |
void |
setKeepHidden(boolean _keepHidden)
Sets the keepHidden flag. |
void |
setSize(int width,
int height)
|
void |
setTitle(java.lang.String title)
Sets the title for this frame to the specified string after converting TeX math symbols to characters. |
void |
setVisible(boolean b)
Shows or hides this component depending on the value of parameter b and the keepHidden flag. |
void |
show()
Deprecated. |
boolean |
wishesToExit()
Returns true if this frame wishes to exit. |
Methods inherited from class javax.swing.JFrame |
---|
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update |
Methods inherited from class java.awt.Frame |
---|
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setUndecorated |
Methods inherited from class java.awt.Window |
---|
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, toBack, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, isOpaque, 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, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.opensourcephysics.display.AppFrame |
---|
getDefaultCloseOperation |
Methods inherited from interface java.awt.MenuContainer |
---|
getFont, postEvent |
Field Detail |
---|
protected java.util.ArrayList<javax.swing.JButton> customButtons
protected boolean animated
protected boolean autoclear
public java.lang.ThreadGroup constructorThreadGroup
protected boolean keepHidden
protected java.awt.image.BufferStrategy strategy
protected javax.swing.JPanel buttonPanel
protected java.util.Collection<javax.swing.JFrame> childFrames
Constructor Detail |
---|
public OSPFrame(java.lang.String title)
title
- public OSPFrame()
public OSPFrame(java.awt.Container contentPane)
contentPane
- Method Detail |
---|
public static javax.swing.JFileChooser getChooser()
OSPRuntime.getChooser()<\code>.
Gets a file chooser that is the same for all OSPFrames.
- Returns:
- the chooser
setTitle
public void setTitle(java.lang.String title)
- Sets the title for this frame to the specified string after converting TeX math symbols to characters.
- Overrides:
setTitle
in class java.awt.Frame
- Parameters:
title
- the title to be displayed in the frame's border.
A null
value
is treated as an empty string, "".- See Also:
Frame.getTitle()
addChildFrame
public void addChildFrame(javax.swing.JFrame frame)
- Adds a child frame that depends on this frame.
Child frames are closed when this frame is closed.
- Parameters:
frame
- JFrame
clearChildFrames
public void clearChildFrames()
- Clears all frames from the child frame list.
getChildFrames
public java.util.Collection<javax.swing.JFrame> getChildFrames()
- Gets a copy of the ChildFrames collection.
- Returns:
- Collection
isIconified
public boolean isIconified()
- Gets the ICONIFIED flag for this frame.
- Returns:
- boolean true if frame is iconified; false otherwise
invalidateImage
public void invalidateImage()
- Invalidates image buffers if a drawing panel is buffered.
setFontLevel
protected void setFontLevel(int level)
- Sets the font level.
- Parameters:
level
- the level
isAnimated
public boolean isAnimated()
- Reads the animated property.
- Returns:
- boolean
setAnimated
public void setAnimated(boolean animated)
- Sets the animated property.
- Parameters:
animated
-
isAutoclear
public boolean isAutoclear()
- Reads the animated property.
- Returns:
- boolean
setAutoclear
public void setAutoclear(boolean autoclear)
- Sets the autoclear property.
- Parameters:
autoclear
-
loadDisplayMenu
protected javax.swing.JMenu loadDisplayMenu()
- Adds a Display menu to the menu bar.
The default method does nothing.
Override this method to create a menu item that is appropriate for the frame.
loadToolsMenu
protected javax.swing.JMenu loadToolsMenu()
- Adds a Tools menu to the menu bar.
The default method does nothing.
Override this method to create a menu item that is appropriate for the frame.
clearData
public void clearData()
- Clears data from drawing objects within this frame.
The default method does nothing.
Override this method to select the object(s) and the data to be cleared.
clearDataAndRepaint
public void clearDataAndRepaint()
- Clears data and repaints the drawing panel within this frame.
The default method does nothing.
Override this method to clear and repaint objects that have data.
setSize
public void setSize(int width,
int height)
- Overrides:
setSize
in class java.awt.Window
show
public void show()
- Deprecated.
- Shows the frame on the screen if the keep hidden flag is false.
- Overrides:
show
in class java.awt.Window
dispose
public void dispose()
- Disposes all resources.
- Overrides:
dispose
in class java.awt.Window
setVisible
public void setVisible(boolean b)
- Shows or hides this component depending on the value of parameter
b
and the keepHidden
flag.
OSP Applets often keep windows hidden.
- Overrides:
setVisible
in class java.awt.Window
- Parameters:
b
-
setKeepHidden
public void setKeepHidden(boolean _keepHidden)
- Sets the keepHidden flag.
- Specified by:
setKeepHidden
in interface Hidable
- Parameters:
_keepHidden
-
isKeepHidden
public boolean isKeepHidden()
- Reads the keepHidden flag.
- Specified by:
isKeepHidden
in interface Hidable
getConstructorThreadGroup
public java.lang.ThreadGroup getConstructorThreadGroup()
- Gets the ThreadGroup that constructed this frame.
- Returns:
- the ThreadGroup
createBufferStrategy
public void createBufferStrategy()
- Creates a BufferStrategy based on the capabilites of the hardware.
bufferStrategyShow
public void bufferStrategyShow()
- Shows (repaints) the frame useing the current BufferStrategy.
render
public void render()
- Renders the frame. Subclass this method to render the contents of this frame in the calling thread.
getMenu
public javax.swing.JMenu getMenu(java.lang.String menuName)
- Gets a menu with the given name from the menu bar. Returns null if menu item does not exist.
- Parameters:
menuName
- String
- Returns:
- JMenu
removeMenu
public javax.swing.JMenu removeMenu(java.lang.String menuName)
- Removes a menu with the given name from the menu bar and returns the removed item.
Returns null if menu item does not exist.
- Parameters:
menuName
- String
- Returns:
- JMenu
removeMenuItem
public javax.swing.JMenuItem removeMenuItem(java.lang.String menuName,
java.lang.String itemName)
- Removes a menu item with the given name from the menu bar and returns the removed item.
Returns null if menu item does not exist.
- Parameters:
menuName
- String
- Returns:
- JMenu
parseXMLMenu
public void parseXMLMenu(java.lang.String xmlMenu)
parseXMLMenu
public void parseXMLMenu(java.lang.String xmlMenu,
java.lang.Class<?> type)
refreshGUI
protected void refreshGUI()
- Refreshes the user interface in response to display changes such as Language.
addButton
public javax.swing.JButton addButton(java.lang.String methodName,
java.lang.String text,
java.lang.String toolTipText,
java.lang.Object target)
- Adds a custom button to the control's frame.
- Parameters:
methodName
- the name of the method; the method has no parameterstext
- the button's text labeltoolTipText
- the button's tool tip texttarget
- the target for the method
- Returns:
- the custom button
setDefaultCloseOperation
public void setDefaultCloseOperation(int operation)
- Overrides JFrame method. This converts EXIT_ON_CLOSE to DISPOSE_ON_CLOSE
and sets the wishesToExit flag.
- Specified by:
setDefaultCloseOperation
in interface AppFrame
- Overrides:
setDefaultCloseOperation
in class javax.swing.JFrame
- Parameters:
operation
- the operation- See Also:
AppFrame.getDefaultCloseOperation()
wishesToExit
public boolean wishesToExit()
- Returns true if this frame wishes to exit.
Launcher uses this to identify control frames.
- Specified by:
wishesToExit
in interface AppFrame
- Returns:
- true if this frame wishes to exit
Overview
Package
Class
Tree
Deprecated
Index
Help
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD