Class HTMLGridPanel
- 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) 2003-2022 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. BSD-style license. See OpenTrafficSim License.
- Author:
 - Niels Lang , Peter Jacobs
 
 
- 
- 
Field Summary
Fields Modifier and Type Field Description static intDOWNthe DOWN directions for moving/zooming.protected Bounds2dextentthe extent of this panel.protected NumberFormatformatterthe formatter to use.protected static ColorGRIDCOLORgridColor.protected doublegridSizeXthe gridSize for the X-direction in world Units.protected doublegridSizeYthe gridSize for the Y-direction in world Units.protected Bounds2dhomeExtentthe extent of this panel.protected HTMLGraphics2DhtmlGraphics2Dthe HTMLGraphics2D 'shadow' canvas.protected DimensionlastDimensionthe last computed Dimension.static intLEFTthe LEFT directions for moving/zooming.protected DimensionpreferredSizethe last computed Dimension.protected RenderableScalerenderableScalethe renderable scale (X/Y ratio) to use.static intRIGHTthe RIGHT directions for moving/zooming.protected booleanshowGridshow the grid.protected booleanshowToolTipwhether to show a tooltip with the coordinates or not.protected Dimensionsizethe last computed Dimension.static intUPthe UP directions for moving/zooming.protected Point2dworldCoordinatethe last known world coordinate of the mouse.static doubleZOOMFACTORthe ZOOM factor.- 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH 
 - 
 
- 
Constructor Summary
Constructors Constructor Description HTMLGridPanel(Bounds2d extent)constructs a new GridPanel.HTMLGridPanel(Bounds2d extent, Dimension size)constructs a new GridPanel. 
- 
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddisplayWorldCoordinateToolTip()Display a tooltip with the last known world coordinates of the mouse, in case the tooltip should be displayed.protected voiddrawGrid(Graphics g)Added to make sure the recursive render-call calls THIS render method instead of a potential super-class defined 'paintComponent' render method.ColorgetBackground()StringgetDrawingCommands()Return the set of drawing commands.Bounds2dgetExtent()returns the extent of this panel.FontgetFont()FontMetricsgetFontMetrics(Font font)intgetHeight()DimensiongetPreferredSize()RenderableScalegetRenderableScale()DimensiongetSize()StringgetToolTipText()intgetWidth()Point2dgetWorldCoordinate()voidhome()resets the panel to its original extent.booleanimageUpdate(Image img, int infoflags, int x, int y, int width, int height)booleanisDirty()booleanisShowGrid()booleanisShowing()booleanisShowToolTip()voidpaintComponent(HTMLGraphics2D g)Draw the grid.voidpan(int direction, double percentage)pans the panel in a specified direction.voidrepaint()Repaint the shadow canvas.voidsetBackground(Color background)voidsetExtent(Bounds2d extent)set a new extent for this panel.voidsetFont(Font font)voidsetPreferredSize(Dimension preferredSize)voidsetRenderableScale(RenderableScale renderableScale)voidsetShowGrid(boolean showGrid)voidsetShowing(boolean showing)voidsetShowToolTip(boolean showToolTip)voidsetSize(Dimension size)voidsetToolTipText(String toolTipText)voidsetWorldCoordinate(Point2d point)Set the world coordinates based on a mouse move.voidshowGrid(boolean bool)show the grid?voidzoom(double factor)zooms in/out.voidzoom(double factor, int mouseX, int mouseY)zooms in/out. 
 - 
 
- 
- 
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 Bounds2d extent
the extent of this panel. 
- 
homeExtent
protected Bounds2d homeExtent
the extent of this panel. 
- 
showGrid
protected boolean showGrid
show the grid. 
- 
gridSizeX
protected double gridSizeX
the gridSize for the X-direction in world Units. 
- 
gridSizeY
protected double gridSizeY
the gridSize for the Y-direction 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. 
- 
renderableScale
protected RenderableScale renderableScale
the renderable scale (X/Y ratio) to use. 
 - 
 
- 
Constructor Detail
- 
HTMLGridPanel
public HTMLGridPanel(Bounds2d extent)
constructs a new GridPanel.- Parameters:
 extent- Bounds2d; the extent to show.
 
 - 
 
- 
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 Bounds2d getExtent()
returns the extent of this panel.- Returns:
 - Bounds2d
 
 
- 
setExtent
public final void setExtent(Bounds2d extent)
set a new extent for this panel.- Parameters:
 extent- Bounds2d; set a new extent
 
- 
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 directionpercentage- 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 factormouseX- int; x-position of the mouse around which we zoommouseY- 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
 
- 
getRenderableScale
public final RenderableScale getRenderableScale()
- Returns:
 - renderableScale
 
 
- 
setRenderableScale
public final void setRenderableScale(RenderableScale renderableScale)
- Parameters:
 renderableScale- RenderableScale; set renderableScale
 
- 
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:
 imageUpdatein interfaceImageObserver
 
 - 
 
 -