Package org.xj3d.ui.awt.browser.ogl

Class BrowserJPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.xj3d.ui.awt.browser.ogl.BrowserJPanel

All Implemented Interfaces:

ComponentListener, KeyListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, BrowserComponent, BrowserCoreListener

Direct Known Subclasses:

VRMLBrowserJPanel, X3DBrowserJPanel

public abstract class BrowserJPanel
extends JPanel
implements BrowserComponent, BrowserCoreListener, ComponentListener, WindowListener, KeyListener

Common Swing JPanel implementation of the browser component for use in either SAI or EAI, that wraps the functionality of a VRML browser into a convenient, easy to use form.

This base class needs to be extended to provide the SAI or EAI-specific implementation interfaces, as well as any startup required for both of those environments, such as scripting engines etc.

Version:

$Revision: 1.30 $

Author:

Justin Couch, Brad Vender

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 SwingConsoleWindow	console	Area to push error messages to
protected CursorManager	cursorManager	The cursorManager
protected SwingLocationToolbar	locToolbar	The toolbar holding location information
protected OGLBrowserCanvas	mainCanvas	The canvas used to display the world
protected SwingNavigationToolbar	navToolbar	The toolbar holding navigation information
protected SwingStatusBar	statusBar	The status bar
protected org.j3d.aviatrix3d.pipeline.graphics.GraphicsOutputDevice	surface	Our drawing surface
protected OGLStandardBrowserCore	universe	The internal universe

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

Modifier	Constructor	Description
protected	BrowserJPanel(BrowserConfig parameters)	Create an instance of the panel configured to show or hide the controls and only shows VRML97 content.

Method Summary

Modifier and Type	Method	Description
void	addNotify()	This panel, or a container in which it 'lives' is being added to a parent.
void	browserDisposed()	The browser has been disposed by the user calling the dispose method on the ExternalBrowser instance.
void	browserInitialized(VRMLScene scene)	Ignored.
void	browserShutdown()	Ignored.
void	componentHidden(ComponentEvent evt)
void	componentMoved(ComponentEvent evt)
void	componentResized(ComponentEvent evt)
void	componentShown(ComponentEvent evt)
void	destroy()	Called to instruct the component instance to destroy itself and any used resources.
BrowserCore	getBrowserCore()	Get the core browser implementation.
Object	getCanvas()	Get the UI toolkit specific component holding this browser.
org.j3d.util.ErrorReporter	getErrorReporter()	Fetch the error handler so that application code can post messages too.
int	getRendererType()	Get the renderer type.
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent e)
void	removeNotify()	This panel, or a container in which it 'lives' is being removed from it's parent.
void	setMinimumFrameInterval(int millis, boolean userSet)	Set the minimum frame interval time to limit the CPU resources taken up by the 3D renderer.
void	start()	Called to instruct the component instance to start rendering now.
void	stop()	Called to instruct the component instance to stop and suspend its state.
int	supportedSpecificationVersion()	Get the spec version that is supported.
void	urlLoadFailed(String msg)	Ignored.
void	windowActivated(WindowEvent evt)
void	windowClosed(WindowEvent evt)
void	windowClosing(WindowEvent evt)
void	windowDeactivated(WindowEvent evt)
void	windowDeiconified(WindowEvent evt)
void	windowIconified(WindowEvent evt)
void	windowOpened(WindowEvent evt)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

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

surface

protected org.j3d.aviatrix3d.pipeline.graphics.GraphicsOutputDevice surface

Our drawing surface

navToolbar

protected SwingNavigationToolbar navToolbar

The toolbar holding navigation information

locToolbar

protected SwingLocationToolbar locToolbar

The toolbar holding location information

statusBar

protected SwingStatusBar statusBar

The status bar

console

protected SwingConsoleWindow console

Area to push error messages to

mainCanvas

protected OGLBrowserCanvas mainCanvas

The canvas used to display the world

cursorManager

protected CursorManager cursorManager

The cursorManager

universe

protected OGLStandardBrowserCore universe

The internal universe

Constructor Details

BrowserJPanel

protected BrowserJPanel(BrowserConfig parameters)

Create an instance of the panel configured to show or hide the controls and only shows VRML97 content.

Parameters:

parameters - The object containing the browser's configuration parameters

Method Details

removeNotify

public void removeNotify()

This panel, or a container in which it 'lives' is being removed from it's parent. Inform the canvas to stop rendering before it's removeNotify() method is called, otherwise the ui will lockup.

Overrides:

removeNotify in class JComponent

addNotify

public void addNotify()

This panel, or a container in which it 'lives' is being added to a parent. Inform the canvas to start rendering. By default the canvas should be enabled initially. This method is in place to restart rendering in the instance that the component has been removed and is being reinserted into the ui.

Overrides:

addNotify in class JComponent

keyPressed

public void keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

keyTyped

public void keyTyped(KeyEvent e)

Specified by:

keyTyped in interface KeyListener

windowActivated

public void windowActivated(WindowEvent evt)

Specified by:

windowActivated in interface WindowListener

windowClosed

public void windowClosed(WindowEvent evt)

Specified by:

windowClosed in interface WindowListener

windowClosing

public void windowClosing(WindowEvent evt)

Specified by:

windowClosing in interface WindowListener

windowDeactivated

public void windowDeactivated(WindowEvent evt)

Specified by:

windowDeactivated in interface WindowListener

windowDeiconified

public void windowDeiconified(WindowEvent evt)

Specified by:

windowDeiconified in interface WindowListener

windowIconified

public void windowIconified(WindowEvent evt)

Specified by:

windowIconified in interface WindowListener

windowOpened

public void windowOpened(WindowEvent evt)

Specified by:

windowOpened in interface WindowListener

componentHidden

public void componentHidden(ComponentEvent evt)

Specified by:

componentHidden in interface ComponentListener

componentMoved

public void componentMoved(ComponentEvent evt)

Specified by:

componentMoved in interface ComponentListener

componentResized

public void componentResized(ComponentEvent evt)

Specified by:

componentResized in interface ComponentListener

componentShown

public void componentShown(ComponentEvent evt)

Specified by:

componentShown in interface ComponentListener

supportedSpecificationVersion

public int supportedSpecificationVersion()

Description copied from interface: BrowserComponent

Get the spec version that is supported.

Specified by:

supportedSpecificationVersion in interface BrowserComponent

Returns:

a number representing the spec major version

getCanvas

public Object getCanvas()

Description copied from interface: BrowserComponent

Get the UI toolkit specific component holding this browser.

Specified by:

getCanvas in interface BrowserComponent

Returns:

The component

getRendererType

public int getRendererType()

Description copied from interface: BrowserComponent

Get the renderer type.

Specified by:

getRendererType in interface BrowserComponent

Returns:

The BrowserCore type

getBrowserCore

public BrowserCore getBrowserCore()

Description copied from interface: BrowserComponent

Get the core browser implementation.

Specified by:

getBrowserCore in interface BrowserComponent

Returns:

the BrowserCore

getErrorReporter

public org.j3d.util.ErrorReporter getErrorReporter()

Description copied from interface: BrowserComponent

Fetch the error handler so that application code can post messages too.

Specified by:

getErrorReporter in interface BrowserComponent

Returns:

The current error handler instance

setMinimumFrameInterval

public void setMinimumFrameInterval(int millis,
 boolean userSet)

Description copied from interface: BrowserComponent

Set the minimum frame interval time to limit the CPU resources taken up by the 3D renderer. By default it will use all of them. The second parameter is used to control whether this is a user-set hard minimum or something set by the browser internals. User set values are always treated as the minimum unless the browser internals set a value that is a slower framerate than the user set. If the browser then sets a faster framerate than the user set value, the user value is used instead.

Specified by:

setMinimumFrameInterval in interface BrowserComponent

Parameters:

millis - The minimum time in milliseconds.

userSet - true if this is an end-user set minimum

start

public void start()

Description copied from interface: BrowserComponent

Called to instruct the component instance to start rendering now.

Specified by:

start in interface BrowserComponent

stop

public void stop()

Description copied from interface: BrowserComponent

Called to instruct the component instance to stop and suspend its state. The renderer should stop at this point.

Specified by:

stop in interface BrowserComponent

destroy

public void destroy()

Description copied from interface: BrowserComponent

Called to instruct the component instance to destroy itself and any used resources. It will not be used again.

Specified by:

destroy in interface BrowserComponent

browserShutdown

public void browserShutdown()

Ignored. Notification that the browser is shutting down the current content.

Specified by:

browserShutdown in interface BrowserCoreListener

browserDisposed

public void browserDisposed()

The browser has been disposed by the user calling the dispose method on the ExternalBrowser instance. Release our reference to the browser core.

Specified by:

browserDisposed in interface BrowserCoreListener

urlLoadFailed

public void urlLoadFailed(String msg)

Ignored. The browser tried to load a URL and failed.

Specified by:

urlLoadFailed in interface BrowserCoreListener

Parameters:

msg - An error message to go with the failure

browserInitialized

public void browserInitialized(VRMLScene scene)

Ignored. Notification that a world has been loaded into the browser.

Specified by:

browserInitialized in interface BrowserCoreListener

Parameters:

scene - The new scene that has been loaded