org.openbp.cockpit.modeler.drawing
Interface Trackable

All Known Implementing Classes:

Modeler, NodeItemEditorPlugin

public interface Trackable

This interface is used to implement a trackable component. The position of the tracker is denoted by the track rectangle. Most components in a scroll pane should be trackable, however, they aren't by default.

Author:

Jens Ferchland

Method Summary

void	addTrackChangedListener(javax.swing.event.ChangeListener listener) Adds a change listener to the trackable object.
void	centerTrackerAt(java.awt.Point p) Centers the trackable component at the specified point.
void	fireTrackChangedEvent(javax.swing.event.ChangeEvent event) Fires an event indicating that the tracker position has changed to the registered track change listeners.
java.awt.Dimension	getDocumentSize() Returns the size of the document that is displayed in the view.
java.awt.Rectangle	getVisibleArea() Returns the area that is currently visible.
boolean	isTrackSuspended() Returns true if the tracking has been suspended.
void	moveTrackerBy(int x, int y) Moves the tracker by the given distance.
void	removeTrackChangedListener(javax.swing.event.ChangeListener listener) Removes a change listener from the trackable object.
void	resumeTrack() Resumes propagation of track change events.
void	setVisibleArea(java.awt.Rectangle r) Sets the area that is currently visible.
void	suspendTrack() Prevents track change events to be propagated.

Method Detail

addTrackChangedListener

void addTrackChangedListener(javax.swing.event.ChangeListener listener)

Adds a change listener to the trackable object.

removeTrackChangedListener

void removeTrackChangedListener(javax.swing.event.ChangeListener listener)

Removes a change listener from the trackable object.

fireTrackChangedEvent

void fireTrackChangedEvent(javax.swing.event.ChangeEvent event)

Fires an event indicating that the tracker position has changed to the registered track change listeners.

Parameters:

event - Event to fire

suspendTrack

void suspendTrack()

Prevents track change events to be propagated.

resumeTrack

void resumeTrack()

Resumes propagation of track change events.

isTrackSuspended

boolean isTrackSuspended()

Returns true if the tracking has been suspended.

getDocumentSize

java.awt.Dimension getDocumentSize()

Returns the size of the document that is displayed in the view.

getVisibleArea

java.awt.Rectangle getVisibleArea()

Returns the area that is currently visible. For a scroll pane, this would be the view rectangle of the viewport of the scroll pane.

Returns:

Rectangle in document coordinates

setVisibleArea

void setVisibleArea(java.awt.Rectangle r)

Sets the area that is currently visible.

Parameters:

r - Rectangle in document coordinates

centerTrackerAt

void centerTrackerAt(java.awt.Point p)

Centers the trackable component at the specified point.

Parameters:

p - Point in document coordinates

moveTrackerBy

void moveTrackerBy(int x,
                   int y)

Moves the tracker by the given distance.

Parameters:

x - Hor. distance in document coordinates

y - Vert. distance in document coordinates