HTMLGridPanel (OTS animation classes for the Web 1.02.02 API)

java.lang.Object
- nl.tudelft.simulation.dsol.web.animation.D2.HTMLGridPanel

All Implemented Interfaces:

ImageObserver

Direct Known Subclasses:

HTMLAnimationPanel
```
public class HTMLGridPanel
extends Object
implements ImageObserver
```
The GridPanel introduces the gridPanel.
Copyright (c) 2002-2019 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://simulation.tudelft.nl/dsol/3.0/license.html.

Author:

Niels Lang , Peter Jacobs

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DOWN` the DOWN directions for moving/zooming.
`protected Rectangle2D`	`extent` the extent of this panel.
`protected NumberFormat`	`formatter` the formatter to use.
`protected static Color`	`GRIDCOLOR` gridColor.
`protected double`	`gridSize` the gridSize in world Units.
`protected Rectangle2D`	`homeExtent` the extent of this panel.
`protected HTMLGraphics2D`	`htmlGraphics2D` the HTMLGraphics2D 'shadow' canvas.
`protected Dimension`	`lastDimension` the last computed Dimension.
`static int`	`LEFT` the LEFT directions for moving/zooming.
`protected Dimension`	`preferredSize` the last computed Dimension.
`static int`	`RIGHT` the RIGHT directions for moving/zooming.
`protected boolean`	`showGrid` show the grid.
`protected boolean`	`showToolTip` whether to show a tooltip with the coordinates or not.
`protected Dimension`	`size` the last computed Dimension.
`static int`	`UP` the UP directions for moving/zooming.
`protected Point2D`	`worldCoordinate` the last known world coordinate of the mouse.
`static double`	`ZOOMFACTOR` the ZOOM factor.

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description
`HTMLGridPanel(Rectangle2D extent)` constructs a new GridPanel.
`HTMLGridPanel(Rectangle2D extent, Dimension size)` constructs a new GridPanel.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`displayWorldCoordinateToolTip()` Display a tooltip with the last known world coordinates of the mouse, in case the tooltip should be displayed.
`protected void`	`drawGrid(Graphics g)` Added to make sure the recursive render-call calls THIS render method instead of a potential super-class defined 'paintComponent' render method.
`Color`	`getBackground()`
`String`	`getDrawingCommands()` Return the set of drawing commands.
`Rectangle2D`	`getExtent()` returns the extent of this panel.
`Font`	`getFont()`
`FontMetrics`	`getFontMetrics(Font font)`
`int`	`getHeight()`
`Dimension`	`getPreferredSize()`
`Dimension`	`getSize()`
`String`	`getToolTipText()`
`int`	`getWidth()`
`Point2D`	`getWorldCoordinate()`
`void`	`home()` resets the panel to its original extent.
`boolean`	`imageUpdate(Image img, int infoflags, int x, int y, int width, int height)`
`boolean`	`isDirty()`
`boolean`	`isShowGrid()`
`boolean`	`isShowing()`
`boolean`	`isShowToolTip()`
`void`	`paintComponent(HTMLGraphics2D g)` Draw the grid.
`void`	`pan(int direction, double percentage)` pans the panel in a specified direction.
`void`	`repaint()` Repaint the shadow canvas.
`void`	`setBackground(Color background)`
`void`	`setFont(Font font)`
`void`	`setPreferredSize(Dimension preferredSize)`
`void`	`setShowGrid(boolean showGrid)`
`void`	`setShowing(boolean showing)`
`void`	`setShowToolTip(boolean showToolTip)`
`void`	`setSize(Dimension size)`
`void`	`setToolTipText(String toolTipText)`
`void`	`setWorldCoordinate(Point2D point)` Set the world coordinates based on a mouse move.
`void`	`showGrid(boolean bool)` show the grid?
`void`	`zoom(double factor)` zooms in/out.
`void`	`zoom(double factor, int mouseX, int mouseY)` zooms in/out.

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

- Field Detail
  - UP
```
public static final int UP
```
    the UP directions for moving/zooming.
    
    See Also:
    
    Constant Field Values
  - DOWN
```
public static final int DOWN
```
    the DOWN directions for moving/zooming.
    
    See Also:
    
    Constant Field Values
  - LEFT
```
public static final int LEFT
```
    the LEFT directions for moving/zooming.
    
    See Also:
    
    Constant Field Values
  - RIGHT
```
public static final int RIGHT
```
    the RIGHT directions for moving/zooming.
    
    See Also:
    
    Constant Field Values
  - ZOOMFACTOR
```
public static final double ZOOMFACTOR
```
    the ZOOM factor.
    
    See Also:
    
    Constant Field Values
  - GRIDCOLOR
```
protected static final Color GRIDCOLOR
```
    gridColor.
  - extent
```
protected Rectangle2D extent
```
    the extent of this panel.
  - homeExtent
```
protected Rectangle2D homeExtent
```
    the extent of this panel.
  - showGrid
```
protected boolean showGrid
```
    show the grid.
  - gridSize
```
protected double gridSize
```
    the gridSize in world Units.
  - formatter
```
protected NumberFormat formatter
```
    the formatter to use.
  - lastDimension
```
protected Dimension lastDimension
```
    the last computed Dimension.
  - size
```
protected Dimension size
```
    the last computed Dimension.
  - preferredSize
```
protected Dimension preferredSize
```
    the last computed Dimension.
  - worldCoordinate
```
protected Point2D worldCoordinate
```
    the last known world coordinate of the mouse.
  - showToolTip
```
protected boolean showToolTip
```
    whether to show a tooltip with the coordinates or not.
  - htmlGraphics2D
```
protected HTMLGraphics2D htmlGraphics2D
```
    the HTMLGraphics2D 'shadow' canvas.
- Constructor Detail
  - HTMLGridPanel
```
public HTMLGridPanel(Rectangle2D extent)
```
    constructs a new GridPanel.
    
    Parameters:
    
    extent - Rectangle2D; the extent to show.
  - HTMLGridPanel
```
public HTMLGridPanel(Rectangle2D extent,
                     Dimension size)
```
    constructs a new GridPanel.
    
    Parameters:
    
    extent - Rectangle2D; the initial extent.
    
    size - Dimension; the size of the panel in pixels.
- Method Detail
  - getDrawingCommands
```
public String getDrawingCommands()
```
    Return the set of drawing commands.
    
    Returns:
    
    the set of drawing commands
  - paintComponent
```
public void paintComponent(HTMLGraphics2D g)
```
    Draw the grid.
    
    Parameters:
    
    g - HTMLGraphics2D; the virtual Graphics2D canvas to enable writing to the browser
  - showGrid
```
public final void showGrid(boolean bool)
```
    show the grid?
    
    Parameters:
    
    bool - boolean; true/false
  - getExtent
```
public final Rectangle2D getExtent()
```
    returns the extent of this panel.
    
    Returns:
    
    Rectangle2D
  - setWorldCoordinate
```
public final void setWorldCoordinate(Point2D point)
```
    Set the world coordinates based on a mouse move.
    
    Parameters:
    
    point - Point2D; the x,y world coordinates
  - getWorldCoordinate
```
public final Point2D getWorldCoordinate()
```
    Returns:
    
    worldCoordinate
  - displayWorldCoordinateToolTip
```
public final void displayWorldCoordinateToolTip()
```
    Display a tooltip with the last known world coordinates of the mouse, in case the tooltip should be displayed.
  - isShowToolTip
```
public final boolean isShowToolTip()
```
    Returns:
    
    showToolTip
  - setShowToolTip
```
public final void setShowToolTip(boolean showToolTip)
```
    Parameters:
    
    showToolTip - boolean; set showToolTip
  - pan
```
public final void pan(int direction,
                      double percentage)
```
    pans the panel in a specified direction.
    
    Parameters:
    
    direction - int; the direction
    
    percentage - double; the percentage
  - home
```
public final void home()
```
    resets the panel to its original extent.
  - isShowGrid
```
public final boolean isShowGrid()
```
    Returns:
    
    Returns the showGrid.
  - setShowGrid
```
public final void setShowGrid(boolean showGrid)
```
    Parameters:
    
    showGrid - boolean; The showGrid to set.
  - zoom
```
public final void zoom(double factor)
```
    zooms in/out.
    
    Parameters:
    
    factor - double; The zoom factor
  - zoom
```
public final void zoom(double factor,
                       int mouseX,
                       int mouseY)
```
    zooms in/out.
    
    Parameters:
    
    factor - double; The zoom factor
    
    mouseX - int; x-position of the mouse around which we zoom
    
    mouseY - int; y-position of the mouse around which we zoom
  - drawGrid
```
protected void drawGrid(Graphics g)
```
    Added to make sure the recursive render-call calls THIS render method instead of a potential super-class defined 'paintComponent' render method.
    
    Parameters:
    
    g - Graphics; the graphics object
  - repaint
```
public void repaint()
```
    Repaint the shadow canvas.
  - getSize
```
public final Dimension getSize()
```
    Returns:
    
    size
  - setSize
```
public final void setSize(Dimension size)
```
    Parameters:
    
    size - Dimension; set size
  - getBackground
```
public final Color getBackground()
```
    Returns:
    
    background
  - setBackground
```
public final void setBackground(Color background)
```
    Parameters:
    
    background - Color; set background
  - getWidth
```
public final int getWidth()
```
    Returns:
    
    width
  - getHeight
```
public final int getHeight()
```
    Returns:
    
    height
  - getPreferredSize
```
public final Dimension getPreferredSize()
```
    Returns:
    
    preferredSize
  - setPreferredSize
```
public final void setPreferredSize(Dimension preferredSize)
```
    Parameters:
    
    preferredSize - Dimension; set preferredSize
  - getToolTipText
```
public final String getToolTipText()
```
    Returns:
    
    toolTipText
  - setToolTipText
```
public final void setToolTipText(String toolTipText)
```
    Parameters:
    
    toolTipText - String; set toolTipText
  - isShowing
```
public final boolean isShowing()
```
    Returns:
    
    showing
  - setShowing
```
public final void setShowing(boolean showing)
```
    Parameters:
    
    showing - boolean; set showing
  - getFont
```
public final Font getFont()
```
    Returns:
    
    font
  - setFont
```
public final void setFont(Font font)
```
    Parameters:
    
    font - Font; set font
  - getFontMetrics
```
public final FontMetrics getFontMetrics(Font font)
```
    Parameters:
    
    font - Font; the font to calculate the fontmetrics for
    
    Returns:
    
    fontMetrics
  - isDirty
```
public final boolean isDirty()
```
    Returns:
    
    dirty
  - imageUpdate
```
public boolean imageUpdate(Image img,
                           int infoflags,
                           int x,
                           int y,
                           int width,
                           int height)
```
    Specified by:
    
    imageUpdate in interface ImageObserver

Class HTMLGridPanel

Field Summary

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UP

DOWN

LEFT

RIGHT

ZOOMFACTOR

GRIDCOLOR

extent

homeExtent

showGrid

gridSize

formatter

lastDimension

size

preferredSize

worldCoordinate

showToolTip

htmlGraphics2D

Constructor Detail

HTMLGridPanel

HTMLGridPanel

Method Detail

getDrawingCommands

paintComponent

showGrid

getExtent

setWorldCoordinate

getWorldCoordinate

displayWorldCoordinateToolTip

isShowToolTip

setShowToolTip

pan

home

isShowGrid

setShowGrid

zoom

zoom

drawGrid

repaint

getSize

setSize

getBackground

setBackground

getWidth

getHeight

getPreferredSize

setPreferredSize

getToolTipText

setToolTipText

isShowing

setShowing

getFont

setFont

getFontMetrics

isDirty

imageUpdate