org.jmol.awtjs2d

Class Platform

java.lang.Object

org.jmol.awtjs2d.Platform

All Implemented Interfaces:

ApiPlatform

Direct Known Subclasses:

Platform

public class Platform
extends java.lang.Object
implements ApiPlatform

JavaScript 2D canvas version requires Ajax-based URL stream processing. Jmol "display" --> HTML5 "canvas" Jmol "image" --> HTML5 "canvas" (because we need width and height) Jmol "graphics" --> HTML5 "context(2d)" (one for display, one off-screen for fonts) Jmol "font" --> JmolFont Jmol "fontMetrics" --> HTML5 "context(2d)" (Not fully implemented)

Author:

Bob Hanson

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.Object	canvas
(package private) java.lang.Object	context
private JmolFileAdapter	fileAdapter
(package private) JmolViewer	viewer

Constructor Summary

Constructors

Constructor and Description
Platform()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	allocateRgbImage(int windowWidth, int windowHeight, int[] pBuffer, int windowSize, boolean backgroundTransparent, boolean isImageWrite)
void	convertPointFromScreen(java.lang.Object canvas, P3 ptTemp)
java.lang.Object	createImage(java.lang.Object data) could be byte[] (from ZIP file) or String (local file name) or URL
void	disposeGraphics(java.lang.Object gOffscreen)
void	drawImage(java.lang.Object context, java.lang.Object canvas, int x, int y, int width, int height)
int[]	drawImageToBuffer(java.lang.Object gOffscreen, java.lang.Object imageOffscreen, java.lang.Object canvas, int width, int height, int bgcolor)
void	flushImage(java.lang.Object imagePixelBuffer)
int	fontStringWidth(JmolFont font, java.lang.Object context, java.lang.String text)
java.lang.String	getDateFormat()
JmolFileAdapterInterface	getFileAdapter()
int	getFontAscent(java.lang.Object context)
int	getFontDescent(java.lang.Object context)
java.lang.Object	getFontMetrics(JmolFont font, java.lang.Object context)
void	getFullScreenDimensions(java.lang.Object canvas, int[] widthHeight)
java.lang.Object	getGraphics(java.lang.Object image)
int	getImageHeight(java.lang.Object canvas)
int	getImageWidth(java.lang.Object canvas)
java.lang.Object	getJpgImage(Viewer viewer, int quality, java.lang.String comment) used for JPG writing only; can be ignored
java.lang.Object	getJsObjectInfo(java.lang.Object[] jsObject, java.lang.String method, java.lang.Object[] args)
JmolPopupInterface	getMenuPopup(Viewer viewer, java.lang.String menuStructure, char type)
JmolMouseInterface	getMouseManager(Viewer viewer, ActionManager actionManager)
java.lang.Object	getStaticGraphics(java.lang.Object image, boolean backgroundTransparent)
int[]	getTextPixels(java.lang.String text, JmolFont font3d, java.lang.Object context, java.lang.Object image, int width, int height, int ascent)
int[]	grabPixels(java.lang.Object canvas, int width, int height, int[] pixels, int startRow, int nRows)
boolean	hasFocus(java.lang.Object canvas)
boolean	isHeadless()
boolean	isSingleThreaded()
java.lang.Object	newBufferedImage(java.lang.Object image, int w, int h)
JmolFileInterface	newFile(java.lang.String name)
java.lang.Object	newFont(java.lang.String fontFace, boolean isBold, boolean isItalic, float fontSize)
java.lang.Object	newOffScreenImage(int w, int h)
void	notifyEndOfRendering()
java.lang.String	prompt(java.lang.String label, java.lang.String data, java.lang.String[] list, boolean asButtons)
void	renderScreenImage(JmolViewer viewer, java.lang.Object context, java.lang.Object size) legacy apps will use this
void	repaint(java.lang.Object canvas)
void	requestFocusInWindow(java.lang.Object canvas)
void	setCursor(int c, java.lang.Object canvas)
void	setTransparentCursor(java.lang.Object canvas)
void	setViewer(JmolViewer viewer, java.lang.Object canvas)
boolean	waitForDisplay(java.lang.Object echoNameAndPath, java.lang.Object zipBytes) can be ignored (return false) if platform cannot save images

Methods inherited from class java.lang.Object

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

Field Detail

canvas

java.lang.Object canvas

viewer

JmolViewer viewer

context

java.lang.Object context

fileAdapter

private JmolFileAdapter fileAdapter

Constructor Detail

Platform

public Platform()

Method Detail

setViewer

public void setViewer(JmolViewer viewer,
             java.lang.Object canvas)

Specified by:

setViewer in interface ApiPlatform

isSingleThreaded

public boolean isSingleThreaded()

Specified by:

isSingleThreaded in interface ApiPlatform

getJsObjectInfo

public java.lang.Object getJsObjectInfo(java.lang.Object[] jsObject,
                               java.lang.String method,
                               java.lang.Object[] args)

Specified by:

getJsObjectInfo in interface ApiPlatform

isHeadless

public boolean isHeadless()

Specified by:

isHeadless in interface ApiPlatform

getFileAdapter

public JmolFileAdapterInterface getFileAdapter()

Specified by:

getFileAdapter in interface ApiPlatform

newFile

public JmolFileInterface newFile(java.lang.String name)

Specified by:

newFile in interface ApiPlatform

getMouseManager

public JmolMouseInterface getMouseManager(Viewer viewer,
                                 ActionManager actionManager)

Specified by:

getMouseManager in interface ApiPlatform

convertPointFromScreen

public void convertPointFromScreen(java.lang.Object canvas,
                          P3 ptTemp)

Specified by:

convertPointFromScreen in interface ApiPlatform

getFullScreenDimensions

public void getFullScreenDimensions(java.lang.Object canvas,
                           int[] widthHeight)

Specified by:

getFullScreenDimensions in interface ApiPlatform

getMenuPopup

public JmolPopupInterface getMenuPopup(Viewer viewer,
                              java.lang.String menuStructure,
                              char type)

Specified by:

getMenuPopup in interface ApiPlatform

hasFocus

public boolean hasFocus(java.lang.Object canvas)

Specified by:

hasFocus in interface ApiPlatform

prompt

public java.lang.String prompt(java.lang.String label,
                      java.lang.String data,
                      java.lang.String[] list,
                      boolean asButtons)

Specified by:

prompt in interface ApiPlatform

renderScreenImage

public void renderScreenImage(JmolViewer viewer,
                     java.lang.Object context,
                     java.lang.Object size)

legacy apps will use this

Specified by:

renderScreenImage in interface ApiPlatform

Parameters:

viewer -

context -

size -

drawImage

public void drawImage(java.lang.Object context,
             java.lang.Object canvas,
             int x,
             int y,
             int width,
             int height)

Specified by:

drawImage in interface ApiPlatform

requestFocusInWindow

public void requestFocusInWindow(java.lang.Object canvas)

Specified by:

requestFocusInWindow in interface ApiPlatform

repaint

public void repaint(java.lang.Object canvas)

Specified by:

repaint in interface ApiPlatform

setTransparentCursor

public void setTransparentCursor(java.lang.Object canvas)

Specified by:

setTransparentCursor in interface ApiPlatform

setCursor

public void setCursor(int c,
             java.lang.Object canvas)

Specified by:

setCursor in interface ApiPlatform

allocateRgbImage

public java.lang.Object allocateRgbImage(int windowWidth,
                                int windowHeight,
                                int[] pBuffer,
                                int windowSize,
                                boolean backgroundTransparent,
                                boolean isImageWrite)

Specified by:

allocateRgbImage in interface ApiPlatform

notifyEndOfRendering

public void notifyEndOfRendering()

Specified by:

notifyEndOfRendering in interface ApiPlatform

createImage

public java.lang.Object createImage(java.lang.Object data)

could be byte[] (from ZIP file) or String (local file name) or URL

Specified by:

createImage in interface ApiPlatform

Parameters:

data -

Returns:

image object

disposeGraphics

public void disposeGraphics(java.lang.Object gOffscreen)

Specified by:

disposeGraphics in interface ApiPlatform

grabPixels

public int[] grabPixels(java.lang.Object canvas,
               int width,
               int height,
               int[] pixels,
               int startRow,
               int nRows)

Specified by:

grabPixels in interface ApiPlatform

Returns:

pixels

drawImageToBuffer

public int[] drawImageToBuffer(java.lang.Object gOffscreen,
                      java.lang.Object imageOffscreen,
                      java.lang.Object canvas,
                      int width,
                      int height,
                      int bgcolor)

Specified by:

drawImageToBuffer in interface ApiPlatform

getTextPixels

public int[] getTextPixels(java.lang.String text,
                  JmolFont font3d,
                  java.lang.Object context,
                  java.lang.Object image,
                  int width,
                  int height,
                  int ascent)

Specified by:

getTextPixels in interface ApiPlatform

flushImage

public void flushImage(java.lang.Object imagePixelBuffer)

Specified by:

flushImage in interface ApiPlatform

getGraphics

public java.lang.Object getGraphics(java.lang.Object image)

Specified by:

getGraphics in interface ApiPlatform

getImageHeight

public int getImageHeight(java.lang.Object canvas)

Specified by:

getImageHeight in interface ApiPlatform

getImageWidth

public int getImageWidth(java.lang.Object canvas)

Specified by:

getImageWidth in interface ApiPlatform

getJpgImage

public java.lang.Object getJpgImage(Viewer viewer,
                           int quality,
                           java.lang.String comment)

Description copied from interface: ApiPlatform

used for JPG writing only; can be ignored

Specified by:

getJpgImage in interface ApiPlatform

Returns:

null only if this platform cannot save images

getStaticGraphics

public java.lang.Object getStaticGraphics(java.lang.Object image,
                                 boolean backgroundTransparent)

Specified by:

getStaticGraphics in interface ApiPlatform

newBufferedImage

public java.lang.Object newBufferedImage(java.lang.Object image,
                                int w,
                                int h)

Specified by:

newBufferedImage in interface ApiPlatform

newOffScreenImage

public java.lang.Object newOffScreenImage(int w,
                                 int h)

Specified by:

newOffScreenImage in interface ApiPlatform

waitForDisplay

public boolean waitForDisplay(java.lang.Object echoNameAndPath,
                     java.lang.Object zipBytes)
                       throws java.lang.InterruptedException

Description copied from interface: ApiPlatform

can be ignored (return false) if platform cannot save images

Specified by:

waitForDisplay in interface ApiPlatform

Returns:

false only if this platform cannot save images

Throws:

java.lang.InterruptedException

fontStringWidth

public int fontStringWidth(JmolFont font,
                  java.lang.Object context,
                  java.lang.String text)

Specified by:

fontStringWidth in interface ApiPlatform

getFontAscent

public int getFontAscent(java.lang.Object context)

Specified by:

getFontAscent in interface ApiPlatform

getFontDescent

public int getFontDescent(java.lang.Object context)

Specified by:

getFontDescent in interface ApiPlatform

getFontMetrics

public java.lang.Object getFontMetrics(JmolFont font,
                              java.lang.Object context)

Specified by:

getFontMetrics in interface ApiPlatform

newFont

public java.lang.Object newFont(java.lang.String fontFace,
                       boolean isBold,
                       boolean isItalic,
                       float fontSize)

Specified by:

newFont in interface ApiPlatform

getDateFormat

public java.lang.String getDateFormat()

Specified by:

getDateFormat in interface ApiPlatform