Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JGraph X 1.4.0.9
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.mxgraph.canvas
Class mxBasicCanvas

    java.lang.Object
      com.mxgraph.canvas.mxBasicCanvas

All Implemented Interfaces:
  mxICanvas

Direct Known Subclasses:
  mxGraphics2DCanvas, mxHtmlCanvas, mxSvgCanvas, mxVmlCanvas

    public abstract class mxBasicCanvas

extends Object
implements mxICanvas

Field Summary
`static String` | `DEFAULT_IMAGEBASEPATH` Defines the default value for the imageBasePath in all GDI canvases.
`protected boolean` | `drawLabels` Specifies whether labels should be painted.
`protected String` | `imageBasePath` Defines the base path for images with relative paths.
`protected double` | `scale` Specifies the current scale.
`protected Point` | `translate` Specifies the current translation.

Constructor Summary
`mxBasicCanvas()`

Method Summary
`String` | `getImageBasePath()`
`String` | `getImageForStyle(Map<String,Object> style)` Gets the image path from the given style.
`double` | `getScale()` Returns the scale.
`Point` | `getTranslate()` Returns the current translation.
`boolean` | `isDrawLabels()`
`void` | `setDrawLabels(boolean drawLabels)`
`void` | `setImageBasePath(String imageBasePath)`
`void` | `setScale(double scale)` Sets the scale for the following drawing requests.
`void` | `setTranslate(int dx, int dy)` Sets the translation for the following drawing requests.

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

Methods inherited from interface com.mxgraph.canvas.mxICanvas
`drawCell, drawLabel`

Field Detail

### DEFAULT_IMAGEBASEPATH

    public static String DEFAULT_IMAGEBASEPATH

  Defines the default value for the imageBasePath in all GDI canvases. Default is an empty string.

### imageBasePath

    protected String imageBasePath

  Defines the base path for images with relative paths. Trailing slash is required. Default value is DEFAULT_IMAGEBASEPATH.

### translate

    protected Point translate

  Specifies the current translation. Default is (0,0).

### scale

    protected double scale

  Specifies the current scale. Default is 1.

### drawLabels

    protected boolean drawLabels

  Specifies whether labels should be painted. Default is true.

Constructor Detail

### mxBasicCanvas

    public mxBasicCanvas()

Method Detail

### setTranslate

    public void setTranslate(int dx,
                             int dy)

  Description copied from interface: `mxICanvas`
  Sets the translation for the following drawing requests.

  Specified by:
    `setTranslate` in interface `mxICanvas`

### getTranslate

    public Point getTranslate()

  Description copied from interface: `mxICanvas`
  Returns the current translation.

  Specified by:
    `getTranslate` in interface `mxICanvas`
  Returns:
    Returns the current translation.

### setScale

    public void setScale(double scale)

  Description copied from interface: `mxICanvas`
  Sets the scale for the following drawing requests.

  Specified by:
    `setScale` in interface `mxICanvas`

### getScale

    public double getScale()

  Description copied from interface: `mxICanvas`
  Returns the scale.

  Specified by:
    `getScale` in interface `mxICanvas`

### setDrawLabels

    public void setDrawLabels(boolean drawLabels)

### getImageBasePath

    public String getImageBasePath()

### setImageBasePath

    public void setImageBasePath(String imageBasePath)

### isDrawLabels

    public boolean isDrawLabels()

### getImageForStyle

    public String getImageForStyle(Map<String,Object> style)

  Gets the image path from the given style. If the path is relative (does not start with a slash) then it is appended to the imageBasePath.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JGraph X 1.4.0.9
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright (c) 2010 Gaudenz Alder. All rights reserved.