Overview | File | Class | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## Class draw2d.Canvas

    Object
       |
       +--draw2d.Canvas

Direct Known Subclasses:
  draw2d.Workflow

class draw2d.Canvas

Defined in Canvas.js
Version: 0.9.14
Author: Andreas Herz

Field Summary
`Object` | `enableSmoothFigureHandling`

Constructor Summary
`draw2d.Canvas ( canvasId)`

Method Summary
`void` | `addFigure( <draw2d.Figure> figure, <int> xPos, <int> yPos, avoidPaint)`
`int` | `getAbsoluteX()`
`int` | `getAbsoluteY()`
`boolean` | `getEnableSmoothFigureHandling()` Returns the flag if the Canvas has enabled the smooth figure handling during add, remove, selection, drag&drop.
`int` | `getHeight()`
`int` | `getScrollLeft()`
`int` | `getScrollTop()`
`int` | `getWidth()`
`int` | `getX()`
`int` | `getY()`
`void` | `removeFigure( <draw2d.Figure> figure)`
`void` | `setBackgroundImage( <String> imageUrl, repeat)` Set the background image of the Canvas.
`void` | `setEnableSmoothFigureHandling( <boolean> flag)` Set the flag for the smooth figure handling during add, remove, selection, drag&drop.
`void` | `setViewPort( divId)` Setting the view for the canvas.

Field Detail

### enableSmoothFigureHandling

    Object enableSmoothFigureHandling

Constructor Detail

### draw2d.Canvas

    draw2d.Canvas( canvasId)

Version: 0.9.14
Author: Andreas Herz

Method Detail

### addFigure

    void addFigure( <draw2d.Figure> figure, <int> xPos, <int> yPos, avoidPaint)

Parameters:

`figure` - The figure object to add to the canvas

`xPos` - The x coordinate for the figure

`yPos` - The y coordinate for the figure

### getAbsoluteX

    int getAbsoluteX()

Returns:

The X coordinate in relation to the canvas

### getAbsoluteY

    int getAbsoluteY()

Returns:

The Y coordinate in relation the Canvas.

### getEnableSmoothFigureHandling

    boolean getEnableSmoothFigureHandling()

Returns the flag if the Canvas has enabled the smooth figure handling during add, remove, selection, drag&drop.

### getHeight

    int getHeight()

### getScrollLeft

    int getScrollLeft()

Returns:

The Y coordinate in relation the Canvas.

### getScrollTop

    int getScrollTop()

Returns:

The X coordinate in relation to the canvas

### getWidth

    int getWidth()

### getX

    int getX()

Returns:

The X coordinate in relation to the canvas

### getY

    int getY()

Returns:

The Y coordinate in relation the Canvas.

### removeFigure

    void removeFigure( <draw2d.Figure> figure)

Parameters:

`figure` - The figure which should be remove from the canvas

### setBackgroundImage

    void setBackgroundImage( <String> imageUrl, repeat)

Set the background image of the Canvas. The URL can be absolute, like http://www.any.com/myimg.png or relative. Set the background image of the canvas

Parameters:

`imageUrl` - The url of the background image.

### setEnableSmoothFigureHandling

    void setEnableSmoothFigureHandling( <boolean> flag)

Set the flag for the smooth figure handling during add, remove, selection, drag&drop.

Parameters:

`flag` - The smooth figure handling flag.

### setViewPort

    void setViewPort( divId)

Setting the view for the canvas. A view is the part which has the scrolbar for the Canvas. See in the examples viewport or more information and usage.

Overview | File | Class | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Documentation generated by JSDoc on Thu Feb 7 23:45:47 2008