com.touchgraph.graphlayout
Interface TGScrollPane

All Known Implementing Classes:

EditorLayoutPanel, GLPanel, GraphLayoutPanel, TMLayoutPanel

public interface TGScrollPane

TGScrollPane is a Java interface for a user interface using scrollbars to set TouchGraph navigation and editing properties such as zoom, rotate and locality. If a particular UI doesn't use a specific scrollbar, the corresponding method should return a null.

Version:

1.21 $Id: TGScrollPane.java,v 3.0 2004/07/24 13:21:12 altheim Exp $

Author:

Murray Altheim, Alex Shapiro

Method Summary

HVScroll	getHVScroll() Return the HVScroll used with this TGScrollPane.
int	getHyperbolicDistortion() Return the hyperbolic (aka "fisheye") distortion of this TGScrollPane.
HyperScroll	getHyperScroll() Return the HyperScroll used with this TGScrollPane.
int	getLocalityRadius() Return the locality radius of this TGScrollPane.
LocalityScroll	getLocalityScroll() Return the LocalityScroll used with this TGScrollPane.
Point	getOffset() Return the horizontal and vertical offset position as a Point.
JPopupMenu	getPopupMenu() Return the JPopupMenu used to toggle display of the controls.
RotateScroll	getRotateScroll() Return the RotateScroll used with this TGScrollPane.
int	getRotationAngle() Return the rotation angle of this TGScrollPane.
TGPanel	getTGPanel() Return the TGPanel used with this TGScrollPane.
ZoomScroll	getZoomScroll() Return the ZoomScroll used with this TGScrollPane.
int	getZoomValue() Return the zoom value of this TGScrollPane.
void	keyPressed(KeyEvent event) An action method indicating a key event has occurred.
void	nodeClicked(Node node, MouseEvent event) An action method indicating Node node has been clicked.
void	nodeDoubleClicked(Node node, MouseEvent event) An action method indicating Node node has been double-clicked.
void	setHyperbolicDistortion(int value) Set the hyperbolic (aka "fisheye") distortion of this TGScrollPane (allowable values between 0 to 108).
void	setLocalityRadius(int radius) Set the locality radius of this TGScrollPane (allowable values between 0 to 4, or LocalityUtils.INFINITE_LOCALITY_RADIUS).
void	setOffset(Point p) Sets the horizontal offset to p.x, and the vertical offset to p.y given a Point p.
void	setRotationAngle(int angle) Set the rotation angle of this TGScrollPane (allowable values between 0 to 359).
void	setZoomValue(int zoomValue) Set the zoom value of this TGScrollPane (allowable values between -100 to 100).

Method Detail

getTGPanel

TGPanel getTGPanel()

Return the TGPanel used with this TGScrollPane.

getPopupMenu

JPopupMenu getPopupMenu()

Return the JPopupMenu used to toggle display of the controls.

nodeClicked

void nodeClicked(Node node,
                 MouseEvent event)

An action method indicating Node node has been clicked. The MouseEvent event may optionally be used to provide information about modifier keys. The behaviour if null should be identical to a node clicked with no modifier keys pressed.

nodeDoubleClicked

void nodeDoubleClicked(Node node,
                       MouseEvent event)

An action method indicating Node node has been double-clicked. The MouseEvent event may optionally be used to provide information about modifier keys. The behaviour if null should be identical to a node clicked with no modifier keys pressed.

keyPressed

void keyPressed(KeyEvent event)

An action method indicating a key event has occurred. The KeyEvent event may include information about modifier keys.

getHVScroll

HVScroll getHVScroll()

Return the HVScroll used with this TGScrollPane.

setOffset

void setOffset(Point p)

Sets the horizontal offset to p.x, and the vertical offset to p.y given a Point p.

getOffset

Point getOffset()

Return the horizontal and vertical offset position as a Point.

getZoomScroll

ZoomScroll getZoomScroll()

Return the ZoomScroll used with this TGScrollPane.

setZoomValue

void setZoomValue(int zoomValue)

Set the zoom value of this TGScrollPane (allowable values between -100 to 100).

getZoomValue

int getZoomValue()

Return the zoom value of this TGScrollPane.

getRotateScroll

RotateScroll getRotateScroll()

Return the RotateScroll used with this TGScrollPane.

setRotationAngle

void setRotationAngle(int angle)

Set the rotation angle of this TGScrollPane (allowable values between 0 to 359).

getRotationAngle

int getRotationAngle()

Return the rotation angle of this TGScrollPane.

getLocalityScroll

LocalityScroll getLocalityScroll()

Return the LocalityScroll used with this TGScrollPane.

setLocalityRadius

void setLocalityRadius(int radius)

Set the locality radius of this TGScrollPane (allowable values between 0 to 4, or LocalityUtils.INFINITE_LOCALITY_RADIUS).

getLocalityRadius

int getLocalityRadius()

Return the locality radius of this TGScrollPane.

getHyperScroll

HyperScroll getHyperScroll()

Return the HyperScroll used with this TGScrollPane.

setHyperbolicDistortion

void setHyperbolicDistortion(int value)

Set the hyperbolic (aka "fisheye") distortion of this TGScrollPane (allowable values between 0 to 108).

getHyperbolicDistortion

int getHyperbolicDistortion()

Return the hyperbolic (aka "fisheye") distortion of this TGScrollPane.