org.eclipse.swt.widgets

Class Tracker

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Tracker

public class Tracker
extends Widget

Instances of this class implement rubber banding rectangles that are drawn onto a parent Composite or Display. These rectangles can be specified to respond to mouse and key events by either moving or resizing themselves accordingly. Trackers are typically used to represent window geometries in a lightweight manner.

Styles:

LEFT, RIGHT, UP, DOWN, RESIZE

Events:

Move, Resize

Note: Rectangle move behavior is assumed unless RESIZE is specified.

IMPORTANT: This class is not intended to be subclassed.

See Also:

Tracker snippets, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Rectangle	bounds
(package private) boolean	cancelled
(package private) Cursor	clientCursor
(package private) int	cursorOrientation
(package private) int	hwndOpaque
(package private) int	hwndTransparent
(package private) boolean	inEvent
(package private) static boolean	IsVista
(package private) int	oldOpaqueProc
(package private) int	oldTransparentProc
(package private) int	oldX
(package private) int	oldY
(package private) Control	parent
(package private) Rectangle[]	proportions
(package private) Rectangle[]	rectangles
(package private) int	resizeCursor
(package private) static int	STEPSIZE_LARGE
(package private) static int	STEPSIZE_SMALL
(package private) boolean	stippled
(package private) boolean	tracking

Fields inherited from class org.eclipse.swt.widgets.Widget

CANVAS, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, display, DISPOSE_SENT, DISPOSED, DRAG_DETECT, DRAW_BACKGROUND, eventTable, FOREIGN_HANDLE, HIDDEN, IGNORE_WM_CHANGEUISTATE, KEYED_DATA, LAYOUT_CHANGED, LAYOUT_CHILD, LAYOUT_NEEDED, MAJOR, MINOR, MOVE_DEFERRED, MOVE_OCCURRED, PARENT_BACKGROUND, RELEASED, RESIZE_DEFERRED, RESIZE_OCCURRED, SKIN_NEEDED, state, style, THEME_BACKGROUND, TRACK_MOUSE

Constructor Summary

Constructors

Constructor and Description
Tracker(Composite parent, int style) Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.
Tracker(Display display, int style) Constructs a new instance of this class given the display to create it on and a style value describing its behavior and appearance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addControlListener(ControlListener listener) Adds the listener to the collection of listeners who will be notified when the control is moved or resized, by sending it one of the messages defined in the ControlListener interface.
void	addKeyListener(KeyListener listener) Adds the listener to the collection of listeners who will be notified when keys are pressed and released on the system keyboard, by sending it one of the messages defined in the KeyListener interface.
(package private) Point	adjustMoveCursor()
(package private) Point	adjustResizeCursor()
(package private) static int	checkStyle(int style)
void	close() Stops displaying the tracker rectangles.
(package private) Rectangle	computeBounds()
(package private) Rectangle[]	computeProportions(Rectangle[] rects)
(package private) void	drawRectangles(Rectangle[] rects, boolean stippled) Draw the rectangles displayed by the tracker.
Rectangle[]	getRectangles() Returns the bounds that are being drawn, expressed relative to the parent widget.
boolean	getStippled() Returns true if the rectangles are drawn with a stippled line, false otherwise.
(package private) void	moveRectangles(int xChange, int yChange)
boolean	open() Displays the Tracker rectangles for manipulation by the user.
(package private) void	releaseWidget()
void	removeControlListener(ControlListener listener) Removes the listener from the collection of listeners who will be notified when the control is moved or resized.
void	removeKeyListener(KeyListener listener) Removes the listener from the collection of listeners who will be notified when keys are pressed and released on the system keyboard.
(package private) void	resizeRectangles(int xChange, int yChange)
void	setCursor(Cursor newCursor) Sets the Cursor of the Tracker.
void	setRectangles(Rectangle[] rectangles) Specifies the rectangles that should be drawn, expressed relative to the parent widget.
void	setStippled(boolean stippled) Changes the appearance of the line used to draw the rectangles.
(package private) int	transparentProc(int hwnd, int msg, int wParam, int lParam)
(package private) void	update()
(package private) LRESULT	wmKeyDown(int hwnd, int wParam, int lParam)
(package private) LRESULT	wmMouse(int message, int wParam, int lParam)
(package private) LRESULT	wmSysKeyDown(int hwnd, int wParam, int lParam)

Methods inherited from class org.eclipse.swt.widgets.Widget

_addListener, addDisposeListener, addListener, callWindowProc, checkBits, checkOpened, checkOrientation, checkParent, checkSubclass, checkWidget, DeferWindowPos, destroyWidget, dispose, dragDetect, error, filters, findItem, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getMenu, getName, getNameText, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mapEvent, new_GC, notifyListeners, postEvent, postEvent, release, releaseChildren, releaseHandle, releaseParent, removeDisposeListener, removeListener, removeListener, reskin, reskinChildren, reskinWidget, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendFocusEvent, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, sendMouseWheelEvent, sendSelectionEvent, sendSelectionEvent, setData, setData, setInputState, setKeyState, setLocationMask, setTabGroupFocus, setTabItemFocus, SetWindowPos, showMenu, showMenu, toString, updateMenuLocation, wmCaptureChanged, wmChar, wmContextMenu, wmIMEChar, wmKeyUp, wmKillFocus, wmLButtonDblClk, wmLButtonDown, wmLButtonUp, wmMButtonDblClk, wmMButtonDown, wmMButtonUp, wmMouseHover, wmMouseHWheel, wmMouseLeave, wmMouseMove, wmMouseWheel, wmNCPaint, wmPaint, wmPrint, wmRButtonDblClk, wmRButtonDown, wmRButtonUp, wmSetFocus, wmSysChar, wmSysKeyUp, wmXButtonDblClk, wmXButtonDown, wmXButtonUp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

parent

Control parent

tracking

boolean tracking

cancelled

boolean cancelled

stippled

boolean stippled

rectangles

Rectangle[] rectangles

proportions

Rectangle[] proportions

bounds

Rectangle bounds

resizeCursor

int resizeCursor

clientCursor

Cursor clientCursor

cursorOrientation

int cursorOrientation

inEvent

boolean inEvent

hwndTransparent

int hwndTransparent

hwndOpaque

int hwndOpaque

oldTransparentProc

int oldTransparentProc

oldOpaqueProc

int oldOpaqueProc

oldX

int oldX

oldY

int oldY

IsVista

static boolean IsVista

STEPSIZE_SMALL

static final int STEPSIZE_SMALL

See Also:

Constant Field Values

STEPSIZE_LARGE

static final int STEPSIZE_LARGE

See Also:

Constant Field Values

Constructor Detail

Tracker

public Tracker(Composite parent,
       int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a widget which will be the parent of the new instance (cannot be null)

style - the style of widget to construct

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

SWT.LEFT, SWT.RIGHT, SWT.UP, SWT.DOWN, SWT.RESIZE, Widget.checkSubclass(), Widget.getStyle()

Tracker

public Tracker(Display display,
       int style)

Constructs a new instance of this class given the display to create it on and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Note: Currently, null can be passed in for the display argument. This has the effect of creating the tracker on the currently active display if there is one. If there is no current display, the tracker is created on a "default" display. Passing in null as the display argument is not considered to be good coding style, and may not be supported in a future release of SWT.

Parameters:

display - the display to create the tracker on

style - the style of control to construct

Throws:

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

SWT.LEFT, SWT.RIGHT, SWT.UP, SWT.DOWN, SWT.RESIZE

Method Detail

addControlListener

public void addControlListener(ControlListener listener)

Adds the listener to the collection of listeners who will be notified when the control is moved or resized, by sending it one of the messages defined in the ControlListener interface.

Parameters:

listener - the listener which should be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

ControlListener, removeControlListener(org.eclipse.swt.events.ControlListener)

addKeyListener

public void addKeyListener(KeyListener listener)

Adds the listener to the collection of listeners who will be notified when keys are pressed and released on the system keyboard, by sending it one of the messages defined in the KeyListener interface.

Parameters:

listener - the listener which should be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

KeyListener, removeKeyListener(org.eclipse.swt.events.KeyListener)

adjustMoveCursor

Point adjustMoveCursor()

adjustResizeCursor

Point adjustResizeCursor()

checkStyle

static int checkStyle(int style)

close

public void close()

Stops displaying the tracker rectangles. Note that this is not considered to be a cancelation by the user.

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

computeBounds

Rectangle computeBounds()

computeProportions

Rectangle[] computeProportions(Rectangle[] rects)

drawRectangles

void drawRectangles(Rectangle[] rects,
                  boolean stippled)

Draw the rectangles displayed by the tracker.

getRectangles

public Rectangle[] getRectangles()

Returns the bounds that are being drawn, expressed relative to the parent widget. If the parent is a Display then these are screen coordinates.

Returns:

the bounds of the Rectangles being drawn

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getStippled

public boolean getStippled()

Returns true if the rectangles are drawn with a stippled line, false otherwise.

Returns:

the stippled effect of the rectangles

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

moveRectangles

void moveRectangles(int xChange,
                  int yChange)

open

public boolean open()

Displays the Tracker rectangles for manipulation by the user. Returns when the user has either finished manipulating the rectangles or has cancelled the Tracker.

Returns:

true if the user did not cancel the Tracker, false otherwise

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Widget

removeControlListener

public void removeControlListener(ControlListener listener)

Removes the listener from the collection of listeners who will be notified when the control is moved or resized.

Parameters:

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

ControlListener, addControlListener(org.eclipse.swt.events.ControlListener)

removeKeyListener

public void removeKeyListener(KeyListener listener)

Removes the listener from the collection of listeners who will be notified when keys are pressed and released on the system keyboard.

Parameters:

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

KeyListener, addKeyListener(org.eclipse.swt.events.KeyListener)

resizeRectangles

void resizeRectangles(int xChange,
                    int yChange)

setCursor

public void setCursor(Cursor newCursor)

Sets the Cursor of the Tracker. If this cursor is null then the cursor reverts to the default.

Parameters:

newCursor - the new Cursor to display

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setRectangles

public void setRectangles(Rectangle[] rectangles)

Specifies the rectangles that should be drawn, expressed relative to the parent widget. If the parent is a Display then these are screen coordinates.

Parameters:

rectangles - the bounds of the rectangles to be drawn

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the set of rectangles is null or contains a null rectangle

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setStippled

public void setStippled(boolean stippled)

Changes the appearance of the line used to draw the rectangles.

Parameters:

stippled - true if rectangle should appear stippled

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

transparentProc

int transparentProc(int hwnd,
                  int msg,
                  int wParam,
                  int lParam)

update

void update()

wmKeyDown

LRESULT wmKeyDown(int hwnd,
                int wParam,
                int lParam)

Overrides:

wmKeyDown in class Widget

wmSysKeyDown

LRESULT wmSysKeyDown(int hwnd,
                   int wParam,
                   int lParam)

Overrides:

wmSysKeyDown in class Widget

wmMouse

LRESULT wmMouse(int message,
              int wParam,
              int lParam)