org.jmol.viewer
Class StatusManager

java.lang.Object
  extended by org.jmol.viewer.StatusManager

 class StatusManager
extends java.lang.Object

The StatusManager class handles all details of status reporting, including: 1) saving the message in a queue that replaces the "callback" mechanism, 2) sending messages off to the console, and 3) delivering messages back to the main Jmol.java class in app or applet to handle differences in capabilities, including true callbacks. atomPicked fileLoaded fileLoadError frameChanged measureCompleted measurePending measurePicked newOrientation scriptEcho scriptError scriptMessage scriptStarted scriptStatus scriptTerminated userAction viewerRefreshed Bob Hanson hansonr@stolaf.edu 2/2006


Field Summary
private  boolean allowStatusReporting
           
(package private)  boolean drivingSync
           
private  java.lang.String imageType
           
(package private)  boolean isSynced
           
private  JmolCallbackListener jmolCallbackListener
           
(package private)  java.util.Map<EnumCallback,java.lang.String> jmolScriptCallbacks
           
private  JmolStatusListener jmolStatusListener
           
private static int MAXIMUM_QUEUE_LENGTH
           
private  java.util.Map<java.lang.String,java.util.List<java.util.List<java.lang.Object>>> messageQueue
           
private  int minSyncRepeatMs
           
private  int qualityJPG
           
private  int qualityPNG
           
private  java.lang.String statusList
           
private  int statusPtr
           
(package private)  boolean stereoSync
           
(package private) static int SYNC_DISABLE
           
(package private) static int SYNC_DRIVER
           
(package private) static int SYNC_ENABLE
           
(package private) static int SYNC_OFF
           
(package private) static int SYNC_SLAVE
           
(package private) static int SYNC_STEREO
           
(package private)  boolean syncDisabled
           
(package private)  boolean syncingMouse
           
(package private)  boolean syncingScripts
           
protected  Viewer viewer
           
 
Constructor Summary
StatusManager(Viewer viewer)
           
 
Method Summary
(package private)  void clearConsole()
           
(package private)  java.lang.String createImage(java.lang.String fileNameOrError, java.lang.String type, java.lang.Object text_or_bytes, int quality)
          offer to let application do the image creation.
(package private)  java.lang.String dialogAsk(java.lang.String type, java.lang.String fileName)
           
(package private)  boolean doSync()
           
(package private)  float[][] functionXY(java.lang.String functionName, int nX, int nY)
           
(package private)  float[][][] functionXYZ(java.lang.String functionName, int nX, int nY, int nZ)
           
(package private)  java.util.Map<java.lang.String,java.util.List<java.util.List<java.lang.Object>>> getMessageQueue()
           
(package private)  java.util.Map<java.lang.String,java.lang.Object> getRegistryInfo()
           
(package private)  java.util.List<java.util.List<java.util.List<java.lang.Object>>> getStatusChanged(java.lang.String newStatusList)
           
(package private)  java.lang.String getStatusList()
           
(package private)  int getSyncMode()
           
private  java.lang.String jmolScriptCallback(EnumCallback callback)
           
(package private)  java.lang.String jsEval(java.lang.String strEval)
           
private  boolean notifyEnabled(EnumCallback type)
           
(package private)  void notifyError(java.lang.String errType, java.lang.String errMsg, java.lang.String errMsgUntranslated)
           
(package private)  void notifyMinimizationStatus(java.lang.String minStatus, java.lang.Integer minSteps, java.lang.Float minEnergy, java.lang.Float minEnergyDiff)
           
private  void processScript(java.lang.Object[] data)
           
private  boolean recordStatus(java.lang.String statusName)
           
(package private)  void setAllowStatusReporting(boolean TF)
           
(package private)  void setCallbackFunction(java.lang.String callbackType, java.lang.String callbackFunction)
           
(package private)  void setFileLoadStatus(java.lang.String fullPathName, java.lang.String fileName, java.lang.String modelName, java.lang.String errorMsg, int ptLoad, boolean doCallback)
           
(package private)  void setJmolCallbackListener(JmolCallbackListener jmolCallbackListener)
           
(package private)  void setJmolStatusListener(JmolStatusListener jmolStatusListener, JmolCallbackListener jmolCallbackListener)
           
(package private)  void setScriptEcho(java.lang.String strEcho, boolean isScriptQueued)
           
(package private)  void setScriptStatus(java.lang.String strStatus, java.lang.String statusMessage, int msWalltime, java.lang.String strErrorMessageUntranslated)
           
(package private)  void setStatusAppletReady(java.lang.String htmlName, boolean isReady)
           
(package private)  void setStatusAtomHovered(int iatom, java.lang.String strInfo)
           
(package private)  void setStatusAtomMoved(java.util.BitSet bsMoved)
           
(package private)  void setStatusAtomPicked(int atomIndex, java.lang.String strInfo)
           
private  void setStatusChanged(java.lang.String statusName, int intInfo, java.lang.Object statusInfo, boolean isReplace)
           
(package private)  int setStatusClicked(int x, int y, int action, int clickCount, int mode)
           
(package private)  void setStatusFrameChanged(int frameNo, int fileNo, int modelNo, int firstNo, int lastNo)
           
(package private)  void setStatusMeasuring(java.lang.String status, int intInfo, java.lang.String strMeasure, float value)
           
(package private)  void setStatusResized(int width, int height)
           
(package private)  void setSync(java.lang.String mouseCommand)
           
(package private)  void setSyncDriver(int syncMode)
           
(package private)  void showUrl(java.lang.String urlString)
           
(package private)  void syncSend(java.lang.String script, java.lang.String appletName, int port)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

viewer

protected Viewer viewer

jmolStatusListener

private JmolStatusListener jmolStatusListener

jmolCallbackListener

private JmolCallbackListener jmolCallbackListener

statusList

private java.lang.String statusList

allowStatusReporting

private boolean allowStatusReporting

messageQueue

private java.util.Map<java.lang.String,java.util.List<java.util.List<java.lang.Object>>> messageQueue

statusPtr

private int statusPtr

MAXIMUM_QUEUE_LENGTH

private static int MAXIMUM_QUEUE_LENGTH

jmolScriptCallbacks

java.util.Map<EnumCallback,java.lang.String> jmolScriptCallbacks

minSyncRepeatMs

private int minSyncRepeatMs

syncingScripts

boolean syncingScripts

syncingMouse

boolean syncingMouse

drivingSync

boolean drivingSync

isSynced

boolean isSynced

syncDisabled

boolean syncDisabled

stereoSync

boolean stereoSync

SYNC_OFF

static final int SYNC_OFF
See Also:
Constant Field Values

SYNC_DRIVER

static final int SYNC_DRIVER
See Also:
Constant Field Values

SYNC_SLAVE

static final int SYNC_SLAVE
See Also:
Constant Field Values

SYNC_DISABLE

static final int SYNC_DISABLE
See Also:
Constant Field Values

SYNC_ENABLE

static final int SYNC_ENABLE
See Also:
Constant Field Values

SYNC_STEREO

static final int SYNC_STEREO
See Also:
Constant Field Values

qualityJPG

private int qualityJPG

qualityPNG

private int qualityPNG

imageType

private java.lang.String imageType
Constructor Detail

StatusManager

StatusManager(Viewer viewer)
Method Detail

setAllowStatusReporting

void setAllowStatusReporting(boolean TF)

getStatusList

java.lang.String getStatusList()

getMessageQueue

java.util.Map<java.lang.String,java.util.List<java.util.List<java.lang.Object>>> getMessageQueue()

recordStatus

private boolean recordStatus(java.lang.String statusName)

setStatusChanged

private void setStatusChanged(java.lang.String statusName,
                              int intInfo,
                              java.lang.Object statusInfo,
                              boolean isReplace)

getStatusChanged

java.util.List<java.util.List<java.util.List<java.lang.Object>>> getStatusChanged(java.lang.String newStatusList)

setJmolStatusListener

void setJmolStatusListener(JmolStatusListener jmolStatusListener,
                           JmolCallbackListener jmolCallbackListener)

setJmolCallbackListener

void setJmolCallbackListener(JmolCallbackListener jmolCallbackListener)

jmolScriptCallback

private java.lang.String jmolScriptCallback(EnumCallback callback)

setCallbackFunction

void setCallbackFunction(java.lang.String callbackType,
                         java.lang.String callbackFunction)

notifyEnabled

private boolean notifyEnabled(EnumCallback type)

setStatusAppletReady

void setStatusAppletReady(java.lang.String htmlName,
                          boolean isReady)

setStatusAtomMoved

void setStatusAtomMoved(java.util.BitSet bsMoved)

setStatusAtomPicked

void setStatusAtomPicked(int atomIndex,
                         java.lang.String strInfo)

setStatusClicked

int setStatusClicked(int x,
                     int y,
                     int action,
                     int clickCount,
                     int mode)

setStatusResized

void setStatusResized(int width,
                      int height)

setStatusAtomHovered

void setStatusAtomHovered(int iatom,
                          java.lang.String strInfo)

setFileLoadStatus

void setFileLoadStatus(java.lang.String fullPathName,
                       java.lang.String fileName,
                       java.lang.String modelName,
                       java.lang.String errorMsg,
                       int ptLoad,
                       boolean doCallback)

setStatusFrameChanged

void setStatusFrameChanged(int frameNo,
                           int fileNo,
                           int modelNo,
                           int firstNo,
                           int lastNo)

setScriptEcho

void setScriptEcho(java.lang.String strEcho,
                   boolean isScriptQueued)

setStatusMeasuring

void setStatusMeasuring(java.lang.String status,
                        int intInfo,
                        java.lang.String strMeasure,
                        float value)

notifyError

void notifyError(java.lang.String errType,
                 java.lang.String errMsg,
                 java.lang.String errMsgUntranslated)

notifyMinimizationStatus

void notifyMinimizationStatus(java.lang.String minStatus,
                              java.lang.Integer minSteps,
                              java.lang.Float minEnergy,
                              java.lang.Float minEnergyDiff)

setScriptStatus

void setScriptStatus(java.lang.String strStatus,
                     java.lang.String statusMessage,
                     int msWalltime,
                     java.lang.String strErrorMessageUntranslated)

processScript

private void processScript(java.lang.Object[] data)

doSync

boolean doSync()

setSync

void setSync(java.lang.String mouseCommand)

setSyncDriver

void setSyncDriver(int syncMode)

syncSend

void syncSend(java.lang.String script,
              java.lang.String appletName,
              int port)

getSyncMode

int getSyncMode()

showUrl

void showUrl(java.lang.String urlString)

clearConsole

void clearConsole()

functionXY

float[][] functionXY(java.lang.String functionName,
                     int nX,
                     int nY)

functionXYZ

float[][][] functionXYZ(java.lang.String functionName,
                        int nX,
                        int nY,
                        int nZ)

jsEval

java.lang.String jsEval(java.lang.String strEval)

createImage

java.lang.String createImage(java.lang.String fileNameOrError,
                             java.lang.String type,
                             java.lang.Object text_or_bytes,
                             int quality)
offer to let application do the image creation. if text_or_bytes == null, then this is an error report.

Parameters:
fileNameOrError -
type -
text_or_bytes -
quality -
Returns:
null (canceled) or a message starting with OK or an error message

getRegistryInfo

java.util.Map<java.lang.String,java.lang.Object> getRegistryInfo()

dialogAsk

java.lang.String dialogAsk(java.lang.String type,
                           java.lang.String fileName)