org.ginsim.gui.graph.canvas

Interface VirtualScrollable

All Known Implementing Classes:

SimpleCanvas

public interface VirtualScrollable

Define methods to integrate a view into a VirtualScrollPane. This interface enables collaboration between the scrollpane and the view.

Author:

Aurelien Naldi

Method Summary

Modifier and Type	Method and Description
Component	getComponent() Get the component for this view.
Dimension	getVirtualDimension() Get the full virtual size of this widget.
Rectangle	getVisibleArea() Get the part of the virtual size that is currently visible.
void	setScrollPane(VirtualScrollPane virtualScrollPane) Associate the view with a scrollPane.
void	setScrollPosition(int x, int y) Scroll this view to a specified position.

Method Detail

getComponent

Component getComponent()

Get the component for this view.

Returns:

a component to add in the scrollPane

setScrollPane

void setScrollPane(VirtualScrollPane virtualScrollPane)

Associate the view with a scrollPane. The view will then fire events upon view changes.

Parameters:

virtualScrollPane -

getVirtualDimension

Dimension getVirtualDimension()

Get the full virtual size of this widget. This is used by the scrollpane to define the ranges of the scrollbars.

Returns:

the Dimension of the space in which the visibleArea can move

getVisibleArea

Rectangle getVisibleArea()

Get the part of the virtual size that is currently visible. This allows the scrollpane to define the positions of the scrollbars.

Returns:

a rectangle providing the bounds of the visible area.

setScrollPosition

void setScrollPosition(int x,
                       int y)

Scroll this view to a specified position.

Parameters:

x -

y -