Xj3D VRML/X3D Code API

org.web3d.ogl.browser
Class X3DNRBrowserFactoryImpl

java.lang.Object
  extended byorg.web3d.ogl.browser.X3DNRBrowserFactoryImpl
All Implemented Interfaces:
BrowserFactoryImpl, X3DComponent

public class X3DNRBrowserFactoryImpl
extends java.lang.Object
implements BrowserFactoryImpl, X3DComponent

Factory implementation for X3D SAI which will produce components using the Null renderer. Component Creation

This implementation allows you to create a new component that is ready to place content in. Parameters can be supplied in the Map as defined by the SAI. The first column is the parameter name string, the second is the type of data, and the third is an explanation.

Version:
$Revision: 1.5 $
Author:
Alan Hudson

Constructor Summary
X3DNRBrowserFactoryImpl()
          Create a new instance of this factory.
 
Method Summary
 X3DComponent createComponent(java.util.Map params)
          Create a VRML browser that can be used as an AWT component.
 ExternalBrowser getBrowser()
          Get a browser reference from this component that represents the internals of this browser.
 ExternalBrowser getBrowser(java.applet.Applet applet)
          Get a browser from the given java applet reference as a base in the current HTML page.
 ExternalBrowser getBrowser(java.applet.Applet applet, java.lang.String frameName, int index)
          Get a browser from the given java applet reference one some named page and at some embbed location.
 ExternalBrowser getBrowser(java.net.InetAddress address, int port)
          Get a reference to a browser that is located on a remote machine.
 java.lang.Object getImplementation()
          Get a reference to the component implementation.
 VRMLScene getScene()
          Get the scene object being rendered by this panel.
 OGLVRMLUniverse getUniverse()
          Get the universe underlying this panel.
 void loadURL(InputSource src)
          Change the panels content to the provided URL.
 void loadURL(java.lang.String url)
          Change the panels content to the provided URL.
 void shutdown()
          Shutdown the component because it will no longer be needed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

X3DNRBrowserFactoryImpl

public X3DNRBrowserFactoryImpl()
Create a new instance of this factory.

Method Detail

createComponent

public X3DComponent createComponent(java.util.Map params)
                             throws NotSupportedException
Description copied from interface: BrowserFactoryImpl
Create a VRML browser that can be used as an AWT component. The component returned is guaranteed to be an instance of X3DComponent.

Specified by:
createComponent in interface BrowserFactoryImpl
Parameters:
params - Parameters to control the look and feel.
Returns:
The component browser initialised to be empty.
Throws:
NotSupportedException - The implementation does not support this type of browser.
See Also:
BrowserFactoryImpl.createComponent(java.util.Map)

getBrowser

public ExternalBrowser getBrowser(java.applet.Applet applet)
                           throws NotSupportedException,
                                  NoSuchBrowserException,
                                  ConnectionException
Description copied from interface: BrowserFactoryImpl
Get a browser from the given java applet reference as a base in the current HTML page. Used when attempting to access a browser on the current page as this applet and is the first browser on the page. Generically, the same as calling getBrowser(applet, "", 0);

Specified by:
getBrowser in interface BrowserFactoryImpl
Parameters:
applet - The applet reference to use
Returns:
A reference to the Browser implementation
Throws:
NoSuchBrowserException - Could not locate a VRML browser on the same page as the applet.
NotSupportedException - The implementation does not support this type of VRML browser
ConnectionException - An error occurred during the connecting process
See Also:
BrowserFactoryImpl.getBrowser(java.applet.Applet)

getBrowser

public ExternalBrowser getBrowser(java.applet.Applet applet,
                                  java.lang.String frameName,
                                  int index)
                           throws NotSupportedException,
                                  NoSuchBrowserException,
                                  ConnectionException
Description copied from interface: BrowserFactoryImpl
Get a browser from the given java applet reference one some named page and at some embbed location. Used when attempting to access a browser on another HTML page within a multi-framed environment, or if there are a number of VRML browser instances located on the same page.

If the frame name is a zero length string or null then it is assumed to be located on the same HTML page as the applet. The index is the number of the embbed VRML browser starting from the top of the page. If there are other non-VRML plugins embedded in the page these are not taken into account in calculating the embed index.

Specified by:
getBrowser in interface BrowserFactoryImpl
Parameters:
applet - The applet reference to use
frameName - The name of the frame to look into for the browser
index - The embed index of the VRML browser in the page
Returns:
A reference to the Browser implementation
Throws:
ConnectionException - An error occurred during the connecting process
NotSupportedException - The implementation does not support this type of VRML browser.
NoSuchBrowserException - Could not locate a VRML browser on the same page as the applet.
See Also:
BrowserFactoryImpl.getBrowser(java.applet.Applet, java.lang.String, int)

getBrowser

public ExternalBrowser getBrowser(java.net.InetAddress address,
                                  int port)
                           throws NotSupportedException,
                                  NoSuchBrowserException,
                                  java.net.UnknownHostException,
                                  ConnectionException
Description copied from interface: BrowserFactoryImpl
Get a reference to a browser that is located on a remote machine. This a server application to send scene updates to a number of client browsers located on remote machines. If there are a number of browsers running on a remote machine, they can be differentiated by the port number they are listening on.

There is no default port number for VRML browsers.

Specified by:
getBrowser in interface BrowserFactoryImpl
Parameters:
address - The address of the machine to connect to
port - The port number on that machine to connect to.
Returns:
A reference to the Browser implementation
Throws:
ConnectionException - An error occurred during the connecting process
NoSuchBrowserException - Could not locate a VRML browser on the same page as the applet.
java.net.UnknownHostException - Could not find the machine named in the address.
NotSupportedException - The implementation does not support this type of VRML browser.
See Also:
BrowserFactoryImpl.getBrowser(java.net.InetAddress, int)

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.
See Also:
X3DComponent.getBrowser()

getImplementation

public java.lang.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
See Also:
X3DComponent.getImplementation()

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
See Also:
X3DComponent.shutdown()

getScene

public VRMLScene getScene()
Get the scene object being rendered by this panel.

Returns:
The current scene.

getUniverse

public OGLVRMLUniverse getUniverse()
Get the universe underlying this panel.

Returns:
The universe.

loadURL

public void loadURL(java.lang.String url)
             throws java.io.IOException
Change the panels content to the provided URL.

Parameters:
url - The URL to load.
Throws:
java.io.IOException - On a failed load or badly formatted URL

loadURL

public void loadURL(InputSource src)
             throws java.io.IOException
Change the panels content to the provided URL.

Parameters:
src - the source to load the content from
Throws:
java.io.IOException - On a failed load or badly formatted URL

Xj3D VRML/X3D Code API

Copyright © 2001 - 2005 Web3D Consortium