Class Widgets.Widget

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) java.lang.String name  
    • Constructor Summary

      Constructors 
      Constructor Description
      Widget()  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      (package private) abstract java.lang.String getJavaScript​(int appletID, JmolInstance instance)
      Each Widget must implement this function and make sure to use the appletID number to specify the target applet i.e.
      (package private) abstract java.lang.String getJavaScriptFileName()
      A COPY OF THIS .JS FILE MUST BE STORED IN THE html PART OF WEBEXPORT
      (package private) abstract java.lang.String[] getSupportFileNames()
      The list of files returned by this function should contain the full path to each file.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • name

        java.lang.String name
    • Constructor Detail

      • Widget

        Widget()
    • Method Detail

      • getJavaScript

        abstract java.lang.String getJavaScript​(int appletID,
                                                JmolInstance instance)
        Each Widget must implement this function and make sure to use the appletID number to specify the target applet i.e. "JmolApplet(appletID)". NOTE anything that must be translated in the web page should be wrapped in both a call to GT.escapeHTML and GT._ as in the following: GT.escapeHTML(GT._("text to translate"))
        Parameters:
        appletID -
        instance -
        Returns:
        the JavaScript and html to implement the widget
      • getJavaScriptFileName

        abstract java.lang.String getJavaScriptFileName()
        A COPY OF THIS .JS FILE MUST BE STORED IN THE html PART OF WEBEXPORT
        Returns:
        "none" (no file needed) or javascript file necessary to implement the widget
      • getSupportFileNames

        abstract java.lang.String[] getSupportFileNames()
        The list of files returned by this function should contain the full path to each file. The only exception is that files that only contain a filename will be assumed to be in the html section of WebExport.
        Returns:
        string of filenames.