|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jmol.api.JmolSimpleViewer
org.jmol.api.JmolViewer
public abstract class JmolViewer
This is the high-level API for the JmolViewer for simple access.
We will implement a low-level API at some point
Field Summary | |
---|---|
String |
menuStructure
|
Constructor Summary | |
---|---|
JmolViewer()
|
Method Summary | |
---|---|
abstract void |
addSelectionListener(JmolSelectionListener listener)
|
static JmolViewer |
allocateViewer(Component awtComponent,
JmolAdapter jmolAdapter)
OK, but safer to assign htmlName, URL bases, comandOptions, and statusListener now. |
static JmolViewer |
allocateViewer(Component awtComponent,
JmolAdapter jmolAdapter,
String htmlName,
URL documentBase,
URL codeBase,
String commandOptions,
JmolStatusListener statusListener)
This is the main access point for creating an application or applet viewer. |
abstract boolean |
checkHalt(String strCommand,
boolean isInterrupt)
|
static boolean |
checkOption(JmolViewer viewer,
String option)
|
abstract boolean |
checkPrivateKey(double privateKey)
|
abstract void |
clearMeasurements()
|
abstract void |
clearSelection()
|
abstract String |
clipImage(String text)
|
abstract Object |
createImage(String fileName,
String type,
Object text_or_bytes,
int quality,
int width,
int height)
|
abstract void |
deleteMeasurement(int i)
|
abstract String |
evalStringQuiet(String script)
|
abstract int |
findNearestAtomIndex(int x,
int y)
|
abstract String |
generateOutput(String type,
String[] fileName,
int width,
int height)
|
abstract String |
getAltLocListInModel(int modelIndex)
|
abstract int |
getAnimationFps()
|
abstract int |
getAtomArgb(int atomIndex)
|
abstract int |
getAtomCount()
|
abstract int |
getAtomCountInModel(int modelIndex)
|
abstract String |
getAtomInfo(int atomIndex)
|
abstract int |
getAtomModelIndex(int atomIndex)
|
abstract String |
getAtomName(int atomIndex)
|
abstract int |
getAtomNumber(int atomIndex)
|
abstract Point3f |
getAtomPoint3f(int atomIndex)
|
abstract float |
getAtomRadius(int atomIndex)
|
abstract boolean |
getAutoBond()
|
abstract boolean |
getAxesOrientationRasmol()
|
abstract int |
getBackgroundArgb()
|
abstract int |
getBondArgb1(int bondIndex)
|
abstract int |
getBondArgb2(int bondIndex)
|
abstract int |
getBondCount()
|
abstract int |
getBondCountInModel(int modelIndex)
|
abstract int |
getBondModelIndex(int bondIndex)
|
abstract int |
getBondOrder(int bondIndex)
|
abstract Point3f |
getBondPoint3f1(int bondIndex)
|
abstract Point3f |
getBondPoint3f2(int bondIndex)
|
abstract float |
getBondRadius(int bondIndex)
|
abstract float |
getBondTolerance()
|
abstract boolean |
getBooleanProperty(String propertyName)
|
boolean |
getBooleanProperty(String key,
boolean doICare)
|
abstract int |
getChainCount()
|
abstract int |
getChainCountInModel(int modelIindex)
|
abstract String |
getData(String atomExpression,
String type)
|
abstract Component |
getDisplay()
|
abstract int |
getDisplayModelIndex()
|
abstract BitSet |
getElementsPresentBitSet(int modelIndex)
|
abstract String |
getErrorMessage()
|
abstract String |
getErrorMessageUntranslated()
|
abstract Object |
getFileAsBytes(String fullPathName,
OutputStream os)
|
abstract String |
getFileAsString(String filename)
|
abstract boolean |
getFileAsString(String[] data,
int nBytesMax,
boolean doSpecialLoad)
|
abstract int |
getGroupCount()
|
abstract int |
getGroupCountInModel(int modelIndex)
|
abstract Hashtable |
getHeteroList(int modelIndex)
|
abstract Object |
getImageAs(String type,
int quality,
int width,
int height,
String fileName,
OutputStream os)
|
abstract String |
getJavaVendor()
|
abstract String |
getJavaVersion()
|
static String |
getJmolVersion()
|
abstract short |
getMadBond()
|
abstract int |
getMeasurementCount()
|
abstract int[] |
getMeasurementCountPlusIndices(int i)
|
abstract String |
getMeasurementStringValue(int i)
|
abstract float |
getMinBondDistance()
|
abstract JmolAdapter |
getModelAdapter()
|
abstract Hashtable |
getModelAuxiliaryInfo(int modelIndex)
|
abstract Object |
getModelAuxiliaryInfo(int modelIndex,
String keyName)
|
abstract int |
getModelCount()
|
abstract String |
getModelFileName(int modelIndex)
|
abstract String |
getModelName(int modelIndex)
|
abstract int |
getModelNumber(int modelIndex)
|
abstract String |
getModelNumberDotted(int modelIndex)
|
abstract Properties |
getModelProperties(int modelIndex)
|
abstract String |
getModelProperty(int modelIndex,
String propertyName)
|
abstract Hashtable |
getModelSetAuxiliaryInfo()
|
abstract String |
getModelSetFileName()
|
abstract String |
getModelSetName()
|
abstract String |
getModelSetPathName()
|
abstract Properties |
getModelSetProperties()
|
abstract int |
getMotionEventNumber()
|
abstract String |
getOperatingSystemName()
|
abstract Object |
getParameter(String name)
|
abstract int |
getPercentVdwAtom()
|
abstract boolean |
getPerspectiveDepth()
|
abstract int |
getPolymerCount()
|
abstract int |
getPolymerCountInModel(int modelIndex)
|
abstract Point3f[] |
getPolymerLeadMidPoints(int modelIndex,
int polymerIndex)
|
abstract float |
getRotationRadius()
|
abstract int |
getScreenHeight()
|
Image |
getScreenImage()
|
abstract Image |
getScreenImage(Graphics g)
|
abstract int |
getScreenWidth()
|
abstract int |
getSelectionCount()
|
abstract String |
getSetHistory(int howFarBack)
|
abstract boolean |
getShowAxes()
|
abstract boolean |
getShowBbcage()
|
abstract boolean |
getShowHydrogens()
|
abstract boolean |
getShowMeasurements()
|
abstract BitSet |
getSmartsMatch(String smarts,
BitSet bsSelected)
|
abstract String |
getStateInfo()
|
abstract Matrix4f |
getUnscaledTransformMatrix()
|
abstract BitSet |
getVisibleFramesBitSet()
|
abstract int |
getZoomPercent()
|
abstract float |
getZoomPercentFloat()
|
abstract void |
haltScriptExecution()
|
abstract boolean |
handleOldJvm10Event(Event e)
|
abstract boolean |
haveFrame()
|
abstract boolean |
havePartialCharges()
|
abstract void |
homePosition()
|
abstract boolean |
isApplet()
|
abstract boolean |
isScriptExecuting()
|
abstract String |
loadInline(List arrayData,
boolean isAppend)
NOTE: THIS METHOD DOES NOT PRESERVE THE STATE |
abstract String |
loadInline(String strModel)
|
abstract String |
loadInline(String[] arrayModels)
|
abstract String |
loadInline(String[] arrayModels,
boolean isAppend)
|
abstract String |
loadInline(String strModel,
boolean isAppend)
|
abstract String |
loadInline(String strModel,
char newLine)
|
abstract boolean |
modelHasVibrationVectors(int modelIndex)
|
abstract void |
notifyViewerRepaintDone()
|
abstract void |
openFileAsynchronously(String fileName)
|
abstract String |
openReader(String fullPathName,
String fileName,
Reader reader)
Opens the file and creates the model set, given the reader. |
abstract void |
popHoldRepaint()
|
abstract void |
pushHoldRepaint()
|
abstract void |
rebond()
|
abstract void |
refresh(int isOrientationChange,
String strWhy)
|
abstract void |
releaseScreenImage()
|
abstract void |
removeSelectionListener(JmolSelectionListener listener)
|
abstract void |
renderScreenImage(Graphics gLeft,
Graphics gRight,
Dimension size,
Rectangle clip)
an added class for rendering stereo in two independent applets |
abstract void |
rotateFront()
|
abstract void |
rotateX(float radians)
|
abstract void |
rotateX(int degrees)
|
abstract void |
rotateY(float radians)
|
abstract void |
rotateY(int degrees)
|
abstract void |
rotateZ(float radians)
|
abstract String |
script(String script)
|
abstract Object |
scriptCheck(String script)
|
abstract String |
scriptWait(String script)
|
abstract Object |
scriptWaitStatus(String script,
String statusList)
|
abstract void |
selectAll()
|
abstract void |
setAnimationFps(int framesPerSecond)
|
abstract void |
setAppletContext(String htmlName,
URL documentBase,
URL codeBase,
String commandOptions)
|
abstract void |
setAutoBond(boolean autoBond)
|
abstract void |
setAxesOrientationRasmol(boolean axesMessedUp)
|
abstract void |
setBondTolerance(float bondTolerance)
|
abstract void |
setBooleanProperty(String propertyName,
boolean value)
|
abstract void |
setCenterSelected()
|
abstract void |
setColorBackground(String colorName)
|
abstract void |
setDebugScript(boolean debugScript)
|
abstract void |
setFloatProperty(String propertyName,
float value)
|
abstract void |
setFrankOn(boolean frankOn)
|
abstract void |
setIntProperty(String propertyName,
int value)
|
abstract void |
setJmolCallbackListener(JmolCallbackListener jmolCallbackListener)
|
abstract void |
setJmolDefaults()
|
abstract void |
setJmolStatusListener(JmolStatusListener jmolStatusListener)
|
abstract void |
setMarBond(short marBond)
|
abstract void |
setMinBondDistance(float minBondDistance)
|
abstract void |
setModeMouse(int modeMouse)
|
abstract void |
setPercentVdwAtom(int percentVdwAtom)
|
abstract void |
setPerspectiveDepth(boolean perspectiveDepth)
|
abstract void |
setRasmolDefaults()
|
abstract void |
setScreenDimension(Dimension dim)
|
abstract void |
setSelectionHalos(boolean haloEnabled)
|
abstract void |
setSelectionSet(BitSet newSelection)
|
abstract void |
setShowAxes(boolean showAxes)
|
abstract void |
setShowBbcage(boolean showBbcage)
|
abstract void |
setShowHydrogens(boolean showHydrogens)
|
abstract void |
setShowMeasurements(boolean showMeasurements)
|
abstract void |
setStringProperty(String propertyName,
String value)
|
abstract void |
setVectorScale(float vectorScaleValue)
|
abstract void |
setVibrationPeriod(float vibrationPeriod)
|
abstract void |
setVibrationScale(float vibrationScaleValue)
|
abstract boolean |
showModelSetDownload()
|
abstract void |
showUrl(String urlString)
|
abstract void |
syncScript(String script,
String applet)
|
abstract void |
writeTextFile(String string,
String data)
|
Methods inherited from class org.jmol.api.JmolSimpleViewer |
---|
allocateSimpleViewer, evalFile, evalString, getProperty, openDOM, openFile, openFiles, openStringInline, renderScreenImage |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public String menuStructure
Constructor Detail |
---|
public JmolViewer()
Method Detail |
---|
public static JmolViewer allocateViewer(Component awtComponent, JmolAdapter jmolAdapter, String htmlName, URL documentBase, URL codeBase, String commandOptions, JmolStatusListener statusListener)
awtComponent
- jmolAdapter
- htmlName
- documentBase
- codeBase
- commandOptions
- statusListener
-
public abstract BitSet getSmartsMatch(String smarts, BitSet bsSelected)
public abstract void renderScreenImage(Graphics gLeft, Graphics gRight, Dimension size, Rectangle clip)
gLeft
- gRight
- size
- clip
- public static JmolViewer allocateViewer(Component awtComponent, JmolAdapter jmolAdapter)
awtComponent
- jmolAdapter
-
public static String getJmolVersion()
public static boolean checkOption(JmolViewer viewer, String option)
public abstract String generateOutput(String type, String[] fileName, int width, int height)
public abstract void setJmolCallbackListener(JmolCallbackListener jmolCallbackListener)
public abstract void setJmolStatusListener(JmolStatusListener jmolStatusListener)
public abstract void setAppletContext(String htmlName, URL documentBase, URL codeBase, String commandOptions)
public abstract boolean checkHalt(String strCommand, boolean isInterrupt)
public abstract void haltScriptExecution()
public abstract String getOperatingSystemName()
public abstract String getJavaVersion()
public abstract String getJavaVendor()
public abstract boolean haveFrame()
public abstract void pushHoldRepaint()
public abstract void popHoldRepaint()
public abstract String getData(String atomExpression, String type)
public abstract void setScreenDimension(Dimension dim)
public abstract int getScreenWidth()
public abstract int getScreenHeight()
public Image getScreenImage()
public abstract Image getScreenImage(Graphics g)
public abstract void releaseScreenImage()
public abstract void writeTextFile(String string, String data)
public abstract String clipImage(String text)
text
- null here clips image; String clips text
public abstract Object createImage(String fileName, String type, Object text_or_bytes, int quality, int width, int height)
fileName
- type
- text_or_bytes
- quality
- width
- height
-
public abstract Object getImageAs(String type, int quality, int width, int height, String fileName, OutputStream os)
type
- "PNG", "JPG", "JPEG", "JPG64", "PPM", "GIF"quality
- width
- height
- fileName
- os
-
public abstract boolean handleOldJvm10Event(Event e)
public abstract int getMotionEventNumber()
public abstract String openReader(String fullPathName, String fileName, Reader reader)
fullPathName
- fileName
- reader
-
public abstract void showUrl(String urlString)
public abstract int getMeasurementCount()
public abstract String getMeasurementStringValue(int i)
public abstract int[] getMeasurementCountPlusIndices(int i)
public abstract Component getDisplay()
public abstract BitSet getElementsPresentBitSet(int modelIndex)
public abstract int getAnimationFps()
public abstract int findNearestAtomIndex(int x, int y)
public abstract String script(String script)
public abstract Object scriptCheck(String script)
public abstract String scriptWait(String script)
public abstract Object scriptWaitStatus(String script, String statusList)
public abstract String loadInline(String strModel)
public abstract String loadInline(String strModel, boolean isAppend)
public abstract String loadInline(String strModel, char newLine)
public abstract String loadInline(String[] arrayModels)
public abstract String loadInline(String[] arrayModels, boolean isAppend)
arrayModels
- and array of models, each of which is a StringisAppend
-
public abstract String loadInline(List arrayData, boolean isAppend)
arrayData
- a List of models, where each model is either a String
or a String[] or a VectorisAppend
- TRUE to append models (no ZAP)
public abstract String evalStringQuiet(String script)
public abstract boolean isScriptExecuting()
public abstract String getModelSetName()
public abstract String getModelSetFileName()
public abstract String getModelSetPathName()
public abstract String getFileAsString(String filename)
public abstract boolean getFileAsString(String[] data, int nBytesMax, boolean doSpecialLoad)
public abstract Properties getModelSetProperties()
public abstract Hashtable getModelSetAuxiliaryInfo()
public abstract int getModelNumber(int modelIndex)
public abstract String getModelName(int modelIndex)
public abstract String getModelNumberDotted(int modelIndex)
public abstract Properties getModelProperties(int modelIndex)
public abstract String getModelProperty(int modelIndex, String propertyName)
public abstract Hashtable getModelAuxiliaryInfo(int modelIndex)
public abstract Object getModelAuxiliaryInfo(int modelIndex, String keyName)
public abstract boolean modelHasVibrationVectors(int modelIndex)
public abstract int getModelCount()
public abstract int getDisplayModelIndex()
public abstract BitSet getVisibleFramesBitSet()
public abstract int getAtomCount()
public abstract int getBondCount()
public abstract int getGroupCount()
public abstract int getChainCount()
public abstract int getPolymerCount()
public abstract int getAtomCountInModel(int modelIndex)
public abstract int getBondCountInModel(int modelIndex)
public abstract int getGroupCountInModel(int modelIndex)
public abstract int getChainCountInModel(int modelIindex)
public abstract int getPolymerCountInModel(int modelIndex)
public abstract int getSelectionCount()
public abstract void addSelectionListener(JmolSelectionListener listener)
public abstract void removeSelectionListener(JmolSelectionListener listener)
public abstract void homePosition()
public abstract Hashtable getHeteroList(int modelIndex)
public abstract boolean getPerspectiveDepth()
public abstract boolean getShowHydrogens()
public abstract boolean getShowMeasurements()
public abstract boolean getShowAxes()
public abstract boolean getShowBbcage()
public abstract int getAtomNumber(int atomIndex)
public abstract String getAtomName(int atomIndex)
public abstract String getAtomInfo(int atomIndex)
public abstract float getRotationRadius()
public abstract int getZoomPercent()
public abstract float getZoomPercentFloat()
public abstract Matrix4f getUnscaledTransformMatrix()
public abstract int getBackgroundArgb()
public abstract float getAtomRadius(int atomIndex)
public abstract Point3f getAtomPoint3f(int atomIndex)
public abstract int getAtomArgb(int atomIndex)
public abstract int getAtomModelIndex(int atomIndex)
public abstract float getBondRadius(int bondIndex)
public abstract Point3f getBondPoint3f1(int bondIndex)
public abstract Point3f getBondPoint3f2(int bondIndex)
public abstract int getBondArgb1(int bondIndex)
public abstract int getBondArgb2(int bondIndex)
public abstract int getBondOrder(int bondIndex)
public abstract int getBondModelIndex(int bondIndex)
public abstract Point3f[] getPolymerLeadMidPoints(int modelIndex, int polymerIndex)
public abstract boolean getAxesOrientationRasmol()
public abstract int getPercentVdwAtom()
public abstract boolean getAutoBond()
public abstract short getMadBond()
public abstract float getBondTolerance()
public abstract void rebond()
public abstract float getMinBondDistance()
public abstract void refresh(int isOrientationChange, String strWhy)
public abstract boolean showModelSetDownload()
public abstract void notifyViewerRepaintDone()
public abstract boolean getBooleanProperty(String propertyName)
public boolean getBooleanProperty(String key, boolean doICare)
public abstract Object getParameter(String name)
public abstract String getSetHistory(int howFarBack)
public abstract boolean havePartialCharges()
public abstract boolean isApplet()
public abstract String getAltLocListInModel(int modelIndex)
public abstract String getStateInfo()
public abstract void syncScript(String script, String applet)
public abstract void setColorBackground(String colorName)
public abstract void setShowAxes(boolean showAxes)
public abstract void setShowBbcage(boolean showBbcage)
public abstract void setJmolDefaults()
public abstract void setRasmolDefaults()
public abstract void setBooleanProperty(String propertyName, boolean value)
public abstract void setIntProperty(String propertyName, int value)
public abstract void setFloatProperty(String propertyName, float value)
public abstract void setStringProperty(String propertyName, String value)
public abstract void setModeMouse(int modeMouse)
public abstract void setShowHydrogens(boolean showHydrogens)
public abstract void setShowMeasurements(boolean showMeasurements)
public abstract void setPerspectiveDepth(boolean perspectiveDepth)
public abstract void setAutoBond(boolean autoBond)
public abstract void setMarBond(short marBond)
public abstract void setBondTolerance(float bondTolerance)
public abstract void setMinBondDistance(float minBondDistance)
public abstract void setAxesOrientationRasmol(boolean axesMessedUp)
public abstract void setPercentVdwAtom(int percentVdwAtom)
public abstract void setAnimationFps(int framesPerSecond)
public abstract void setFrankOn(boolean frankOn)
public abstract void setDebugScript(boolean debugScript)
public abstract void deleteMeasurement(int i)
public abstract void clearMeasurements()
public abstract void setVectorScale(float vectorScaleValue)
public abstract void setVibrationScale(float vibrationScaleValue)
public abstract void setVibrationPeriod(float vibrationPeriod)
public abstract void selectAll()
public abstract void clearSelection()
public abstract void setSelectionSet(BitSet newSelection)
public abstract void setSelectionHalos(boolean haloEnabled)
public abstract void setCenterSelected()
public abstract void rotateFront()
public abstract void rotateX(int degrees)
public abstract void rotateY(int degrees)
public abstract void rotateX(float radians)
public abstract void rotateY(float radians)
public abstract void rotateZ(float radians)
public abstract JmolAdapter getModelAdapter()
public abstract void openFileAsynchronously(String fileName)
public abstract Object getFileAsBytes(String fullPathName, OutputStream os)
public abstract String getErrorMessage()
public abstract String getErrorMessageUntranslated()
public abstract String getModelFileName(int modelIndex)
public abstract boolean checkPrivateKey(double privateKey)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |