Platform

java.lang.Object
- org.jmol.awtjs2d.Platform

All Implemented Interfaces:

javajs.api.FontManager, javajs.api.GenericPlatform

Direct Known Subclasses:

Platform
```
public class Platform
extends Object
implements javajs.api.GenericPlatform
```
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) Object canvas

(package private) Object context

(package private) javajs.api.PlatformViewer vwr
- Fields inherited from interface javajs.api.GenericPlatform
  CURSOR_CROSSHAIR, CURSOR_DEFAULT, CURSOR_HAND, CURSOR_MOVE, CURSOR_WAIT, CURSOR_ZOOM

Fields
Modifier and Type	Field and Description
`(package private) Object`	`canvas`
`(package private) Object`	`context`
`(package private) javajs.api.PlatformViewer`	`vwr`

Constructor Summary

Constructors
Constructor and Description

Platform()

Constructors
Constructor and Description
`Platform()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`allocateRgbImage(int windowWidth, int windowHeight, int[] pBuffer, int windowSize, boolean backgroundTransparent, boolean isImageWrite)` Create an "image" that is either a canvas with width/height/buf32 (from g3d.Platform32) or just an associative array with those (image writing
`void`	`convertPointFromScreen(Object canvas, javajs.util.P3 ptTemp)`
`Object`	`createImage(Object name_path_bytes)` can be ignored (return null) if platform cannot save images
`void`	`disposeGraphics(Object gOffscreen)`
`void`	`drawImage(Object context, Object canvas, int x, int y, int width, int height, boolean isDTI)`
`int[]`	`drawImageToBuffer(Object gOffscreen, Object imageOffscreen, Object canvas, int width, int height, int bgcolor)`
`void`	`flushImage(Object imagePixelBuffer)`
`int`	`fontStringWidth(javajs.awt.Font font, String text)`
`boolean`	`forceAsyncLoad(String filename)`
`Object`	`getBufferedFileInputStream(String name)`
`String`	`getDateFormat(String isoType)`
`int`	`getFontAscent(Object context)`
`int`	`getFontDescent(Object context)`
`Object`	`getFontMetrics(javajs.awt.Font font, Object context)`
`void`	`getFullScreenDimensions(Object canvas, int[] widthHeight)`
`Object`	`getGraphics(Object canvas)`
`javajs.api.GenericImageDialog`	`getImageDialog(String title, Map<String,javajs.api.GenericImageDialog> imageMap)`
`int`	`getImageHeight(Object canvas)`
`int`	`getImageWidth(Object canvas)`
`Object`	`getJsObjectInfo(Object[] jsObject, String method, Object[] args)`
`String`	`getLocalUrl(String fileName)`
`javajs.api.GenericMenuInterface`	`getMenuPopup(String menuStructure, char type)`
`javajs.api.GenericMouseInterface`	`getMouseManager(double privateKey, Object display)`
`Object`	`getStaticGraphics(Object image, boolean backgroundTransparent)`
`int[]`	`getTextPixels(String text, javajs.awt.Font font3d, Object context, Object image, int width, int height, int ascent)`
`Object`	`getURLContents(URL url, byte[] outputBytes, String post, boolean asString)`
`static Object`	`getURLContentsStatic(URL url, byte[] outputBytes, String post, boolean asString)` In case this needs to be performed directly, without interface
`int[]`	`grabPixels(Object canvas, int width, int height, int[] pixels, int startRow, int nRows)`
`boolean`	`hasFocus(Object canvas)`
`boolean`	`isHeadless()`
`boolean`	`isSingleThreaded()`
`static JmolToJSmolInterface`	`Jmol()`
`Object`	`newBufferedImage(Object image, int w, int h)`
`javajs.api.GenericFileInterface`	`newFile(String name)`
`Object`	`newFont(String fontFace, boolean isBold, boolean isItalic, float fontSize)`
`Object`	`newOffScreenImage(int w, int h)`
`void`	`notifyEndOfRendering()`
`String`	`prompt(String label, String data, String[] list, boolean asButtons)`
`void`	`renderScreenImage(Object context, Object size)` legacy apps will use this
`void`	`repaint(Object canvas)`
`void`	`requestFocusInWindow(Object canvas)`
`void`	`setCursor(int c, Object canvas)`
`void`	`setTransparentCursor(Object canvas)`
`void`	`setViewer(javajs.api.PlatformViewer vwr, Object canvas)`
`boolean`	`waitForDisplay(Object echoNameAndPath, 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
```
Object canvas
```

vwr
```
javajs.api.PlatformViewer vwr
```

context
```
Object context
```

Constructor Detail
- Platform
```
public Platform()
```

Method Detail

setViewer

public void setViewer(javajs.api.PlatformViewer vwr,
                      Object canvas)

Specified by:: setViewer in interface javajs.api.GenericPlatform

isSingleThreaded
```
public boolean isSingleThreaded()
```
Specified by:

isSingleThreaded in interface javajs.api.GenericPlatform

getJsObjectInfo

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

Specified by:: getJsObjectInfo in interface javajs.api.GenericPlatform

isHeadless
```
public boolean isHeadless()
```
Specified by:

isHeadless in interface javajs.api.GenericPlatform

getMouseManager

public javajs.api.GenericMouseInterface getMouseManager(double privateKey,
                                                        Object display)

Specified by:: getMouseManager in interface javajs.api.GenericPlatform

convertPointFromScreen

public void convertPointFromScreen(Object canvas,
                                   javajs.util.P3 ptTemp)

Specified by:: convertPointFromScreen in interface javajs.api.GenericPlatform

getFullScreenDimensions

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

Specified by:: getFullScreenDimensions in interface javajs.api.GenericPlatform

getMenuPopup

public javajs.api.GenericMenuInterface getMenuPopup(String menuStructure,
                                                    char type)

Specified by:: getMenuPopup in interface javajs.api.GenericPlatform

hasFocus
```
public boolean hasFocus(Object canvas)
```
Specified by:

hasFocus in interface javajs.api.GenericPlatform

prompt

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

Specified by:: prompt in interface javajs.api.GenericPlatform

renderScreenImage
```
public void renderScreenImage(Object context,
                              Object size)
```
legacy apps will use this

Specified by:

renderScreenImage in interface javajs.api.GenericPlatform

Parameters:

context -

size -

drawImage

public void drawImage(Object context,
                      Object canvas,
                      int x,
                      int y,
                      int width,
                      int height,
                      boolean isDTI)

Specified by:: drawImage in interface javajs.api.GenericPlatform

requestFocusInWindow
```
public void requestFocusInWindow(Object canvas)
```
Specified by:

requestFocusInWindow in interface javajs.api.GenericPlatform

repaint
```
public void repaint(Object canvas)
```
Specified by:

repaint in interface javajs.api.GenericPlatform

setTransparentCursor
```
public void setTransparentCursor(Object canvas)
```
Specified by:

setTransparentCursor in interface javajs.api.GenericPlatform

setCursor

public void setCursor(int c,
                      Object canvas)

Specified by:: setCursor in interface javajs.api.GenericPlatform

allocateRgbImage

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

Create an "image" that is either a canvas with width/height/buf32 (from g3d.Platform32) or just an associative array with those (image writing

Specified by:: allocateRgbImage in interface javajs.api.GenericPlatform

notifyEndOfRendering
```
public void notifyEndOfRendering()
```
Specified by:

notifyEndOfRendering in interface javajs.api.GenericPlatform

disposeGraphics
```
public void disposeGraphics(Object gOffscreen)
```
Specified by:

disposeGraphics in interface javajs.api.GenericPlatform

grabPixels

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

Specified by:: grabPixels in interface javajs.api.GenericPlatform
Returns:: pixels

drawImageToBuffer

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

Specified by:: drawImageToBuffer in interface javajs.api.GenericPlatform

getTextPixels

public int[] getTextPixels(String text,
                           javajs.awt.Font font3d,
                           Object context,
                           Object image,
                           int width,
                           int height,
                           int ascent)

Specified by:: getTextPixels in interface javajs.api.GenericPlatform

flushImage
```
public void flushImage(Object imagePixelBuffer)
```
Specified by:

flushImage in interface javajs.api.GenericPlatform

getGraphics
```
public Object getGraphics(Object canvas)
```
Specified by:

getGraphics in interface javajs.api.GenericPlatform

getImageHeight
```
public int getImageHeight(Object canvas)
```
Specified by:

getImageHeight in interface javajs.api.GenericPlatform

getImageWidth
```
public int getImageWidth(Object canvas)
```
Specified by:

getImageWidth in interface javajs.api.GenericPlatform

getStaticGraphics

public Object getStaticGraphics(Object image,
                                boolean backgroundTransparent)

Specified by:: getStaticGraphics in interface javajs.api.GenericPlatform

newBufferedImage

public Object newBufferedImage(Object image,
                               int w,
                               int h)

Specified by:: newBufferedImage in interface javajs.api.GenericPlatform

newOffScreenImage

public Object newOffScreenImage(int w,
                                int h)

Specified by:: newOffScreenImage in interface javajs.api.GenericPlatform

waitForDisplay
```
public boolean waitForDisplay(Object echoNameAndPath,
                              Object zipBytes)
                       throws InterruptedException
```
Description copied from interface: javajs.api.GenericPlatform

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

Specified by:

waitForDisplay in interface javajs.api.GenericPlatform

Returns:

false only if this platform cannot save images

Throws:

InterruptedException

createImage
```
public Object createImage(Object name_path_bytes)
```
Description copied from interface: javajs.api.GenericPlatform

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

Specified by:

createImage in interface javajs.api.GenericPlatform

Parameters:

name_path_bytes -

Returns:

image object or null if asynchronous

fontStringWidth

public int fontStringWidth(javajs.awt.Font font,
                           String text)

Specified by:: fontStringWidth in interface javajs.api.FontManager

getFontAscent
```
public int getFontAscent(Object context)
```
Specified by:

getFontAscent in interface javajs.api.FontManager

getFontDescent
```
public int getFontDescent(Object context)
```
Specified by:

getFontDescent in interface javajs.api.FontManager

getFontMetrics

public Object getFontMetrics(javajs.awt.Font font,
                             Object context)

Specified by:: getFontMetrics in interface javajs.api.FontManager

newFont

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

Specified by:: newFont in interface javajs.api.FontManager

getDateFormat
```
public String getDateFormat(String isoType)
```
Specified by:

getDateFormat in interface javajs.api.GenericPlatform

newFile
```
public javajs.api.GenericFileInterface newFile(String name)
```
Specified by:

newFile in interface javajs.api.GenericPlatform

getBufferedFileInputStream
```
public Object getBufferedFileInputStream(String name)
```
Specified by:

getBufferedFileInputStream in interface javajs.api.GenericPlatform

getURLContents

public Object getURLContents(URL url,
                             byte[] outputBytes,
                             String post,
                             boolean asString)

Specified by:: getURLContents in interface javajs.api.GenericPlatform
Returns:: may be javajs.util.SB or byte[] or java.io.InputStream

getURLContentsStatic

public static Object getURLContentsStatic(URL url,
                                          byte[] outputBytes,
                                          String post,
                                          boolean asString)

In case this needs to be performed directly, without interface

Parameters:: url -; outputBytes -; post -; asString -
Returns:: String or byte[] or javajs.util.SB

getLocalUrl
```
public String getLocalUrl(String fileName)
```
Specified by:

getLocalUrl in interface javajs.api.GenericPlatform

getImageDialog

public javajs.api.GenericImageDialog getImageDialog(String title,
                                                    Map<String,javajs.api.GenericImageDialog> imageMap)

Specified by:: getImageDialog in interface javajs.api.GenericPlatform

Jmol

public static JmolToJSmolInterface Jmol()

forceAsyncLoad
```
public boolean forceAsyncLoad(String filename)
```
Specified by:

forceAsyncLoad in interface javajs.api.GenericPlatform

Class Platform

Field Summary

Fields inherited from interface javajs.api.GenericPlatform

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

canvas

vwr

context

Constructor Detail

Platform

Method Detail

setViewer

isSingleThreaded

getJsObjectInfo

isHeadless

getMouseManager

convertPointFromScreen

getFullScreenDimensions

getMenuPopup

hasFocus

prompt

renderScreenImage

drawImage

requestFocusInWindow

repaint

setTransparentCursor

setCursor

allocateRgbImage

notifyEndOfRendering

disposeGraphics

grabPixels

drawImageToBuffer

getTextPixels

flushImage

getGraphics

getImageHeight

getImageWidth

getStaticGraphics

newBufferedImage

newOffScreenImage

waitForDisplay

createImage

fontStringWidth

getFontAscent

getFontDescent

getFontMetrics

newFont

getDateFormat

newFile

getBufferedFileInputStream

getURLContents

getURLContentsStatic

getLocalUrl

getImageDialog

Jmol

forceAsyncLoad