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

Class X3DBrowserAWTPanel

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Panel

org.xj3d.ui.awt.browser.ogl.X3DBrowserAWTPanel

All Implemented Interfaces:

ComponentListener, KeyListener, WindowListener, ImageObserver, MenuContainer, Serializable, Runnable, EventListener, Accessible, BrowserComponent, FileHandler, X3DComponent

public class X3DBrowserAWTPanel
extends Panel
implements X3DComponent, BrowserComponent, KeyListener, ComponentListener, WindowListener, Runnable, FileHandler

A browser that uses the AWT panel and labels to draw render the UI with.

X3DBrowserAWTPanel is the AWT based alternative to BrowserJPanel. At the moment, it offers minimal functionality. The "dashboard" is a text label, there aren't any navigation functions. That, and urlReadOnly, urlTop, and dashTop are ignored.

Version:

$Revision: 1.9 $

Author:

Brad Vender, Justin Couch

See Also:

• Serialized Form

Nested Class Summary

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

Panel.AccessibleAWTPanel

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 CursorManager	cursorManager	The cursorManager
protected ContentLoadManager	loadManager	The loadManager

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
X3DBrowserAWTPanel(BrowserConfig parameters)	Create a VrmlComponent that belongs to an AWT panel.

Method Summary

Modifier and Type	Method	Description
void	addNotify()	Override addNotify so we know we have peer before calling setEnabled for Aviatrix3D.
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.
ExternalBrowser	getBrowser()	Get a browser reference from this component that represents the internals of this browser.
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.
Object	getImplementation()	Get a reference to the component implementation.
int	getRendererType()	Get the renderer type.
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent e)
void	loadURL(String url)	Go to the named URL location.
void	run()
void	setMinimumFrameInterval(int millis, boolean userSet)	Set the minimum frame interval time to limit the CPU resources taken up by the 3D renderer.
void	shutdown()	Shutdown the component because it will no longer be needed.
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	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 java.awt.Panel

getAccessibleContext

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, isValidateRoot, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, 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, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, 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, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, 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

cursorManager

protected CursorManager cursorManager

The cursorManager

loadManager

protected ContentLoadManager loadManager

The loadManager

Constructor Details

X3DBrowserAWTPanel

public X3DBrowserAWTPanel(BrowserConfig parameters)

Create a VrmlComponent that belongs to an AWT panel. and in that process construct the corresponding Browser, and the infrastructure required.

Parameters:

parameters - The object containing the browser's configuration parameters

Method Details

getBrowser

public ExternalBrowser getBrowser()

Description copied from interface: X3DComponent

Get a browser reference from this component that represents the internals of this browser.

Specified by:

getBrowser in interface X3DComponent

Returns:

A reference to the browser object represented by this component.

getImplementation

public Object getImplementation()

Description copied from interface: X3DComponent

Get a reference to the component implementation. For example, if this is an AWT component, it would return an instance of Component.

Specified by:

getImplementation in interface X3DComponent

Returns:

a reference to the component implementation

shutdown

public void shutdown()

Description copied from interface: X3DComponent

Shutdown the component because it will no longer be needed. If the component has already had this method called, it will silently ignore any further requests.

Specified by:

shutdown in interface X3DComponent

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

Specified by:

getErrorReporter in interface FileHandler

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

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

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

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

loadURL

public void loadURL(String url)
             throws IOException

Description copied from interface: FileHandler

Go to the named URL location. No checking is done other than to make sure it is a valid URL.

Specified by:

loadURL in interface FileHandler

Parameters:

url - The URL to open

Throws:

IOException

run

public void run()

Specified by:

run in interface Runnable

addNotify

public void addNotify()

Override addNotify so we know we have peer before calling setEnabled for Aviatrix3D.

Overrides:

addNotify in class Panel