org.jmol.api
Class JmolViewer

java.lang.Object
  extended by org.jmol.api.JmolSimpleViewer
      extended by org.jmol.api.JmolViewer
Direct Known Subclasses:
Viewer

public abstract class JmolViewer
extends JmolSimpleViewer

This is the high-level API for the JmolViewer for simple access.

We will implement a low-level API at some point


Constructor Summary
JmolViewer()
           
 
Method Summary
abstract  void addSelectionListener(JmolSelectionListener listener)
           
static JmolViewer allocateViewer(java.awt.Component awtComponent, JmolAdapter jmolAdapter)
           
abstract  void clearMeasurements()
           
abstract  void clearSelection()
           
abstract  void deleteMeasurement(int i)
           
abstract  java.lang.String evalStringQuiet(java.lang.String script)
           
abstract  int getAnimationFps()
           
abstract  java.awt.Color getAtomColor(int atomIndex)
           
abstract  int getAtomCount()
           
abstract  int getAtomModelIndex(int atomIndex)
           
abstract  java.lang.String getAtomName(int atomIndex)
           
abstract  int getAtomNumber(int atomIndex)
           
abstract  javax.vecmath.Point3f getAtomPoint3f(int atomIndex)
           
abstract  float getAtomRadius(int atomIndex)
           
abstract  boolean getAutoBond()
           
abstract  java.awt.Component getAwtComponent()
           
abstract  boolean getAxesOrientationRasmol()
           
abstract  java.awt.Color getBondColor1(int bondIndex)
           
abstract  java.awt.Color getBondColor2(int bondIndex)
           
abstract  int getBondCount()
           
abstract  int getBondModelIndex(int bondIndex)
           
abstract  short getBondOrder(int bondIndex)
           
abstract  javax.vecmath.Point3f getBondPoint3f1(int bondIndex)
           
abstract  javax.vecmath.Point3f getBondPoint3f2(int bondIndex)
           
abstract  float getBondRadius(int bondIndex)
           
abstract  float getBondTolerance()
           
abstract  boolean getBooleanProperty(java.lang.String propertyName)
           
abstract  int getChainCount()
           
abstract  java.awt.Color getColorBackground()
           
abstract  java.awt.Color getColorBond()
           
abstract  java.awt.Color getColorLabel()
           
abstract  java.awt.Color getColorMeasurement()
           
abstract  java.awt.Color getColorVector()
           
abstract  int getDisplayModelIndex()
           
abstract  java.util.BitSet getElementsPresentBitSet()
           
abstract  FrameRenderer getFrameRenderer()
           
abstract  int getGroupCount()
           
abstract  java.util.BitSet getGroupsPresentBitSet()
           
abstract  java.lang.String getJavaVendor()
           
abstract  java.lang.String getJavaVersion()
           
abstract  JPreview getJPreview()
           
abstract  int getLipidNumber()
           
abstract  short getMadBond()
           
abstract  int getMeasurementCount()
           
abstract  int[] getMeasurementCountPlusIndices(int i)
           
abstract  java.lang.String getMeasurementStringValue(int i)
           
abstract  float getMinBondDistance()
           
abstract  int getModelCount()
           
abstract  java.lang.String getModelName(int atomSetIndex)
           
abstract  int getModelNumber(int atomSetIndex)
           
abstract  java.util.Properties getModelProperties(int atomSetIndex)
           
abstract  java.lang.String getModelProperty(int atomSetIndex, java.lang.String propertyName)
           
abstract  java.lang.String getModelSetFileName()
           
abstract  java.lang.String getModelSetName()
           
abstract  java.lang.String getModelSetPathName()
           
abstract  java.util.Properties getModelSetProperties()
           
abstract  int getMotionEventNumber()
           
abstract  java.lang.String getOperatingSystemName()
           
abstract  int getPercentVdwAtom()
           
abstract  boolean getPerspectiveDepth()
           
abstract  int getPolymerCount()
           
abstract  int getPolymerCountInModel(int modelIndex)
           
abstract  javax.vecmath.Point3f[] getPolymerLeadMidPoints(int modelIndex, int polymerIndex)
           
abstract  void getRotation(javax.vecmath.Matrix3f matrixRotation)
           
abstract  float getRotationRadius()
           
abstract  float getScalePixelsPerAngstrom()
           
abstract  int getScreenHeight()
           
abstract  java.awt.Image getScreenImage()
           
abstract  int getScreenWidth()
           
abstract  java.util.BitSet getSelectionSet()
           
abstract  boolean getShapeShow(int shapeID)
           
abstract  boolean getShowAxes()
           
abstract  boolean getShowBbcage()
           
abstract  boolean getShowHydrogens()
           
abstract  boolean getShowMeasurements()
           
abstract  javax.vecmath.Matrix4f getUnscaledTransformMatrix()
           
abstract  boolean getWireframeRotation()
           
abstract  float getXTranslationNormalized()
           
abstract  float getYTranslation()
           
abstract  float getYTranslationNormalized()
           
abstract  int getZoomPercent()
           
abstract  void haltScriptExecution()
           
abstract  boolean handleOldJvm10Event(java.awt.Event e)
           
abstract  boolean haveFrame()
           
abstract  void homePosition()
           
abstract  boolean isJvm12orGreater()
           
abstract  boolean isScriptExecuting()
           
abstract  boolean isShowTransparentLipids()
           
abstract  boolean modelHasVibrationVectors(int atomSetIndex)
           
abstract  void notifyRepainted()
           
abstract  void openClientFile(java.lang.String fullPathName, java.lang.String fileName, java.lang.Object clientFile)
           
abstract  void openReader(java.lang.String fullPathName, java.lang.String name, java.io.Reader reader)
           
abstract  void popHoldRepaint()
           
abstract  void pushHoldRepaint()
           
abstract  void rebond()
           
abstract  void refresh()
           
abstract  void releaseScreenImage()
           
abstract  void removeSelectionListener(JmolSelectionListener listener)
           
abstract  void rotateFront()
           
abstract  void rotateToX(float radians)
           
abstract  void rotateToX(int degrees)
           
abstract  void rotateToY(float radians)
           
abstract  void rotateToY(int degrees)
           
abstract  void rotateToZ(float radians)
           
abstract  void scaleFitToScreen()
           
abstract  void selectAll()
           
abstract  void setAnimationFps(int framesPerSecond)
           
abstract  void setAppletContext(java.net.URL documentBase, java.net.URL codeBase, java.lang.String appletProxy)
           
abstract  void setAutoBond(boolean autoBond)
           
abstract  void setAxesOrientationRasmol(boolean axesMessedUp)
           
abstract  void setBondTolerance(float bondTolerance)
           
abstract  void setBooleanProperty(java.lang.String propertyName, boolean value)
           
abstract  void setCenterSelected()
           
abstract  void setColorBackground(java.awt.Color colorBackground)
           
abstract  void setColorBackground(java.lang.String colorName)
           
abstract  void setColorBond(java.awt.Color colorBond)
           
abstract  void setColorLabel(java.awt.Color colorBond)
           
abstract  void setColorMeasurement(java.awt.Color colorMeasurement)
           
abstract  void setColorSelection(java.awt.Color colorSelection)
           
abstract  void setColorVector(java.awt.Color colorVector)
           
abstract  void setDebugScript(boolean debugScript)
           
abstract  void setFrankOn(boolean frankOn)
           
abstract  void setJmolDefaults()
           
abstract  void setJmolStatusListener(JmolStatusListener jmolStatusListener)
           
abstract  void setJPreview(JPreview preview)
           
abstract  void setLipidNumber(int lipidNumber)
           
abstract  void setMarBond(short marBond)
           
abstract  void setMinBondDistance(float minBondDistance)
           
abstract  void setModeAtomColorProfile(java.lang.String mode)
           
abstract  void setModeMouse(int modeMouse)
           
abstract  void setPercentVdwAtom(int percentVdwAtom)
           
abstract  void setPerspectiveDepth(boolean perspectiveDepth)
           
abstract  void setRasmolDefaults()
           
abstract  void setRotation(javax.vecmath.Matrix3f matrixRotation)
           
abstract  void setScalePixelsPerAngstrom(float pixelsScale)
           
abstract  void setScreenDimension(java.awt.Dimension dim)
           
abstract  void setSelectionHaloEnabled(boolean haloEnabled)
           
abstract  void setSelectionSet(java.util.BitSet newSelection)
           
abstract  void setShapeShow(int shapeID, boolean show)
           
abstract  void setShowAxes(boolean showAxes)
           
abstract  void setShowBbcage(boolean showBbcage)
           
abstract  void setShowHydrogens(boolean showHydrogens)
           
abstract  void setShowMeasurements(boolean showMeasurements)
           
abstract  void setShowTransparentLipids(boolean showTransparentLipids)
           
abstract  void setVectorScale(float vectorScaleValue)
           
abstract  void setVibrationPeriod(float vibrationPeriod)
           
abstract  void setVibrationScale(float vibrationScaleValue)
           
abstract  void setWireframeRotation(boolean wireframeRotation)
           
abstract  void setXTranslationNormalized(float xTranslation)
           
abstract  void setYTranslationNormalized(float yTranslation)
           
abstract  boolean showModelSetDownload()
           
abstract  void showUrl(java.lang.String urlString)
           
abstract  void translateXBy(int xDelta)
           
abstract  void translateYBy(int yDelta)
           
abstract  void zoomBy(int pixels)
           
 
Methods inherited from class org.jmol.api.JmolSimpleViewer
allocateSimpleViewer, evalFile, evalString, getOpenFileError, openDOM, openFile, openStringInline, renderScreenImage
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JmolViewer

public JmolViewer()
Method Detail

allocateViewer

public static JmolViewer allocateViewer(java.awt.Component awtComponent,
                                        JmolAdapter jmolAdapter)

setJmolStatusListener

public abstract void setJmolStatusListener(JmolStatusListener jmolStatusListener)

setAppletContext

public abstract void setAppletContext(java.net.URL documentBase,
                                      java.net.URL codeBase,
                                      java.lang.String appletProxy)

haltScriptExecution

public abstract void haltScriptExecution()

isJvm12orGreater

public abstract boolean isJvm12orGreater()

getOperatingSystemName

public abstract java.lang.String getOperatingSystemName()

getJavaVersion

public abstract java.lang.String getJavaVersion()

getJavaVendor

public abstract java.lang.String getJavaVendor()

haveFrame

public abstract boolean haveFrame()

pushHoldRepaint

public abstract void pushHoldRepaint()

popHoldRepaint

public abstract void popHoldRepaint()

setJmolDefaults

public abstract void setJmolDefaults()

setRasmolDefaults

public abstract void setRasmolDefaults()

setDebugScript

public abstract void setDebugScript(boolean debugScript)

setFrankOn

public abstract void setFrankOn(boolean frankOn)

setScreenDimension

public abstract void setScreenDimension(java.awt.Dimension dim)

getScreenWidth

public abstract int getScreenWidth()

getScreenHeight

public abstract int getScreenHeight()

getScreenImage

public abstract java.awt.Image getScreenImage()

releaseScreenImage

public abstract void releaseScreenImage()

notifyRepainted

public abstract void notifyRepainted()

handleOldJvm10Event

public abstract boolean handleOldJvm10Event(java.awt.Event e)

getMotionEventNumber

public abstract int getMotionEventNumber()

openReader

public abstract void openReader(java.lang.String fullPathName,
                                java.lang.String name,
                                java.io.Reader reader)

openClientFile

public abstract void openClientFile(java.lang.String fullPathName,
                                    java.lang.String fileName,
                                    java.lang.Object clientFile)

showUrl

public abstract void showUrl(java.lang.String urlString)

deleteMeasurement

public abstract void deleteMeasurement(int i)

clearMeasurements

public abstract void clearMeasurements()

getMeasurementCount

public abstract int getMeasurementCount()

getMeasurementStringValue

public abstract java.lang.String getMeasurementStringValue(int i)

getMeasurementCountPlusIndices

public abstract int[] getMeasurementCountPlusIndices(int i)

getAwtComponent

public abstract java.awt.Component getAwtComponent()

getElementsPresentBitSet

public abstract java.util.BitSet getElementsPresentBitSet()

getAnimationFps

public abstract int getAnimationFps()

setAnimationFps

public abstract void setAnimationFps(int framesPerSecond)

evalStringQuiet

public abstract java.lang.String evalStringQuiet(java.lang.String script)

isScriptExecuting

public abstract boolean isScriptExecuting()

setVectorScale

public abstract void setVectorScale(float vectorScaleValue)

setVibrationScale

public abstract void setVibrationScale(float vibrationScaleValue)

setVibrationPeriod

public abstract void setVibrationPeriod(float vibrationPeriod)

getModelSetName

public abstract java.lang.String getModelSetName()

getModelSetFileName

public abstract java.lang.String getModelSetFileName()

getModelSetPathName

public abstract java.lang.String getModelSetPathName()

getModelSetProperties

public abstract java.util.Properties getModelSetProperties()

getModelNumber

public abstract int getModelNumber(int atomSetIndex)

getModelName

public abstract java.lang.String getModelName(int atomSetIndex)

getModelProperties

public abstract java.util.Properties getModelProperties(int atomSetIndex)

getModelProperty

public abstract java.lang.String getModelProperty(int atomSetIndex,
                                                  java.lang.String propertyName)

modelHasVibrationVectors

public abstract boolean modelHasVibrationVectors(int atomSetIndex)

getModelCount

public abstract int getModelCount()

getDisplayModelIndex

public abstract int getDisplayModelIndex()

getAtomCount

public abstract int getAtomCount()

getBondCount

public abstract int getBondCount()

getGroupCount

public abstract int getGroupCount()

getChainCount

public abstract int getChainCount()

getPolymerCount

public abstract int getPolymerCount()

getPolymerCountInModel

public abstract int getPolymerCountInModel(int modelIndex)

setModeMouse

public abstract void setModeMouse(int modeMouse)

setSelectionHaloEnabled

public abstract void setSelectionHaloEnabled(boolean haloEnabled)

setShowHydrogens

public abstract void setShowHydrogens(boolean showHydrogens)

setShowMeasurements

public abstract void setShowMeasurements(boolean showMeasurements)

selectAll

public abstract void selectAll()

clearSelection

public abstract void clearSelection()

addSelectionListener

public abstract void addSelectionListener(JmolSelectionListener listener)

removeSelectionListener

public abstract void removeSelectionListener(JmolSelectionListener listener)

setSelectionSet

public abstract void setSelectionSet(java.util.BitSet newSelection)

getSelectionSet

public abstract java.util.BitSet getSelectionSet()

setModeAtomColorProfile

public abstract void setModeAtomColorProfile(java.lang.String mode)

homePosition

public abstract void homePosition()

rotateFront

public abstract void rotateFront()

rotateToX

public abstract void rotateToX(int degrees)

rotateToY

public abstract void rotateToY(int degrees)

rotateToX

public abstract void rotateToX(float radians)

rotateToY

public abstract void rotateToY(float radians)

rotateToZ

public abstract void rotateToZ(float radians)

setCenterSelected

public abstract void setCenterSelected()

getGroupsPresentBitSet

public abstract java.util.BitSet getGroupsPresentBitSet()

setWireframeRotation

public abstract void setWireframeRotation(boolean wireframeRotation)

setPerspectiveDepth

public abstract void setPerspectiveDepth(boolean perspectiveDepth)

getPerspectiveDepth

public abstract boolean getPerspectiveDepth()

getWireframeRotation

public abstract boolean getWireframeRotation()

getShowHydrogens

public abstract boolean getShowHydrogens()

getShowMeasurements

public abstract boolean getShowMeasurements()

setShowAxes

public abstract void setShowAxes(boolean showAxes)

getShowAxes

public abstract boolean getShowAxes()

setShowBbcage

public abstract void setShowBbcage(boolean showBbcage)

getShowBbcage

public abstract boolean getShowBbcage()

getAtomNumber

public abstract int getAtomNumber(int atomIndex)

getAtomName

public abstract java.lang.String getAtomName(int atomIndex)

getRotationRadius

public abstract float getRotationRadius()

getZoomPercent

public abstract int getZoomPercent()

getUnscaledTransformMatrix

public abstract javax.vecmath.Matrix4f getUnscaledTransformMatrix()

getColorBackground

public abstract java.awt.Color getColorBackground()

setColorBackground

public abstract void setColorBackground(java.awt.Color colorBackground)

setColorBackground

public abstract void setColorBackground(java.lang.String colorName)

getAtomRadius

public abstract float getAtomRadius(int atomIndex)

getAtomPoint3f

public abstract javax.vecmath.Point3f getAtomPoint3f(int atomIndex)

getAtomColor

public abstract java.awt.Color getAtomColor(int atomIndex)

getAtomModelIndex

public abstract int getAtomModelIndex(int atomIndex)

getBondRadius

public abstract float getBondRadius(int bondIndex)

getBondPoint3f1

public abstract javax.vecmath.Point3f getBondPoint3f1(int bondIndex)

getBondPoint3f2

public abstract javax.vecmath.Point3f getBondPoint3f2(int bondIndex)

getBondColor1

public abstract java.awt.Color getBondColor1(int bondIndex)

getBondColor2

public abstract java.awt.Color getBondColor2(int bondIndex)

getBondOrder

public abstract short getBondOrder(int bondIndex)

getBondModelIndex

public abstract int getBondModelIndex(int bondIndex)

getPolymerLeadMidPoints

public abstract javax.vecmath.Point3f[] getPolymerLeadMidPoints(int modelIndex,
                                                                int polymerIndex)

getAxesOrientationRasmol

public abstract boolean getAxesOrientationRasmol()

setAxesOrientationRasmol

public abstract void setAxesOrientationRasmol(boolean axesMessedUp)

getPercentVdwAtom

public abstract int getPercentVdwAtom()

setPercentVdwAtom

public abstract void setPercentVdwAtom(int percentVdwAtom)

getAutoBond

public abstract boolean getAutoBond()

setAutoBond

public abstract void setAutoBond(boolean autoBond)

getMadBond

public abstract short getMadBond()

setMarBond

public abstract void setMarBond(short marBond)

getBondTolerance

public abstract float getBondTolerance()

setBondTolerance

public abstract void setBondTolerance(float bondTolerance)

rebond

public abstract void rebond()

getMinBondDistance

public abstract float getMinBondDistance()

setMinBondDistance

public abstract void setMinBondDistance(float minBondDistance)

setColorSelection

public abstract void setColorSelection(java.awt.Color colorSelection)

getColorLabel

public abstract java.awt.Color getColorLabel()

setColorLabel

public abstract void setColorLabel(java.awt.Color colorBond)

getColorBond

public abstract java.awt.Color getColorBond()

setColorBond

public abstract void setColorBond(java.awt.Color colorBond)

getColorVector

public abstract java.awt.Color getColorVector()

setColorVector

public abstract void setColorVector(java.awt.Color colorVector)

getColorMeasurement

public abstract java.awt.Color getColorMeasurement()

setColorMeasurement

public abstract void setColorMeasurement(java.awt.Color colorMeasurement)

refresh

public abstract void refresh()

getBooleanProperty

public abstract boolean getBooleanProperty(java.lang.String propertyName)

setBooleanProperty

public abstract void setBooleanProperty(java.lang.String propertyName,
                                        boolean value)

showModelSetDownload

public abstract boolean showModelSetDownload()

translateXBy

public abstract void translateXBy(int xDelta)

translateYBy

public abstract void translateYBy(int yDelta)

zoomBy

public abstract void zoomBy(int pixels)

getFrameRenderer

public abstract FrameRenderer getFrameRenderer()

getScalePixelsPerAngstrom

public abstract float getScalePixelsPerAngstrom()

setScalePixelsPerAngstrom

public abstract void setScalePixelsPerAngstrom(float pixelsScale)

getRotation

public abstract void getRotation(javax.vecmath.Matrix3f matrixRotation)

setRotation

public abstract void setRotation(javax.vecmath.Matrix3f matrixRotation)

getYTranslation

public abstract float getYTranslation()

getXTranslationNormalized

public abstract float getXTranslationNormalized()

getYTranslationNormalized

public abstract float getYTranslationNormalized()

setXTranslationNormalized

public abstract void setXTranslationNormalized(float xTranslation)

setYTranslationNormalized

public abstract void setYTranslationNormalized(float yTranslation)

isShowTransparentLipids

public abstract boolean isShowTransparentLipids()

setShowTransparentLipids

public abstract void setShowTransparentLipids(boolean showTransparentLipids)

getJPreview

public abstract JPreview getJPreview()

setJPreview

public abstract void setJPreview(JPreview preview)

scaleFitToScreen

public abstract void scaleFitToScreen()

setShapeShow

public abstract void setShapeShow(int shapeID,
                                  boolean show)

getShapeShow

public abstract boolean getShapeShow(int shapeID)

setLipidNumber

public abstract void setLipidNumber(int lipidNumber)

getLipidNumber

public abstract int getLipidNumber()