Package org.jmol.util

Class GenericApplet

    • Constructor Summary

      Constructors 
      Constructor Description
      GenericApplet()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      int cacheFileByName​(java.lang.String fileName, boolean isAdd)  
      void cachePut​(java.lang.String key, java.lang.Object data)  
      (package private) static void checkIn​(java.lang.String name, java.lang.Object applet)  
      (package private) static void checkOut​(java.lang.String name)  
      private void consoleMessage​(java.lang.String message)  
      java.lang.String createImage​(java.lang.String fileName, java.lang.String type, java.lang.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 java.lang.String doEval​(java.lang.String strEval)
      return RAW JAVASCRIPT OBJECT, NOT A STRING
      protected java.lang.String doSendCallback​(CBK type, java.lang.Object callback, java.lang.Object[] data, java.lang.String strInfo)  
      protected void doShowDocument​(java.net.URL url)  
      protected void doShowStatus​(java.lang.String message)  
      java.lang.String eval​(java.lang.String strEval)  
      (package private) static void findApplets​(java.lang.String appletName, java.lang.String mySyncId, java.lang.String excludeName, javajs.util.Lst<java.lang.String> apps)  
      float[][] functionXY​(java.lang.String functionName, int nX, int nY)
      for isosurface FUNCTIONXY
      float[][][] functionXYZ​(java.lang.String functionName, int nX, int nY, int nZ)
      for isosurface FUNCTIONXYZ
      java.lang.String getAppletInfo()  
      protected boolean getBooleanValue​(java.lang.String propertyName, boolean defaultValue)  
      java.lang.String getFullName()  
      java.lang.Object getGLmolView()
      This method is only called by JmolGLmol applet._refresh();
      protected java.lang.String getJmolParameter​(java.lang.String paramName)  
      java.util.Map<java.lang.String,​java.lang.Object> getJSpecViewProperty​(java.lang.String key)
      JSpecView shares the JmolSyncInterface; used to get JSpecView
      int getModelIndexFromId​(java.lang.String id)  
      java.lang.Object getProperty​(java.lang.String infoType)  
      java.lang.Object getProperty​(java.lang.String infoType, java.lang.String paramInfo)  
      java.lang.String getPropertyAsJSON​(java.lang.String infoType)  
      java.lang.String getPropertyAsJSON​(java.lang.String infoType, java.lang.String paramInfo)  
      java.lang.String getPropertyAsString​(java.lang.String infoType)  
      java.lang.String getPropertyAsString​(java.lang.String infoType, java.lang.String paramInfo)  
      java.util.Map<java.lang.String,​java.lang.Object> getRegistryInfo()  
      protected java.lang.String getValue​(java.lang.String propertyName, java.lang.String defaultValue)  
      private java.lang.String getValueLowerCase​(java.lang.String paramName, java.lang.String defaultValue)  
      boolean handleEvent​(java.awt.Event e)  
      protected void init​(java.lang.Object applet)  
      private void initApplication()  
      protected void initOptions()  
      java.lang.String loadDOMNode​(java.lang.Object DOMNode)  
      java.lang.String loadInline​(java.lang.String strModel)
      Deprecated. 
      java.lang.String loadInline​(java.lang.String[] strModels)
      Deprecated. 
      java.lang.String loadInline​(java.lang.String[] strModels, java.lang.String script)
      Deprecated. 
      java.lang.String loadInline​(java.lang.String strModel, java.lang.String script)
      Deprecated. 
      java.lang.String loadInlineArray​(java.lang.String[] strModels, java.lang.String script, boolean isAppend)  
      java.lang.String loadInlineString​(java.lang.String strModel, java.lang.String script, boolean isAppend)  
      void notifyAudioEnded​(java.lang.Object htParams)  
      void notifyCallback​(CBK type, java.lang.Object[] data)  
      boolean notifyEnabled​(CBK type)  
      private java.lang.String notifySync​(java.lang.String info, java.lang.String appletName)  
      java.lang.String openFile​(java.lang.String fileName)
      possibly called from JSmolApplet.js upon start up
      void openFileAsyncSpecial​(java.lang.String fileName, int flags)  
      void output​(java.lang.String s)  
      boolean processMouseEvent​(int id, int x, int y, int modifiers, long time)  
      void processTwoPointGesture​(float[][][] touches)  
      void register​(java.lang.String id, JmolSyncInterface jsi)  
      (package private) void resizeDisplay​(int width, int height)  
      int[] resizeInnerPanel​(java.lang.String data)  
      void script​(java.lang.String script)  
      java.lang.String scriptCheck​(java.lang.String script)  
      java.lang.String scriptNoWait​(java.lang.String script)  
      private java.lang.String scriptProcessor​(java.lang.String script, java.lang.String statusParams, int processType)  
      java.lang.String scriptWait​(java.lang.String script)  
      java.lang.String scriptWait​(java.lang.String script, java.lang.String statusParams)  
      java.lang.String scriptWaitOutput​(java.lang.String script)  
      private java.lang.String sendScript​(java.lang.String script, java.lang.String appletName, boolean isSync, boolean doCallback)  
      void setCallback​(java.lang.String name, java.lang.Object callbackObject)
      set a callback either as a function or a function name from JavaScript
      void setCallbackFunction​(java.lang.String callbackName, java.lang.String callbackObject)
      From StatusManager
      void setDisplay​(java.lang.Object canvas)  
      protected void setJSOptions​(java.util.Map<java.lang.String,​java.lang.Object> vwrOptions)  
      void setScreenDimension​(int width, int height)  
      boolean setStatusDragDropped​(int mode, int x, int y, java.lang.String fileName)  
      java.lang.Object setStereoGraphics​(boolean isStereo)  
      private void setStringProperty​(java.lang.String name, java.lang.String value)  
      void showUrl​(java.lang.String urlString)  
      void startHoverWatcher​(boolean enable)  
      void syncScript​(java.lang.String script)  
      void update()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • htRegistry

        protected static java.util.Map<java.lang.String,​java.lang.Object> htRegistry

      • isJS

        protected static boolean isJS

      • codeBase

        protected java.lang.String codeBase

      • documentBase

        protected java.lang.String documentBase

      • isSigned

        protected boolean isSigned

      • language

        protected java.lang.String language

      • doTranslate

        protected boolean doTranslate

      • haveDocumentAccess

        protected boolean haveDocumentAccess

      • isStereoSlave

        protected boolean isStereoSlave

      • mayScript

        protected boolean mayScript

      • htmlName

        protected java.lang.String htmlName

      • fullName

        protected java.lang.String fullName

      • statusForm

        protected java.lang.String statusForm

      • statusText

        protected java.lang.String statusText

      • statusTextarea

        protected java.lang.String statusTextarea

      • gRight

        protected java.lang.Object gRight

      • viewer

        protected Viewer viewer

      • callbacks

        protected java.util.Map<CBK,​java.lang.String> callbacks

      • vwrOptions

        protected java.util.Map<java.lang.String,​java.lang.Object> vwrOptions

      • haveNotifiedError

        protected boolean haveNotifiedError

      • appletObject

        protected java.lang.Object appletObject

      • loading

        private boolean loading

      • syncId

        private java.lang.String syncId

      • outputBuffer

        private javajs.util.SB outputBuffer

      • htParams

        protected java.util.Map<java.lang.String,​java.lang.Object> htParams

    • Constructor Detail

      • GenericApplet

        public GenericApplet()

    • Method Detail

      • processMouseEvent

        public boolean processMouseEvent​(int id,
                                 int x,
                                 int y,
                                 int modifiers,
                                 long time)
        Specified by:
        processMouseEvent in interface javajs.api.JSInterface

      • setDisplay

        public void setDisplay​(java.lang.Object canvas)
        Specified by:
        setDisplay in interface javajs.api.JSInterface

      • setStatusDragDropped

        public boolean setStatusDragDropped​(int mode,
                                    int x,
                                    int y,
                                    java.lang.String fileName)
        Specified by:
        setStatusDragDropped in interface javajs.api.JSInterface

      • startHoverWatcher

        public void startHoverWatcher​(boolean enable)
        Specified by:
        startHoverWatcher in interface javajs.api.JSInterface

      • update

        public void update()
        Specified by:
        update in interface javajs.api.JSInterface

      • openFileAsyncSpecial

        public void openFileAsyncSpecial​(java.lang.String fileName,
                                 int flags)
        Specified by:
        openFileAsyncSpecial in interface javajs.api.JSInterface

      • processTwoPointGesture

        public void processTwoPointGesture​(float[][][] touches)
        Specified by:
        processTwoPointGesture in interface javajs.api.JSInterface

      • setScreenDimension

        public void setScreenDimension​(int width,
                               int height)
        Specified by:
        setScreenDimension in interface javajs.api.JSInterface

      • resizeDisplay

        void resizeDisplay​(int width,
                   int height)

      • init

        protected void init​(java.lang.Object applet)

      • initApplication

        private void initApplication()

      • destroy

        public void destroy()
        Specified by:
        destroy in interface JmolAppletInterface
        Specified by:
        destroy in interface javajs.api.JSInterface

      • getBooleanValue

        protected boolean getBooleanValue​(java.lang.String propertyName,
                                  boolean defaultValue)

      • getValue

        protected java.lang.String getValue​(java.lang.String propertyName,
                                    java.lang.String defaultValue)

      • getValueLowerCase

        private java.lang.String getValueLowerCase​(java.lang.String paramName,
                                           java.lang.String defaultValue)

      • setStringProperty

        private void setStringProperty​(java.lang.String name,
                               java.lang.String value)

      • scriptProcessor

        private java.lang.String scriptProcessor​(java.lang.String script,
                                         java.lang.String statusParams,
                                         int processType)

      • scriptWait

        public java.lang.String scriptWait​(java.lang.String script,
                                   java.lang.String statusParams)
        Specified by:
        scriptWait in interface JmolAppletInterface

      • getModelIndexFromId

        public int getModelIndexFromId​(java.lang.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 java.lang.Object getProperty​(java.lang.String infoType)
        Specified by:
        getProperty in interface JmolAppletInterface
        Parameters:
        infoType -
        Returns:
        value

      • getProperty

        public java.lang.Object getProperty​(java.lang.String infoType,
                                    java.lang.String paramInfo)
        Specified by:
        getProperty in interface JmolAppletInterface
        Parameters:
        infoType -
        paramInfo -
        Returns:
        value

      • getPropertyAsString

        public java.lang.String getPropertyAsString​(java.lang.String infoType)
        Specified by:
        getPropertyAsString in interface JmolAppletInterface
        Parameters:
        infoType -
        Returns:
        value

      • getPropertyAsString

        public java.lang.String getPropertyAsString​(java.lang.String infoType,
                                            java.lang.String paramInfo)
        Specified by:
        getPropertyAsString in interface JmolAppletInterface
        Parameters:
        infoType -
        paramInfo -
        Returns:
        value

      • getPropertyAsJSON

        public java.lang.String getPropertyAsJSON​(java.lang.String infoType)
        Specified by:
        getPropertyAsJSON in interface JmolAppletInterface
        Parameters:
        infoType -
        Returns:
        value

      • getPropertyAsJSON

        public java.lang.String getPropertyAsJSON​(java.lang.String infoType,
                                          java.lang.String paramInfo)
        Specified by:
        getPropertyAsJSON in interface JmolAppletInterface
        Parameters:
        infoType -
        paramInfo -
        Returns:
        value

      • loadInlineString

        public java.lang.String loadInlineString​(java.lang.String strModel,
                                         java.lang.String script,
                                         boolean isAppend)
        Specified by:
        loadInlineString in interface JmolAppletInterface

      • loadInlineArray

        public java.lang.String loadInlineArray​(java.lang.String[] strModels,
                                        java.lang.String script,
                                        boolean isAppend)
        Specified by:
        loadInlineArray in interface JmolAppletInterface

      • loadInline

        @Deprecated
public java.lang.String loadInline​(java.lang.String strModel)
        Deprecated.
        Specified by:
        loadInline in interface JmolAppletInterface
        Parameters:
        strModel -
        Returns:
        error or null

      • loadInline

        @Deprecated
public java.lang.String loadInline​(java.lang.String strModel,
                                   java.lang.String script)
        Deprecated.
        Specified by:
        loadInline in interface JmolAppletInterface
        Parameters:
        strModel -
        script -
        Returns:
        error or null

      • loadInline

        @Deprecated
public java.lang.String loadInline​(java.lang.String[] strModels)
        Deprecated.
        Specified by:
        loadInline in interface JmolAppletInterface
        Parameters:
        strModels -
        Returns:
        error or null

      • loadInline

        @Deprecated
public java.lang.String loadInline​(java.lang.String[] strModels,
                                   java.lang.String script)
        Deprecated.
        Specified by:
        loadInline in interface JmolAppletInterface
        Parameters:
        strModels -
        script -
        Returns:
        error or null

      • output

        public void output​(java.lang.String s)

      • setCallback

        public void setCallback​(java.lang.String name,
                        java.lang.Object callbackObject)
        set a callback either as a function or a function name from JavaScript
        Specified by:
        setCallback in interface JmolAppletInterface

      • setCallbackFunction

        public void setCallbackFunction​(java.lang.String callbackName,
                                java.lang.String callbackObject)
        From StatusManager
        Specified by:
        setCallbackFunction in interface JmolCallbackListener

      • consoleMessage

        private void consoleMessage​(java.lang.String message)

      • notifyCallback

        public void notifyCallback​(CBK type,
                           java.lang.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 java.lang.String sendScript​(java.lang.String script,
                                    java.lang.String appletName,
                                    boolean isSync,
                                    boolean doCallback)

      • notifySync

        private java.lang.String notifySync​(java.lang.String info,
                                    java.lang.String appletName)

      • eval

        public java.lang.String eval​(java.lang.String strEval)
        Specified by:
        eval in interface JmolStatusListener

      • createImage

        public java.lang.String createImage​(java.lang.String fileName,
                                    java.lang.String type,
                                    java.lang.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

      • checkIn

        static void checkIn​(java.lang.String name,
                    java.lang.Object applet)

      • checkOut

        static void checkOut​(java.lang.String name)

      • findApplets

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

      • setJSOptions

        protected void setJSOptions​(java.util.Map<java.lang.String,​java.lang.Object> vwrOptions)

      • initOptions

        protected void initOptions()

      • getJmolParameter

        protected java.lang.String getJmolParameter​(java.lang.String paramName)

      • functionXY

        public float[][] functionXY​(java.lang.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​(java.lang.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

      • doShowDocument

        protected void doShowDocument​(java.net.URL url)

      • doSendCallback

        protected java.lang.String doSendCallback​(CBK type,
                                          java.lang.Object callback,
                                          java.lang.Object[] data,
                                          java.lang.String strInfo)

      • doEval

        protected java.lang.String doEval​(java.lang.String strEval)
        return RAW JAVASCRIPT OBJECT, NOT A STRING
        Parameters:
        strEval -
        Returns:
        result, not necessarily a String

      • doShowStatus

        protected void doShowStatus​(java.lang.String message)

      • getGLmolView

        public java.lang.Object getGLmolView()
        This method is only called by JmolGLmol applet._refresh();
        Returns:
        enough data to update a WebGL view

      • openFile

        public java.lang.String openFile​(java.lang.String fileName)
        possibly called from JSmolApplet.js upon start up
        Parameters:
        fileName -
        Returns:
        error or null

      • cacheFileByName

        public int cacheFileByName​(java.lang.String fileName,
                           boolean isAdd)
        Specified by:
        cacheFileByName in interface javajs.api.JSInterface

      • cachePut

        public void cachePut​(java.lang.String key,
                     java.lang.Object data)
        Specified by:
        cachePut in interface javajs.api.JSInterface

      • getFullName

        public java.lang.String getFullName()
        Specified by:
        getFullName in interface javajs.api.JSInterface