jspecview.js2d.JsPlatform

All Implemented Interfaces:: FontManager, GenericPlatform

public class JsPlatform extends Object implements 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 inherited from interface GenericPlatform
CURSOR_CROSSHAIR, CURSOR_DEFAULT, CURSOR_HAND, CURSOR_MOVE, CURSOR_WAIT, CURSOR_ZOOM
Constructor Summary

Constructors

Constructor

Description

JsPlatform()
Method Summary

Modifier and Type

Method

Description

Object

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

// core Image handling

int

confirm(String msg, String msgNo)

void

convertPointFromScreen(Object canvas, P3 ptTemp)

Object

createImage(Object data)

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

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(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(Font font, Object context)

void

getFullScreenDimensions(Object canvas, int[] widthHeight)

Object

getGraphics(Object canvas)

GenericImageDialog

getImageDialog(String title, Map<String, GenericImageDialog> imageMap)

int

getImageHeight(Object canvas)

int

getImageWidth(Object canvas)

Object

getInChI()

Object

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

String

getLocalUrl(String fileName)

GenericMenuInterface

getMenuPopup(String menuStructure, char type)

GenericMouseInterface

getMouseManager(double privateKey, Object jsvp)

/ Mouse

Object

getStaticGraphics(Object image, boolean backgroundTransparent)

int[]

getTextPixels(String text, Font font3d, Object context, Object image, int width, int height, int ascent)

Object

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

int[]

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

boolean

hasFocus(Object canvas)

boolean

isHeadless()

//// Display

boolean

isSingleThreaded()

Object

newBufferedImage(Object image, int w, int h)

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(PlatformViewer viewer, Object canvas)

boolean

waitForDisplay(Object echoNameAndPath, Object zipBytes)

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

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- JsPlatform
  
  public JsPlatform()
Method Details
- setViewer
  
  public void setViewer(PlatformViewer viewer, Object canvas)
  
  Specified by:
  
  setViewer in interface GenericPlatform
- isSingleThreaded
  
  public boolean isSingleThreaded()
  
  Specified by:
  
  isSingleThreaded in interface GenericPlatform
- getJsObjectInfo
  
  public Object getJsObjectInfo(Object[] jsObject, String method, Object[] args)
  
  Specified by:
  
  getJsObjectInfo in interface GenericPlatform
- isHeadless
  
  public boolean isHeadless()
  
  Description copied from interface: GenericPlatform
  
  //// Display
  
  Specified by:
  
  isHeadless in interface GenericPlatform
- getMouseManager
  
  public GenericMouseInterface getMouseManager(double privateKey, Object jsvp)
  
  Description copied from interface: GenericPlatform
  
  / Mouse
  
  Specified by:
  
  getMouseManager in interface GenericPlatform
- convertPointFromScreen
  
  public void convertPointFromScreen(Object canvas, P3 ptTemp)
  
  Specified by:
  
  convertPointFromScreen in interface GenericPlatform
- getFullScreenDimensions
  
  public void getFullScreenDimensions(Object canvas, int[] widthHeight)
  
  Specified by:
  
  getFullScreenDimensions in interface GenericPlatform
- getMenuPopup
  
  public GenericMenuInterface getMenuPopup(String menuStructure, char type)
  
  Specified by:
  
  getMenuPopup in interface GenericPlatform
- hasFocus
  
  public boolean hasFocus(Object canvas)
  
  Specified by:
  
  hasFocus in interface GenericPlatform
- prompt
  
  public String prompt(String label, String data, String[] list, boolean asButtons)
  
  Specified by:
  
  prompt in interface GenericPlatform
- renderScreenImage
  
  public void renderScreenImage(Object context, Object size)
  
  legacy apps will use this
  
  Specified by:
  
  renderScreenImage in interface 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 GenericPlatform
- requestFocusInWindow
  
  public void requestFocusInWindow(Object canvas)
  
  Specified by:
  
  requestFocusInWindow in interface GenericPlatform
- repaint
  
  public void repaint(Object canvas)
  
  Specified by:
  
  repaint in interface GenericPlatform
- setTransparentCursor
  
  public void setTransparentCursor(Object canvas)
  
  Specified by:
  
  setTransparentCursor in interface GenericPlatform
- setCursor
  
  public void setCursor(int c, Object canvas)
  
  Specified by:
  
  setCursor in interface GenericPlatform
- allocateRgbImage
  
  public Object allocateRgbImage(int windowWidth, int windowHeight, int[] pBuffer, int windowSize, boolean backgroundTransparent, boolean isImageWrite)
  
  Description copied from interface: GenericPlatform
  
  // core Image handling
  
  Specified by:
  
  allocateRgbImage in interface GenericPlatform
- notifyEndOfRendering
  
  public void notifyEndOfRendering()
  
  Specified by:
  
  notifyEndOfRendering in interface GenericPlatform
- createImage
  
  public Object createImage(Object data)
  
  could be byte[] (from ZIP file) or String (local file name) or URL
  
  Specified by:
  
  createImage in interface GenericPlatform
  
  Parameters:
  
  data -
  
  Returns:
  
  image object
- disposeGraphics
  
  public void disposeGraphics(Object gOffscreen)
  
  Specified by:
  
  disposeGraphics in interface GenericPlatform
- grabPixels
  
  public int[] grabPixels(Object canvas, int width, int height, int[] pixels)
  
  Specified by:
  
  grabPixels in interface GenericPlatform
  
  Parameters:
  
  canvas -
  
  width -
  
  height -
  
  pixels -
  
  Returns:
  
  pixels
- drawImageToBuffer
  
  public int[] drawImageToBuffer(Object gOffscreen, Object imageOffscreen, Object canvas, int width, int height, int bgcolor)
  
  Specified by:
  
  drawImageToBuffer in interface GenericPlatform
- getTextPixels
  
  public int[] getTextPixels(String text, Font font3d, Object context, Object image, int width, int height, int ascent)
  
  Specified by:
  
  getTextPixels in interface GenericPlatform
- flushImage
  
  public void flushImage(Object imagePixelBuffer)
  
  Specified by:
  
  flushImage in interface GenericPlatform
- getGraphics
  
  public Object getGraphics(Object canvas)
  
  Specified by:
  
  getGraphics in interface GenericPlatform
- getImageHeight
  
  public int getImageHeight(Object canvas)
  
  Specified by:
  
  getImageHeight in interface GenericPlatform
- getImageWidth
  
  public int getImageWidth(Object canvas)
  
  Specified by:
  
  getImageWidth in interface GenericPlatform
- getStaticGraphics
  
  public Object getStaticGraphics(Object image, boolean backgroundTransparent)
  
  Specified by:
  
  getStaticGraphics in interface GenericPlatform
- newBufferedImage
  
  public Object newBufferedImage(Object image, int w, int h)
  
  Specified by:
  
  newBufferedImage in interface GenericPlatform
- newOffScreenImage
  
  public Object newOffScreenImage(int w, int h)
  
  Specified by:
  
  newOffScreenImage in interface GenericPlatform
- waitForDisplay
  
  public boolean waitForDisplay(Object echoNameAndPath, Object zipBytes) throws InterruptedException
  
  Description copied from interface: GenericPlatform
  
  can be ignored (return false) if platform cannot save images
  
  Specified by:
  
  waitForDisplay in interface GenericPlatform
  
  Parameters:
  
  echoNameAndPath -
  
  zipBytes -
  
  Returns:
  
  false only if this platform cannot save images
  
  Throws:
  
  InterruptedException
- fontStringWidth
  
  public int fontStringWidth(Font font, String text)
  
  Specified by:
  
  fontStringWidth in interface FontManager
- getFontAscent
  
  public int getFontAscent(Object context)
  
  Specified by:
  
  getFontAscent in interface FontManager
- getFontDescent
  
  public int getFontDescent(Object context)
  
  Specified by:
  
  getFontDescent in interface FontManager
- getFontMetrics
  
  public Object getFontMetrics(Font font, Object context)
  
  Specified by:
  
  getFontMetrics in interface FontManager
- newFont
  
  public Object newFont(String fontFace, boolean isBold, boolean isItalic, float fontSize)
  
  Specified by:
  
  newFont in interface FontManager
- getDateFormat
  
  public String getDateFormat(String isoType)
  
  Specified by:
  
  getDateFormat in interface GenericPlatform
- newFile
  
  public GenericFileInterface newFile(String name)
  
  Specified by:
  
  newFile in interface GenericPlatform
- getBufferedFileInputStream
  
  public Object getBufferedFileInputStream(String name)
  
  Specified by:
  
  getBufferedFileInputStream in interface GenericPlatform
- getURLContents
  
  public Object getURLContents(URL url, byte[] outputBytes, String post, boolean asString)
  
  Specified by:
  
  getURLContents in interface GenericPlatform
  
  Parameters:
  
  url -
  
  outputBytes -
  
  post -
  
  asString -
  
  Returns:
  
  may be javajs.util.SB or byte[] or java.io.InputStream
- getLocalUrl
  
  public String getLocalUrl(String fileName)
  
  Specified by:
  
  getLocalUrl in interface GenericPlatform
- getImageDialog
  
  public GenericImageDialog getImageDialog(String title, Map<String, GenericImageDialog> imageMap)
  
  Specified by:
  
  getImageDialog in interface GenericPlatform
- forceAsyncLoad
  
  public boolean forceAsyncLoad(String filename)
  
  Specified by:
  
  forceAsyncLoad in interface GenericPlatform
- getInChI
  
  public Object getInChI()
  
  Specified by:
  
  getInChI in interface GenericPlatform
- confirm
  
  public int confirm(String msg, String msgNo)
  
  Specified by:
  
  confirm in interface GenericPlatform

Class JsPlatform

Field Summary

Fields inherited from interface GenericPlatform

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Details

JsPlatform

Method Details

setViewer

isSingleThreaded

getJsObjectInfo

isHeadless

getMouseManager

convertPointFromScreen

getFullScreenDimensions

getMenuPopup

hasFocus

prompt

renderScreenImage

drawImage

requestFocusInWindow

repaint

setTransparentCursor

setCursor

allocateRgbImage

notifyEndOfRendering

createImage

disposeGraphics

grabPixels

drawImageToBuffer

getTextPixels

flushImage

getGraphics

getImageHeight

getImageWidth

getStaticGraphics

newBufferedImage

newOffScreenImage

waitForDisplay

fontStringWidth

getFontAscent

getFontDescent

getFontMetrics

newFont

getDateFormat

newFile

getBufferedFileInputStream

getURLContents

getLocalUrl

getImageDialog

forceAsyncLoad

getInChI

confirm