GenericApplet

java.lang.Object
- org.jmol.util.GenericApplet

All Implemented Interfaces:

JmolAppletInterface, JmolCallbackListener, JmolStatusListener, JmolSyncInterface

Direct Known Subclasses:

Jmol, Jmol
```
public abstract class GenericApplet
extends Object
implements JmolAppletInterface, JmolStatusListener
```
A collection of all methods necessary for initialization of and communication with the applet, whether it be JavaScript or Java.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Object`	`appletObject`
`protected Map<CBK,String>`	`callbacks`
`protected String`	`codeBase`
`protected String`	`documentBase`
`protected boolean`	`doTranslate`
`protected String`	`fullName`
`protected Object`	`gRight`
`protected boolean`	`haveDocumentAccess`
`protected boolean`	`haveNotifiedError`
`protected String`	`htmlName`
`protected static Map<String,Object>`	`htRegistry`
`protected boolean`	`isJNLP`
`protected boolean`	`isJS`
`protected boolean`	`isSigned`
`protected boolean`	`isStereoSlave`
`protected String`	`language`
`private boolean`	`loading`
`protected boolean`	`mayScript`
`private javajs.util.SB`	`outputBuffer`
`private static int`	`SCRIPT_CHECK`
`private static int`	`SCRIPT_NOWAIT`
`private static int`	`SCRIPT_WAIT`
`protected String`	`statusForm`
`protected String`	`statusText`
`protected String`	`statusTextarea`
`private String`	`syncId`
`protected Viewer`	`viewer`
`protected Map<String,Object>`	`vwrOptions`

Constructor Summary

Constructors
Constructor and Description

GenericApplet()

Constructors
Constructor and Description
`GenericApplet()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`(package private) static void`	`checkIn(String name, Object applet)`
`(package private) static void`	`checkOut(String name)`
`private void`	`consoleMessage(String message)`
`String`	`createImage(String fileName, String type, Object text_or_bytes, int quality)` Starting with Jmol 11.8.RC5, for a context where the Jmol application is embedded in another application simply to send the returned message to the application.
`void`	`destroy()`
`protected abstract String`	`doEval(String strEval)`
`protected abstract float[][]`	`doFunctionXY(String functionName, int nX, int nY)`
`protected abstract float[][][]`	`doFunctionXYZ(String functionName, int nX, int nY, int nZ)`
`protected abstract String`	`doSendCallback(String callback, Object[] data, String strInfo)`
`protected abstract void`	`doSendJsTextareaStatus(String strInfo)`
`protected abstract void`	`doSendJsTextStatus(String message)`
`protected abstract void`	`doShowDocument(URL url)`
`protected abstract void`	`doShowStatus(String errorMsg)`
`String`	`eval(String strEval)`
`(package private) static void`	`findApplets(String appletName, String mySyncId, String excludeName, javajs.util.Lst<String> apps)`
`float[][]`	`functionXY(String functionName, int nX, int nY)` for isosurface FUNCTIONXY
`float[][][]`	`functionXYZ(String functionName, int nX, int nY, int nZ)` for isosurface FUNCTIONXYZ
`String`	`getAppletInfo()`
`protected boolean`	`getBooleanValue(String propertyName, boolean defaultValue)`
`protected abstract String`	`getJmolParameter(String name)`
`Map<String,Object>`	`getJSpecViewProperty(String key)` JSpecView shares the JmolSyncInterface; used to get JSpecView
`int`	`getModelIndexFromId(String id)`
`Object`	`getProperty(String infoType)`
`Object`	`getProperty(String infoType, String paramInfo)`
`String`	`getPropertyAsJSON(String infoType)`
`String`	`getPropertyAsJSON(String infoType, String paramInfo)`
`String`	`getPropertyAsString(String infoType)`
`String`	`getPropertyAsString(String infoType, String paramInfo)`
`Map<String,Object>`	`getRegistryInfo()`
`protected String`	`getValue(String propertyName, String defaultValue)`
`private String`	`getValueLowerCase(String paramName, String defaultValue)`
`boolean`	`handleEvent(Event e)`
`protected void`	`init(Object applet)`
`private void`	`initApplication()`
`protected abstract void`	`initOptions()`
`String`	`loadDOMNode(Object DOMNode)`
`String`	`loadInline(String strModel)` Deprecated.
`String`	`loadInline(String[] strModels)` Deprecated.
`String`	`loadInline(String[] strModels, String script)` Deprecated.
`String`	`loadInline(String strModel, String script)` Deprecated.
`String`	`loadInlineArray(String[] strModels, String script, boolean isAppend)`
`String`	`loadInlineString(String strModel, String script, boolean isAppend)`
`void`	`notifyCallback(CBK type, Object[] data)`
`boolean`	`notifyEnabled(CBK type)`
`private String`	`notifySync(String info, String appletName)`
`void`	`output(String s)`
`void`	`playAudio(String fileOrDataURI)`
`void`	`register(String id, JmolSyncInterface jsi)`
`int[]`	`resizeInnerPanel(String data)`
`void`	`script(String script)`
`String`	`scriptCheck(String script)`
`String`	`scriptNoWait(String script)`
`private String`	`scriptProcessor(String script, String statusParams, int processType)`
`String`	`scriptWait(String script)`
`String`	`scriptWait(String script, String statusParams)`
`String`	`scriptWaitOutput(String script)`
`private String`	`sendScript(String script, String appletName, boolean isSync, boolean doCallback)`
`void`	`setCallbackFunction(String callbackName, String callbackFunction)`
`private void`	`setStringProperty(String name, String value)`
`private void`	`setValue(String name, String defaultValue)`
`void`	`showUrl(String urlString)`
`void`	`syncScript(String script)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jmol.api.JmolAppletInterface
setStereoGraphics

Field Detail

htRegistry

protected static Map<String,Object> htRegistry

isJS
```
protected boolean isJS
```

SCRIPT_CHECK
```
private static final int SCRIPT_CHECK
```
See Also:

Constant Field Values

SCRIPT_WAIT
```
private static final int SCRIPT_WAIT
```
See Also:

Constant Field Values

SCRIPT_NOWAIT
```
private static final int SCRIPT_NOWAIT
```
See Also:

Constant Field Values

codeBase
```
protected String codeBase
```

documentBase
```
protected String documentBase
```

isSigned
```
protected boolean isSigned
```

language
```
protected String language
```

doTranslate
```
protected boolean doTranslate
```

haveDocumentAccess
```
protected boolean haveDocumentAccess
```

isStereoSlave
```
protected boolean isStereoSlave
```

mayScript
```
protected boolean mayScript
```

htmlName
```
protected String htmlName
```

fullName
```
protected String fullName
```

statusForm
```
protected String statusForm
```

statusText
```
protected String statusText
```

statusTextarea
```
protected String statusTextarea
```

gRight
```
protected Object gRight
```

viewer
```
protected Viewer viewer
```

callbacks
```
protected Map<CBK,String> callbacks
```

vwrOptions

protected Map<String,Object> vwrOptions

haveNotifiedError
```
protected boolean haveNotifiedError
```

appletObject
```
protected Object appletObject
```

isJNLP
```
protected boolean isJNLP
```

loading
```
private boolean loading
```

syncId
```
private String syncId
```

outputBuffer
```
private javajs.util.SB outputBuffer
```

Constructor Detail
- GenericApplet
```
public GenericApplet()
```

Method Detail

initOptions
```
protected abstract void initOptions()
```

getJmolParameter

protected abstract String getJmolParameter(String name)

doEval

protected abstract String doEval(String strEval)

doFunctionXY

protected abstract float[][] doFunctionXY(String functionName,
                                          int nX,
                                          int nY)

doFunctionXYZ

protected abstract float[][][] doFunctionXYZ(String functionName,
                                             int nX,
                                             int nY,
                                             int nZ)

doSendCallback

protected abstract String doSendCallback(String callback,
                                         Object[] data,
                                         String strInfo)

doSendJsTextareaStatus

protected abstract void doSendJsTextareaStatus(String strInfo)

doSendJsTextStatus

protected abstract void doSendJsTextStatus(String message)

doShowDocument

protected abstract void doShowDocument(URL url)

doShowStatus

protected abstract void doShowStatus(String errorMsg)

init
```
protected void init(Object applet)
```

initApplication
```
private void initApplication()
```

destroy
```
public void destroy()
```
Specified by:

destroy in interface JmolAppletInterface

getBooleanValue

protected boolean getBooleanValue(String propertyName,
                                  boolean defaultValue)

getValue

protected String getValue(String propertyName,
                          String defaultValue)

getValueLowerCase

private String getValueLowerCase(String paramName,
                                 String defaultValue)

setValue

private void setValue(String name,
                      String defaultValue)

setStringProperty

private void setStringProperty(String name,
                               String value)

scriptProcessor

private String scriptProcessor(String script,
                               String statusParams,
                               int processType)

register

public void register(String id,
                     JmolSyncInterface jsi)

Specified by:: register in interface JmolSyncInterface

getJSpecViewProperty
```
public Map<String,Object> getJSpecViewProperty(String key)
```
JSpecView shares the JmolSyncInterface; used to get JSpecView

Specified by:

getJSpecViewProperty in interface JmolStatusListener

Specified by:

getJSpecViewProperty in interface JmolSyncInterface

syncScript
```
public void syncScript(String script)
```
Specified by:

syncScript in interface JmolSyncInterface

handleEvent
```
public boolean handleEvent(Event e)
```
Specified by:

handleEvent in interface JmolAppletInterface

getAppletInfo
```
public String getAppletInfo()
```
Specified by:

getAppletInfo in interface JmolAppletInterface

script
```
public void script(String script)
```
Specified by:

script in interface JmolAppletInterface

scriptCheck
```
public String scriptCheck(String script)
```
Specified by:

scriptCheck in interface JmolAppletInterface

scriptNoWait
```
public String scriptNoWait(String script)
```
Specified by:

scriptNoWait in interface JmolAppletInterface

scriptWait
```
public String scriptWait(String script)
```
Specified by:

scriptWait in interface JmolAppletInterface

scriptWait

public String scriptWait(String script,
                         String statusParams)

Specified by:: scriptWait in interface JmolAppletInterface

scriptWaitOutput
```
public String scriptWaitOutput(String script)
```
Specified by:

scriptWaitOutput in interface JmolAppletInterface

getModelIndexFromId
```
public int getModelIndexFromId(String id)
```
Specified by:

getModelIndexFromId in interface JmolAppletInterface

Parameters:

id - some_id, filename#id, or ~fileNo.modelNo added ".basemodel" indicates to get the first model in a series from a JDX-MOL file.

Returns:

model index if found; -2 if file found but model not found -2 if no file indicated and no model found -1 if no such file

getProperty
```
public Object getProperty(String infoType)
```
Specified by:

getProperty in interface JmolAppletInterface

Parameters:

infoType -

Returns:

value

getProperty

public Object getProperty(String infoType,
                          String paramInfo)

Specified by:: getProperty in interface JmolAppletInterface
Parameters:: infoType -; paramInfo -
Returns:: value

getPropertyAsString
```
public String getPropertyAsString(String infoType)
```
Specified by:

getPropertyAsString in interface JmolAppletInterface

Parameters:

infoType -

Returns:

value

getPropertyAsString

public String getPropertyAsString(String infoType,
                                  String paramInfo)

Specified by:: getPropertyAsString in interface JmolAppletInterface
Parameters:: infoType -; paramInfo -
Returns:: value

getPropertyAsJSON
```
public String getPropertyAsJSON(String infoType)
```
Specified by:

getPropertyAsJSON in interface JmolAppletInterface

Parameters:

infoType -

Returns:

value

getPropertyAsJSON

public String getPropertyAsJSON(String infoType,
                                String paramInfo)

Specified by:: getPropertyAsJSON in interface JmolAppletInterface
Parameters:: infoType -; paramInfo -
Returns:: value

loadInlineString

public String loadInlineString(String strModel,
                               String script,
                               boolean isAppend)

Specified by:: loadInlineString in interface JmolAppletInterface

loadInlineArray

public String loadInlineArray(String[] strModels,
                              String script,
                              boolean isAppend)

Specified by:: loadInlineArray in interface JmolAppletInterface

loadDOMNode
```
public String loadDOMNode(Object DOMNode)
```
Specified by:

loadDOMNode in interface JmolAppletInterface

loadInline
```
@Deprecated
public String loadInline(String strModel)
```
Deprecated.

Specified by:

loadInline in interface JmolAppletInterface

Parameters:

strModel -

Returns:

error or null

loadInline

@Deprecated
public String loadInline(String strModel,
                                     String script)

Deprecated.

Specified by:: loadInline in interface JmolAppletInterface
Parameters:: strModel -; script -
Returns:: error or null

loadInline
```
@Deprecated
public String loadInline(String[] strModels)
```
Deprecated.

Specified by:

loadInline in interface JmolAppletInterface

Parameters:

strModels -

Returns:

error or null

loadInline

@Deprecated
public String loadInline(String[] strModels,
                                     String script)

Deprecated.

Specified by:: loadInline in interface JmolAppletInterface
Parameters:: strModels -; script -
Returns:: error or null

output
```
public void output(String s)
```

setCallbackFunction

public void setCallbackFunction(String callbackName,
                                String callbackFunction)

Specified by:: setCallbackFunction in interface JmolCallbackListener

consoleMessage

private void consoleMessage(String message)

notifyEnabled
```
public boolean notifyEnabled(CBK type)
```
Specified by:

notifyEnabled in interface JmolCallbackListener

notifyCallback
```
public void notifyCallback(CBK type,
                           Object[] data)
```
Specified by:

notifyCallback in interface JmolCallbackListener

Parameters:

type - the callback type or null for getJsObjectInfo() -- Java applet only

data - type-dependent

sendScript

private String sendScript(String script,
                          String appletName,
                          boolean isSync,
                          boolean doCallback)

playAudio

public void playAudio(String fileOrDataURI)

notifySync

private String notifySync(String info,
                          String appletName)

eval
```
public String eval(String strEval)
```
Specified by:

eval in interface JmolStatusListener

functionXY
```
public float[][] functionXY(String functionName,
                            int nX,
                            int nY)
```
Description copied from interface: JmolStatusListener

for isosurface FUNCTIONXY

Specified by:

functionXY in interface JmolStatusListener

Returns:

2D array or null

functionXYZ

public float[][][] functionXYZ(String functionName,
                               int nX,
                               int nY,
                               int nZ)

Description copied from interface: JmolStatusListener

for isosurface FUNCTIONXYZ

Specified by:: functionXYZ in interface JmolStatusListener
Returns:: 3D array or null

createImage
```
public String createImage(String fileName,
                          String type,
                          Object text_or_bytes,
                          int quality)
```
Description copied from interface: JmolStatusListener

Starting with Jmol 11.8.RC5, for a context where the Jmol application is embedded in another application simply to send the returned message to the application. In this way any application can have access to the WRITE command.

Specified by:

createImage in interface JmolStatusListener

text_or_bytes - information or null indicates message AFTER Jmol creates the image

Returns:

null (canceled) or a message starting with OK or an error message

getRegistryInfo
```
public Map<String,Object> getRegistryInfo()
```
Specified by:

getRegistryInfo in interface JmolStatusListener

showUrl
```
public void showUrl(String urlString)
```
Specified by:

showUrl in interface JmolStatusListener

resizeInnerPanel
```
public int[] resizeInnerPanel(String data)
```
Specified by:

resizeInnerPanel in interface JmolStatusListener

checkIn

static void checkIn(String name,
                    Object applet)

checkOut
```
static void checkOut(String name)
```

findApplets

static void findApplets(String appletName,
                        String mySyncId,
                        String excludeName,
                        javajs.util.Lst<String> apps)

Class GenericApplet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jmol.api.JmolAppletInterface

Field Detail

htRegistry

isJS

SCRIPT_CHECK

SCRIPT_WAIT

SCRIPT_NOWAIT

codeBase

documentBase

isSigned

language

doTranslate

haveDocumentAccess

isStereoSlave

mayScript

htmlName

fullName

statusForm

statusText

statusTextarea

gRight

viewer

callbacks

vwrOptions

haveNotifiedError

appletObject

isJNLP

loading

syncId

outputBuffer

Constructor Detail

GenericApplet

Method Detail

initOptions

getJmolParameter

doEval

doFunctionXY

doFunctionXYZ

doSendCallback

doSendJsTextareaStatus

doSendJsTextStatus

doShowDocument

doShowStatus

init

initApplication

destroy

getBooleanValue

getValue

getValueLowerCase

setValue

setStringProperty

scriptProcessor

register

getJSpecViewProperty

syncScript

handleEvent

getAppletInfo

script

scriptCheck

scriptNoWait

scriptWait

scriptWait

scriptWaitOutput

getModelIndexFromId

getProperty

getProperty

getPropertyAsString

getPropertyAsString

getPropertyAsJSON

getPropertyAsJSON

loadInlineString

loadInlineArray

loadDOMNode

loadInline

loadInline