org.jmol.viewer
Class StatusManager

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

 class StatusManager
extends 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)  String dialogType
           
(package private)  boolean drivingSync
           
protected static String[] imageChoices
           
protected static String[] imageExtensions
           
(package private)  int imageQuality
           
(package private)  String imageType
           
(package private)  String inputFileName
           
(package private)  boolean isSynced
           
private  JmolCallbackListener jmolCallbackListener
           
private  String[] jmolScriptCallbacks
           
private  JmolStatusListener jmolStatusListener
           
private static int MAXIMUM_QUEUE_LENGTH
           
private  Hashtable messageQueue
           
private  int minSyncRepeatMs
           
(package private)  String outputFileName
           
(package private)  int qualityJPG
           
(package private)  int qualityPNG
           
private  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)  String createImage(String fileNameOrError, String type, Object text_or_bytes, int quality)
          offer to let application do the image creation.
(package private)  String dialogAsk(String type, String fileName)
           
(package private)  boolean doSync()
           
(package private)  float[][] functionXY(String functionName, int nX, int nY)
           
(package private)  float[][][] functionXYZ(String functionName, int nX, int nY, int nZ)
           
(package private)  Hashtable getMessageQueue()
           
(package private)  Hashtable getRegistryInfo()
           
(package private)  List getStatusChanged(String newStatusList)
           
(package private)  String getStatusList()
           
(package private)  int getSyncMode()
           
private  String jmolScriptCallback(int iCallback)
           
(package private)  String jsEval(String strEval)
           
(package private) static JmolDialogInterface newDialog(boolean forceNewTranslation)
           
private  boolean notifyEnabled(int type)
           
(package private)  void notifyError(String errType, String errMsg, String errMsgUntranslated)
           
(package private)  void notifyMinimizationStatus(String minStatus, Integer minSteps, Float minEnergy, Float minEnergyDiff)
           
private  void processScript(Object[] data)
           
private  boolean recordStatus(String statusName)
           
(package private)  void setAllowStatusReporting(boolean TF)
           
(package private)  void setCallbackFunction(String callbackType, String callbackFunction)
           
(package private)  void setFileLoadStatus(String fullPathName, String fileName, String modelName, String errorMsg, int ptLoad, boolean doCallback)
           
(package private)  void setJmolCallbackListener(JmolCallbackListener jmolCallbackListener)
           
(package private)  void setJmolStatusListener(JmolStatusListener jmolStatusListener, JmolCallbackListener jmolCallbackListener)
           
(package private)  void setScriptEcho(String strEcho, boolean isScriptQueued)
           
(package private)  void setScriptStatus(String strStatus, String statusMessage, int msWalltime, String strErrorMessageUntranslated)
           
(package private)  void setStatusAtomHovered(int iatom, String strInfo)
           
(package private)  void setStatusAtomPicked(int atomIndex, String strInfo)
           
private  void setStatusChanged(String statusName, int intInfo, 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(String status, int intInfo, String strMeasure, float value)
           
(package private)  void setStatusResized(int width, int height)
           
(package private)  void setSync(String mouseCommand)
           
(package private)  void setSyncDriver(int syncMode)
           
(package private)  void showUrl(String urlString)
           
(package private)  void syncSend(String script, String appletName)
           
 
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 String statusList

allowStatusReporting

private boolean allowStatusReporting

messageQueue

private Hashtable messageQueue

statusPtr

private int statusPtr

MAXIMUM_QUEUE_LENGTH

private static int MAXIMUM_QUEUE_LENGTH

jmolScriptCallbacks

private 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

inputFileName

String inputFileName

outputFileName

String outputFileName

dialogType

String dialogType

imageChoices

protected static final String[] imageChoices

imageExtensions

protected static final String[] imageExtensions

qualityJPG

int qualityJPG

qualityPNG

int qualityPNG

imageType

String imageType

imageQuality

int imageQuality
Constructor Detail

StatusManager

StatusManager(Viewer viewer)
Method Detail

setAllowStatusReporting

void setAllowStatusReporting(boolean TF)

getStatusList

String getStatusList()

getMessageQueue

Hashtable getMessageQueue()

recordStatus

private boolean recordStatus(String statusName)

setStatusChanged

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

getStatusChanged

List getStatusChanged(String newStatusList)

setJmolStatusListener

void setJmolStatusListener(JmolStatusListener jmolStatusListener,
                           JmolCallbackListener jmolCallbackListener)

setJmolCallbackListener

void setJmolCallbackListener(JmolCallbackListener jmolCallbackListener)

jmolScriptCallback

private String jmolScriptCallback(int iCallback)

setCallbackFunction

void setCallbackFunction(String callbackType,
                         String callbackFunction)

notifyEnabled

private boolean notifyEnabled(int type)

setStatusAtomPicked

void setStatusAtomPicked(int atomIndex,
                         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,
                          String strInfo)

setFileLoadStatus

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

setStatusFrameChanged

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

setScriptEcho

void setScriptEcho(String strEcho,
                   boolean isScriptQueued)

setStatusMeasuring

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

notifyError

void notifyError(String errType,
                 String errMsg,
                 String errMsgUntranslated)

notifyMinimizationStatus

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

setScriptStatus

void setScriptStatus(String strStatus,
                     String statusMessage,
                     int msWalltime,
                     String strErrorMessageUntranslated)

processScript

private void processScript(Object[] data)

doSync

boolean doSync()

setSync

void setSync(String mouseCommand)

setSyncDriver

void setSyncDriver(int syncMode)

syncSend

void syncSend(String script,
              String appletName)

getSyncMode

int getSyncMode()

showUrl

void showUrl(String urlString)

clearConsole

void clearConsole()

functionXY

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

functionXYZ

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

jsEval

String jsEval(String strEval)

createImage

String createImage(String fileNameOrError,
                   String type,
                   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

Hashtable getRegistryInfo()

newDialog

static JmolDialogInterface newDialog(boolean forceNewTranslation)

dialogAsk

String dialogAsk(String type,
                 String fileName)