com.eteks.sweethome3d.applet

Class SweetHome3DApplet

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Panel

java.applet.Applet

javax.swing.JApplet

com.eteks.sweethome3d.applet.SweetHome3DApplet

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer

public class SweetHome3DApplet
extends javax.swing.JApplet

This applet class loads Sweet Home 3D classes from jars in classpath or from extension jars stored as resources.

This applet accepts the following parameters:

• furnitureCatalogURLs specifies the URLs of the furniture libraries available in Sweet Home 3D catalog. These URLs are comma or space separated, and if they are not absolute URLs, they will be considered as relative to applet codebase. Each URL is a ZIP file that must contain a file named PluginFurnitureCatalog.properties describing the properties of each piece of furniture proposed by the URL file.
  By default, the value of this parameter is catalog.zip. If this file or one of the URLs specified by this parameter doesn't exist, it will be ignored.
• furnitureResourcesURLBase specifies the URL used as a base to build the URLs of the 3D models and icons cited in the PluginFurnitureCatalog.properties file of a furniture catalog. If this URL isn't an absolute URL it will be considered relative to applet codebase. If this URL base should the applet code base itself, use a value equal to ".".
  If this parameter isn't defined, the URLs of 3D model and icons will be relative to their furniture catalog file or absolute.
• texturesCatalogURLs specifies the URLs of the textures libraries available in Sweet Home 3D catalog. These URLs are comma or space separated, and if they are not absolute URLs, they will be considered as relative to applet codebase. Each URL is a ZIP file that must contain a file named PluginTexturesCatalog.properties describing the properties of each texture proposed by the URL file.
  By default, the value of this parameter is catalog.zip, meaning that the furniture and textures can be stored in the same file. If this file or one of the URLs specified by this parameter doesn't exist, it will be ignored.
• texturesResourcesURLBase specifies the URL used as a base to build the URLs of the texture images cited in the PluginTexturesCatalog.properties file of a textures catalog. If this URL isn't an absolute URL it will be considered relative to applet codebase. If this URL base should the applet code base itself, use a value equal to ".".
  If this parameter isn't defined, the URLs of texture images will be relative to their textures catalog file or absolute.
• pluginURLs specifies the URLs of the actions available to users through plugins.These URLs are comma or space separated, and if they are not absolute URLs, they will be considered as relative to applet codebase. If some classes of a plugin needs to access to resources protected by applet sandbox, its JAR file should be signed, added to archive applet attribute and and in a jar element of applet JNLP file.
  By default, the value of this parameter is empty. If one of the URLs specified by this parameter doesn't exist, it will be ignored.
• writeHomeURL specifies the URL of the HTTP service able to write the data of a home. This data will be uploaded in the file parameter named home of a POST request encoded with multipart/form-data MIME type, with the name of the uploaded home being stored in its filename attribute. This service must return 1 if it wrote the uploaded data successfully.
  By default, this URL is writeHome.php and if it's not an absolute URL it will be considered as relative to applet codebase. If its value is empty, New, Save and Save as... actions will be disabled and their buttons won't be displayed.
• homeMaximumLength specifies the maximum length in bytes of a home that the HTTP service used to write its data will accept. If not specified, the length of a saved home won't be verified before the writing service is called, leading to a possible error when that service refuses to write a file larger that this maximum.
• readHomeURL specifies the URL of the HTTP service able to return the data of a home written with the write home service. The home name is specified by the parameter named home of a GET request.
  By default, this URL is readHome.php?home=%s (the %s sign will be replaced by the requested home name). If it's not an absolute URL it will be considered as relative to applet codebase.
• listHomesURL specifies the URL of the HTTP service able to return the list of home names able to be read from server. It must return these names in a string, separated from each other by a carriage return (\n).
  By default, this URL is listHomes.php and if it's not an absolute URL it will be considered as relative to applet codebase. If its value is empty, New, Open and Save as... actions will be disabled and their buttons won't be displayed. If defaultHome is empty, Save action will be also disabled
• deleteHomeURL specifies the URL of the HTTP service able to delete the data of a home written with the write home service. The home name is specified by the parameter named home of a GET request and the the %s sign will be replaced by the home name that should be deleted. This service must return 1 if it deleted the given home successfully.
  By default, this service doesn't exist and deletion is not possible from the applet. If it's not an absolute URL it will be considered as relative to applet codebase. This service is available to the user if listHomesURL is defined.
• defaultHome specifies the home that will be opened at applet launch with readHomeURL service.
  Omit this parameter or let its value empty, if no home should be opened.
  If you want the applet open a home at launch without creating a readHomeURL service, set %s value for readHomeURL parameter and put the absolute URL of the home file or its URL relative to applet codebase in defaultHome parameter.
• writePreferencesURL specifies the URL of the HTTP service able to write the XML content describing the user preferences. This data will be uploaded in the parameter named preferences of a POST request. This service must return 1 if it completed successfully.
  By default, this URL is empty and if it's not an absolute URL it will be considered as relative to applet codebase.
• readPreferencesURL specifies the URL of the HTTP service able to return an XML content describing the user preferences as a set of properties. The DTD of the XML content supported by the applet is specified at http://java.sun.com/dtd/properties.dtd.
  By default, this URL is empty and if it's not an absolute URL it will be considered as relative to applet codebase.
• enableExportToSH3D specifies whether this applet should enable the action that lets the user export the edited home to a SH3D file.
  By default, the value of this parameter is false.
• enableImportFromSH3D specifies whether this applet should enable the action that lets the user import a SH3D file to replace the edited home.
  By default, the value of this parameter is false.
• enableExportToCSV specifies whether this applet should enable the action that lets the user export the furniture list of the edited home to a CSV file.
  By default, the value of this parameter is false.
• enableExportToSVG specifies whether this applet should enable the action that lets the user export the plan of the edited home to a SVG file.
  By default, the value of this parameter is false.
• enableExportToOBJ specifies whether this applet should enable the action that lets the user export the 3D view of the edited home to an OBJ file.
  By default, the value of this parameter is false.
• enablePrintToPDF specifies whether this applet should enable the action that lets the user print the edited home to a PDF file.
  By default, the value of this parameter is false.
• enableCreatePhoto specifies whether this applet should enable the action that lets the user create a photo from the 3D view of the edited home.
  By default, the value of this parameter is false.
• enableCreateVideo specifies whether this applet should enable the action that lets the user create a 3D video of the edited home.
  By default, the value of this parameter is false.
• showMemoryStatus specifies whether this applet should display each second the available memory in browser status bar when it has focus.
  By default, the value of this parameter is false and the status message won't be modified by the applet.
• userLanguage specifies the ISO 639 code (fr, en...) of the language used by the items displayed by this applet.
  By default, the selected language depends on the user environment.

The bytecode of this class is Java 1.1 compatible to be able to notify users that it requires Java 5 when it's run under an old JVM.

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JApplet

javax.swing.JApplet.AccessibleJApplet

Nested classes/interfaces inherited from class java.applet.Applet

java.applet.Applet.AccessibleApplet

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

java.awt.Panel.AccessibleAWTPanel

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

Fields inherited from class javax.swing.JApplet

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

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 and Description
SweetHome3DApplet()

Method Summary

Modifier and Type	Method and Description
void	destroy()
protected java.lang.Object	getApplication() Returns the application instance created by the applet.
protected java.lang.String	getApplicationClassName() Returns the name of the application class associated to this applet.
void	init()
boolean	isModified() Returns true if one of the homes edited by this applet is modified.

Methods inherited from class javax.swing.JApplet

addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isRootPaneCheckingEnabled, paramString, remove, repaint, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.applet.Applet

getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, isValidateRoot, newAudioClip, play, play, resize, resize, setStub, showStatus, start, stop

Methods inherited from class java.awt.Panel

addNotify

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, 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

Constructor Detail

SweetHome3DApplet

public SweetHome3DApplet()

Method Detail

init

public void init()

Overrides:

init in class java.applet.Applet

destroy

public void destroy()

Overrides:

destroy in class java.applet.Applet

isModified

public boolean isModified()

Returns true if one of the homes edited by this applet is modified.

getApplicationClassName

protected java.lang.String getApplicationClassName()

Returns the name of the application class associated to this applet. This class must have a constructor taking in parameter a JApplet.

getApplication

protected java.lang.Object getApplication()

Returns the application instance created by the applet.