org.gnu.gnome

Class Canvas

public class Canvas extends Layout

Deprecated: This class is part of the java-gnome 2.x family of libraries, which, due to their inefficiency and complexity, are no longer being maintained and have been abandoned by the java-gnome project. This class may have an equivalent in java-gnome 4.0; have a look for org.gnome.gnome.Canvas.

You can use the GnomeCanvas widget to draw figures, display graphics, position widgets, and more.
Constructor Summary
Canvas(boolean useAntialiased)
Constructs a new Canvas.
Canvas()
Construct a new Canvas.
Canvas(Handle handle)
Constructs a new Canvas object form a native resource.
Method Summary
static CanvasgetCanvas(Handle handle)
Internal static factory method to be used by Java-Gnome only.
booleangetCenterScrollRegion()
ColorgetColor(String spec)
Takes a string specification for a color and allocates it into the specified GdkColor.
longgetColorPixel(int rgba)
Allocates a color from the RGB value passed into this function.
CanvasItemgetCurrentCanvasItem()
The item containing the mouse pointer, or NULL if none.
RgbDithergetDither()
Returns the dither mode of an antialiased canvas.
CanvasItemgetFocusedCanvasItem()
The currently focused item, or NULL if none.
CanvasItemgetGrabbedCanvasItem()
The item that holds a pointer grab, or NULL if none.
CanvasItemgetItemAt(double x, double y)
Returns the item that is at the specified position in world coordinates, or NULL if no item is there.
doublegetPixelsPerUnit()
Scaling factor to be used for display.
CanvasGroupgetRoot()
Returns the root canvas item group of the canvas
doublegetScrollOffsetX()
Returns the horizontal scroll offset of the canvas in canvas pixel coordinates.
doublegetScrollOffsetY()
Returns the vertical scroll offset of the canvas in canvas pixel coordinates.
doublegetScrollX1()
The x1 coordinate of the scrolling region.
doublegetScrollX2()
The x2 coordinate of the scrolling region.
doublegetScrollY1()
The y1 coordinate of the scrolling region.
doublegetScrollY2()
The y2 coordinate of the scrolling region.
static TypegetType()
Retrieve the runtime type used by the GLib library.
voidrequestRedraw(int x1, int y1, int x2, int y2)
voidscrollTo(int cx, int cy)
Scrolls the canvas to the specified offsets, given in canvas pixel coordinates.
voidsetCenterScrollRegion(boolean center)
voidsetDither(RgbDither dither)
Controls the dithering used when the canvas renders.
voidsetPixelsPerUnit(double n)
Sets the number of pixels that correspond to one unit in world coordinates.
voidsetScrollRegion(double x1, double y1, double x2, double y2)
Convenience method to set all 4 coordinates of the scroll region at once.
voidsetScrollX1(double x1)
Set the scroll region's X1 coordinate.
voidsetScrollX2(double x2)
Set the scroll region's X2 coordinate.
voidsetScrollY1(double y1)
Set the scroll region's Y1 coordinate.
voidsetScrollY2(double y2)
Set the scroll region's Y2 coordinate.
voidupdate()
Requests that the canvas be repainted immediately instead of during the idle loop.
doublewindowToWorldX(double winx)
doublewindowToWorldY(double winy)
doubleworldToWindowX(double worldx)
doubleworldToWindowY(double worldy)

Constructor Detail

Canvas

public Canvas(boolean useAntialiased)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Constructs a new Canvas.

Canvas

public Canvas()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Construct a new Canvas.

Canvas

public Canvas(Handle handle)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Constructs a new Canvas object form a native resource.

Parameters: handle The handle to the native resource.

Method Detail

getCanvas

public static Canvas getCanvas(Handle handle)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Internal static factory method to be used by Java-Gnome only.

getCenterScrollRegion

public boolean getCenterScrollRegion()

getColor

public Color getColor(String spec)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Takes a string specification for a color and allocates it into the specified GdkColor.

Parameters: spec The color to allocate.

getColorPixel

public long getColorPixel(int rgba)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Allocates a color from the RGB value passed into this function.

Parameters: rgba The RGB value.

getCurrentCanvasItem

public CanvasItem getCurrentCanvasItem()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

The item containing the mouse pointer, or NULL if none.

getDither

public RgbDither getDither()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Returns the dither mode of an antialiased canvas. Only applicable to antialiased canvases - ignored by non-antialiased convases.

getFocusedCanvasItem

public CanvasItem getFocusedCanvasItem()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

The currently focused item, or NULL if none.

getGrabbedCanvasItem

public CanvasItem getGrabbedCanvasItem()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

The item that holds a pointer grab, or NULL if none.

getItemAt

public CanvasItem getItemAt(double x, double y)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Returns the item that is at the specified position in world coordinates, or NULL if no item is there.

Parameters: x The horizontal coordinate. y The vertical coordinate.

getPixelsPerUnit

public double getPixelsPerUnit()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Scaling factor to be used for display.

getRoot

public CanvasGroup getRoot()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Returns the root canvas item group of the canvas

getScrollOffsetX

public double getScrollOffsetX()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Returns the horizontal scroll offset of the canvas in canvas pixel coordinates.

Returns: The scroll offset x coordinate.

getScrollOffsetY

public double getScrollOffsetY()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Returns the vertical scroll offset of the canvas in canvas pixel coordinates.

Returns: The scroll offset y coordinate.

getScrollX1

public double getScrollX1()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

The x1 coordinate of the scrolling region.

getScrollX2

public double getScrollX2()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

The x2 coordinate of the scrolling region.

getScrollY1

public double getScrollY1()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

The y1 coordinate of the scrolling region.

getScrollY2

public double getScrollY2()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

The y2 coordinate of the scrolling region.

getType

public static Type getType()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Retrieve the runtime type used by the GLib library.

requestRedraw

public void requestRedraw(int x1, int y1, int x2, int y2)

scrollTo

public void scrollTo(int cx, int cy)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Scrolls the canvas to the specified offsets, given in canvas pixel coordinates.

Parameters: cx Horizontal coordinate. cy Vertical coordinate.

setCenterScrollRegion

public void setCenterScrollRegion(boolean center)

setDither

public void setDither(RgbDither dither)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Controls the dithering used when the canvas renders. Only applicable to antialiased canvases - ignored by non-antialiased canvases.

setPixelsPerUnit

public void setPixelsPerUnit(double n)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Sets the number of pixels that correspond to one unit in world coordinates.

Parameters: n The number of pixels

setScrollRegion

public void setScrollRegion(double x1, double y1, double x2, double y2)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Convenience method to set all 4 coordinates of the scroll region at once.

Parameters: x1 First horizontal coordinate. y1 First vertical coordinate. x2 Second horizontal coordinate. y2 Second vertical coordinate.

setScrollX1

public void setScrollX1(double x1)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Set the scroll region's X1 coordinate.

Parameters: x1

setScrollX2

public void setScrollX2(double x2)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Set the scroll region's X2 coordinate.

Parameters: x2

setScrollY1

public void setScrollY1(double y1)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Set the scroll region's Y1 coordinate.

Parameters: y1

setScrollY2

public void setScrollY2(double y2)

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Set the scroll region's Y2 coordinate.

Parameters: y2

update

public void update()

Deprecated: Superceeded by java-gnome 4.0; this method may or may not exist in the new bindings but if it does, it will likely have a different name or signature in order that the presented API is a more algorithmic mapping of the underlying native libraries.

Requests that the canvas be repainted immediately instead of during the idle loop.

windowToWorldX

public double windowToWorldX(double winx)

windowToWorldY

public double windowToWorldY(double winy)

worldToWindowX

public double worldToWindowX(double worldx)

worldToWindowY

public double worldToWindowY(double worldy)