jspecview.applet

Class JSVAppletPrivate

java.lang.Object

jspecview.applet.JSVAppletPrivate

All Implemented Interfaces:

JSVAppletInterface, PanelListener, ScriptInterface

Direct Known Subclasses:

JSVAppletPrivatePro

public class JSVAppletPrivate
extends java.lang.Object
implements PanelListener, ScriptInterface, JSVAppletInterface

JSpecView Applet class. For a list of parameters and scripting functionality see the file JSpecView_Applet_Specification.html.

Author:

Bob Hanson, Debbie-Ann Facey, Khari A. Bryan, Craig A. D. Walters, Prof Robert J. Lancashire

Method Summary

Methods

Modifier and Type	Method and Description
void	addHighlight(double x1, double x2, int r, int g, int b, int a) Method that can be called from another applet or from javascript that adds a highlight to a portion of the plot area of a JSVPanel
void	checkCallbacks(java.lang.String title)
void	checkOverlay()
void	closeSource(JDXSource source)
JDXSource	createSource(java.lang.String data, java.lang.String filePath, java.net.URL base, int firstSpec, int lastSpec)
void	execClose(java.lang.String value, boolean fromScript)
java.lang.String	execExport(JSVPanel jsvp, java.lang.String value)
void	execHidden(boolean b)
java.lang.String	execLoad(java.lang.String value)
void	execScriptComplete(java.lang.String msg, boolean isOK)
void	execSetAutoIntegrate(boolean b)
void	execSetCallback(ScriptToken st, java.lang.String value)
void	execSetInterface(java.lang.String value)
void	execTest(java.lang.String value)
java.lang.String	exportSpectrum(java.lang.String type, int n) Delivers spectrum coded as desired: XY, SQZ, PAC, DIF, DIFDUP, FIX, AML, CML
boolean	getAutoCombine()
boolean	getAutoShowLegend()
java.lang.String	getCoordinate() Method that can be called from another applet or from javascript to return the coordinate of clicked point in the plot area of the JSVPanel
JDXSource	getCurrentSource()
java.net.URL	getDocumentBase()
java.lang.String	getFileAsString(java.lang.String value)
int	getFileCount()
java.lang.String	getIntegrationRatios()
JDXSpectrum.IRMode	getIRMode()
JSVPanel	getNewJSVPanel(JDXSpectrum spec)
JSVPanel	getNewJSVPanel(java.util.List<JDXSpectrum> specs)
JSVPanelNode	getNewPanelNode(java.lang.String id, java.lang.String fileName, JDXSource source, JSVPanel jsvp)
JSVDialog	getOverlayLegend(JSVPanel jsvp)
PanelData	getPanelData()
java.util.List<JSVPanelNode>	getPanelNodes()
Parameters	getParameters()
java.lang.Object	getPopupMenu()
java.util.Map<java.lang.String,java.lang.Object>	getPropertyAsJavaObject(java.lang.String key)
java.lang.String	getPropertyAsJSON(java.lang.String key)
java.lang.String	getReturnFromJmolModel()
JSVPanel	getSelectedPanel()
java.lang.String	getSolnColour() Returns the calculated colour of a visible spectrum (Transmittance)
java.lang.Object	getSpectraTree()
int	incrementScriptLevelCount(int n)
int	incrementViewCount(int n)
boolean	isPro()
boolean	isSigned()
void	loadInline(java.lang.String data) Loads in-line JCAMP-DX data into the existing applet window
void	openDataOrFile(java.lang.String data, java.lang.String name, java.util.List<JDXSpectrum> specs, java.lang.String url, int firstSpec, int lastSpec, boolean isAppend)
void	panelEvent(java.lang.Object eventObj) called by notifyPeakPickedListeners in JSVPanel
void	print() Opens the print dialog to enable printing
java.lang.String	print(java.lang.String pdfFileName) Opens the print dialog to enable printing
void	process(java.util.List<JDXSpectrum> specs)
void	removeAllHighlights() Method that can be called from another applet or from javascript that removes all highlights from the plot area of a JSVPanel
void	removeHighlight(double x1, double x2) Method that can be called from another applet or from javascript that removes a highlight from the plot area of a JSVPanel
void	repaint()
void	repaintCompleted()
void	requestRepaint()
void	reversePlot() Method that can be called from another applet or from javascript that toggles reversing the plot on a JSVPanel
void	runScript(java.lang.String script) runs a script in proper order as listed
boolean	runScriptNow(java.lang.String params)
void	sendPanelChange(JSVPanel jsvp)
void	setCurrentSource(JDXSource source)
void	setCursorObject(java.lang.Object c)
void	setFileCount(int n)
void	setFilePath(java.lang.String tmpFilePath)
void	setIntegrationRatios(java.lang.String value)
void	setIRMode(JDXSpectrum.IRMode mode)
void	setLoaded(java.lang.String fileName, java.lang.String filePath)
void	setLoadImaginary(boolean TF)
void	setMenuEnables(JSVPanelNode node, boolean isSplit)
void	setNode(JSVPanelNode panelNode, boolean fromTree)
JSVPanelNode	setOverlayVisibility(JSVPanelNode node)
void	setPropertiesFromPreferences(JSVPanel jsvp, boolean includeMeasures)
void	setProperty(java.lang.String key, java.lang.String value)
void	setRecentURL(java.lang.String filePath)
void	setReturnFromJmolModel(java.lang.String model)
void	setSelectedPanel(JSVPanel jsvp)
JSVPanel	setSpectrum(java.lang.String value)
void	setSpectrumNumber(int n) Sets the spectrum to the specified block number
void	setVisible(boolean b)
void	showProperties()
void	syncLoad(java.lang.String filePath) Loads a new file into the existing applet window
void	syncScript(java.lang.String peakScript) precede
void	syncToJmol(java.lang.String msg)
void	toggleCoordinate() Method that can be called from another applet or from javascript that toggles the coordinate on a JSVPanel
void	toggleGrid() Method that can be called from another applet or from javascript that toggles the grid on a JSVPanel
void	toggleIntegration() Method that can be called from another applet or from javascript that toggles the integration graph of a JSVPanel.
void	updateBoolean(ScriptToken st, boolean TF)
void	updateRecentMenus(java.lang.String filePath)
void	validateAndRepaint()
void	writeStatus(java.lang.String msg) Writes a message to the status label

Methods inherited from class java.lang.Object

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

Method Detail

isPro

public boolean isPro()

Specified by:

isPro in interface JSVAppletInterface

isSigned

public boolean isSigned()

Specified by:

isSigned in interface JSVAppletInterface

Specified by:

isSigned in interface ScriptInterface

getCurrentSource

public JDXSource getCurrentSource()

Specified by:

getCurrentSource in interface ScriptInterface

setCurrentSource

public void setCurrentSource(JDXSource source)

Specified by:

setCurrentSource in interface ScriptInterface

getFileCount

public int getFileCount()

Specified by:

getFileCount in interface ScriptInterface

setFileCount

public void setFileCount(int n)

Specified by:

setFileCount in interface ScriptInterface

setIntegrationRatios

public void setIntegrationRatios(java.lang.String value)

Specified by:

setIntegrationRatios in interface ScriptInterface

getIntegrationRatios

public java.lang.String getIntegrationRatios()

Specified by:

getIntegrationRatios in interface ScriptInterface

setIRMode

public void setIRMode(JDXSpectrum.IRMode mode)

Specified by:

setIRMode in interface ScriptInterface

getIRMode

public JDXSpectrum.IRMode getIRMode()

Specified by:

getIRMode in interface ScriptInterface

setLoadImaginary

public void setLoadImaginary(boolean TF)

Specified by:

setLoadImaginary in interface ScriptInterface

getPanelNodes

public java.util.List<JSVPanelNode> getPanelNodes()

Specified by:

getPanelNodes in interface ScriptInterface

getParameters

public Parameters getParameters()

Specified by:

getParameters in interface ScriptInterface

getPopupMenu

public java.lang.Object getPopupMenu()

Specified by:

getPopupMenu in interface ScriptInterface

incrementScriptLevelCount

public int incrementScriptLevelCount(int n)

Specified by:

incrementScriptLevelCount in interface ScriptInterface

getSelectedPanel

public JSVPanel getSelectedPanel()

Specified by:

getSelectedPanel in interface ScriptInterface

getSpectraTree

public java.lang.Object getSpectraTree()

Specified by:

getSpectraTree in interface ScriptInterface

incrementViewCount

public int incrementViewCount(int n)

Specified by:

incrementViewCount in interface ScriptInterface

getPropertyAsJavaObject

public java.util.Map<java.lang.String,java.lang.Object> getPropertyAsJavaObject(java.lang.String key)

Specified by:

getPropertyAsJavaObject in interface JSVAppletInterface

getPropertyAsJSON

public java.lang.String getPropertyAsJSON(java.lang.String key)

Specified by:

getPropertyAsJSON in interface JSVAppletInterface

getCoordinate

public java.lang.String getCoordinate()

Method that can be called from another applet or from javascript to return the coordinate of clicked point in the plot area of the JSVPanel

Specified by:

getCoordinate in interface JSVAppletInterface

Returns:

A String representation of the coordinate

loadInline

public void loadInline(java.lang.String data)

Loads in-line JCAMP-DX data into the existing applet window

Specified by:

loadInline in interface JSVAppletInterface

Parameters:

data - String

exportSpectrum

public java.lang.String exportSpectrum(java.lang.String type,
                              int n)

Delivers spectrum coded as desired: XY, SQZ, PAC, DIF, DIFDUP, FIX, AML, CML

Specified by:

exportSpectrum in interface JSVAppletInterface

Parameters:

type -

n -

Returns:

data

setFilePath

public void setFilePath(java.lang.String tmpFilePath)

Specified by:

setFilePath in interface JSVAppletInterface

setSpectrumNumber

public void setSpectrumNumber(int n)

Sets the spectrum to the specified block number

Specified by:

setSpectrumNumber in interface JSVAppletInterface

Parameters:

n -

reversePlot

public void reversePlot()

Method that can be called from another applet or from javascript that toggles reversing the plot on a JSVPanel

Specified by:

reversePlot in interface JSVAppletInterface

toggleGrid

public void toggleGrid()

Method that can be called from another applet or from javascript that toggles the grid on a JSVPanel

Specified by:

toggleGrid in interface JSVAppletInterface

toggleCoordinate

public void toggleCoordinate()

Method that can be called from another applet or from javascript that toggles the coordinate on a JSVPanel

Specified by:

toggleCoordinate in interface JSVAppletInterface

toggleIntegration

public void toggleIntegration()

Method that can be called from another applet or from javascript that toggles the integration graph of a JSVPanel.

Specified by:

toggleIntegration in interface JSVAppletInterface

addHighlight

public void addHighlight(double x1,
                double x2,
                int r,
                int g,
                int b,
                int a)

Method that can be called from another applet or from javascript that adds a highlight to a portion of the plot area of a JSVPanel

Specified by:

addHighlight in interface JSVAppletInterface

Parameters:

x1 - the starting x value

x2 - the ending x value

r - the red portion of the highlight color

g - the green portion of the highlight color

b - the blue portion of the highlight color

a - the alpha portion of the highlight color

removeAllHighlights

public void removeAllHighlights()

Method that can be called from another applet or from javascript that removes all highlights from the plot area of a JSVPanel

Specified by:

removeAllHighlights in interface JSVAppletInterface

removeHighlight

public void removeHighlight(double x1,
                   double x2)

Method that can be called from another applet or from javascript that removes a highlight from the plot area of a JSVPanel

Specified by:

removeHighlight in interface JSVAppletInterface

Parameters:

x1 - the starting x value

x2 - the ending x value

syncScript

public void syncScript(java.lang.String peakScript)

Description copied from interface: JSVAppletInterface

precede

Specified by:

syncScript in interface JSVAppletInterface

writeStatus

public void writeStatus(java.lang.String msg)

Writes a message to the status label

Specified by:

writeStatus in interface JSVAppletInterface

Specified by:

writeStatus in interface ScriptInterface

Parameters:

msg - the message

sendPanelChange

public void sendPanelChange(JSVPanel jsvp)

Specified by:

sendPanelChange in interface ScriptInterface

print

public void print()

Opens the print dialog to enable printing

print

public java.lang.String print(java.lang.String pdfFileName)

Opens the print dialog to enable printing

Specified by:

print in interface JSVAppletInterface

Specified by:

print in interface ScriptInterface

Returns:

"OK" if signedApplet or app; Base64-encoded string if unsigned applet or null if problem

repaint

public void repaint()

Specified by:

repaint in interface ScriptInterface

validateAndRepaint

public void validateAndRepaint()

Specified by:

validateAndRepaint in interface ScriptInterface

syncLoad

public void syncLoad(java.lang.String filePath)

Loads a new file into the existing applet window

Specified by:

syncLoad in interface ScriptInterface

Parameters:

filePath -

openDataOrFile

public void openDataOrFile(java.lang.String data,
                  java.lang.String name,
                  java.util.List<JDXSpectrum> specs,
                  java.lang.String url,
                  int firstSpec,
                  int lastSpec,
                  boolean isAppend)

Specified by:

openDataOrFile in interface ScriptInterface

runScriptNow

public boolean runScriptNow(java.lang.String params)

Specified by:

runScriptNow in interface JSVAppletInterface

setSelectedPanel

public void setSelectedPanel(JSVPanel jsvp)

Specified by:

setSelectedPanel in interface ScriptInterface

panelEvent

public void panelEvent(java.lang.Object eventObj)

called by notifyPeakPickedListeners in JSVPanel

Specified by:

panelEvent in interface PanelListener

runScript

public void runScript(java.lang.String script)

Description copied from interface: JSVAppletInterface

runs a script in proper order as listed

Specified by:

runScript in interface JSVAppletInterface

Specified by:

runScript in interface ScriptInterface

execExport

public java.lang.String execExport(JSVPanel jsvp,
                          java.lang.String value)

Specified by:

execExport in interface ScriptInterface

execSetCallback

public void execSetCallback(ScriptToken st,
                   java.lang.String value)

Specified by:

execSetCallback in interface ScriptInterface

getSolnColour

public java.lang.String getSolnColour()

Returns the calculated colour of a visible spectrum (Transmittance)

Specified by:

getSolnColour in interface JSVAppletInterface

Returns:

Color

execClose

public void execClose(java.lang.String value,
             boolean fromScript)

Specified by:

execClose in interface ScriptInterface

execLoad

public java.lang.String execLoad(java.lang.String value)

Specified by:

execLoad in interface ScriptInterface

execHidden

public void execHidden(boolean b)

Specified by:

execHidden in interface ScriptInterface

execSetInterface

public void execSetInterface(java.lang.String value)

Specified by:

execSetInterface in interface ScriptInterface

execScriptComplete

public void execScriptComplete(java.lang.String msg,
                      boolean isOK)

Specified by:

execScriptComplete in interface ScriptInterface

setSpectrum

public JSVPanel setSpectrum(java.lang.String value)

Specified by:

setSpectrum in interface ScriptInterface

execSetAutoIntegrate

public void execSetAutoIntegrate(boolean b)

Specified by:

execSetAutoIntegrate in interface ScriptInterface

getPanelData

public PanelData getPanelData()

Specified by:

getPanelData in interface ScriptInterface

getOverlayLegend

public JSVDialog getOverlayLegend(JSVPanel jsvp)

Specified by:

getOverlayLegend in interface ScriptInterface

syncToJmol

public void syncToJmol(java.lang.String msg)

Specified by:

syncToJmol in interface ScriptInterface

Parameters:

msg -

setVisible

public void setVisible(boolean b)

Specified by:

setVisible in interface JSVAppletInterface

showProperties

public void showProperties()

Specified by:

showProperties in interface ScriptInterface

updateBoolean

public void updateBoolean(ScriptToken st,
                 boolean TF)

Specified by:

updateBoolean in interface ScriptInterface

checkCallbacks

public void checkCallbacks(java.lang.String title)

Specified by:

checkCallbacks in interface ScriptInterface

setOverlayVisibility

public JSVPanelNode setOverlayVisibility(JSVPanelNode node)

Specified by:

setOverlayVisibility in interface ScriptInterface

setNode

public void setNode(JSVPanelNode panelNode,
           boolean fromTree)

Specified by:

setNode in interface ScriptInterface

closeSource

public void closeSource(JDXSource source)

Specified by:

closeSource in interface ScriptInterface

process

public void process(java.util.List<JDXSpectrum> specs)

setCursorObject

public void setCursorObject(java.lang.Object c)

Specified by:

setCursorObject in interface ScriptInterface

getAutoCombine

public boolean getAutoCombine()

Specified by:

getAutoCombine in interface ScriptInterface

getDocumentBase

public java.net.URL getDocumentBase()

Specified by:

getDocumentBase in interface ScriptInterface

createSource

public JDXSource createSource(java.lang.String data,
                     java.lang.String filePath,
                     java.net.URL base,
                     int firstSpec,
                     int lastSpec)
                       throws java.lang.Exception

Specified by:

createSource in interface ScriptInterface

Throws:

java.lang.Exception

getNewJSVPanel

public JSVPanel getNewJSVPanel(java.util.List<JDXSpectrum> specs)

Specified by:

getNewJSVPanel in interface ScriptInterface

getNewJSVPanel

public JSVPanel getNewJSVPanel(JDXSpectrum spec)

Specified by:

getNewJSVPanel in interface ScriptInterface

getNewPanelNode

public JSVPanelNode getNewPanelNode(java.lang.String id,
                           java.lang.String fileName,
                           JDXSource source,
                           JSVPanel jsvp)

Specified by:

getNewPanelNode in interface ScriptInterface

getAutoShowLegend

public boolean getAutoShowLegend()

Specified by:

getAutoShowLegend in interface ScriptInterface

checkOverlay

public void checkOverlay()

Specified by:

checkOverlay in interface ScriptInterface

setReturnFromJmolModel

public void setReturnFromJmolModel(java.lang.String model)

Specified by:

setReturnFromJmolModel in interface ScriptInterface

getReturnFromJmolModel

public java.lang.String getReturnFromJmolModel()

Specified by:

getReturnFromJmolModel in interface ScriptInterface

setPropertiesFromPreferences

public void setPropertiesFromPreferences(JSVPanel jsvp,
                                boolean includeMeasures)

Specified by:

setPropertiesFromPreferences in interface ScriptInterface

requestRepaint

public void requestRepaint()

Specified by:

requestRepaint in interface ScriptInterface

repaintCompleted

public void repaintCompleted()

Specified by:

repaintCompleted in interface ScriptInterface

setLoaded

public void setLoaded(java.lang.String fileName,
             java.lang.String filePath)

Specified by:

setLoaded in interface ScriptInterface

setMenuEnables

public void setMenuEnables(JSVPanelNode node,
                  boolean isSplit)

Specified by:

setMenuEnables in interface ScriptInterface

setRecentURL

public void setRecentURL(java.lang.String filePath)

Specified by:

setRecentURL in interface ScriptInterface

updateRecentMenus

public void updateRecentMenus(java.lang.String filePath)

Specified by:

updateRecentMenus in interface ScriptInterface

execTest

public void execTest(java.lang.String value)

Specified by:

execTest in interface ScriptInterface

setProperty

public void setProperty(java.lang.String key,
               java.lang.String value)

Specified by:

setProperty in interface ScriptInterface

getFileAsString

public java.lang.String getFileAsString(java.lang.String value)

Specified by:

getFileAsString in interface ScriptInterface