Class Tracker
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:
- Restriction:
- This class is not intended to be subclassed by clients.
-
Field Summary
Fields inherited from class org.eclipse.swt.widgets.Widget
nativeZoom
-
Constructor Summary
ConstructorDescriptionConstructs a new instance of this class given its parent and a style value describing its behavior and appearance.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
Modifier and TypeMethodDescriptionvoid
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 theControlListener
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 theKeyListener
interface.void
close()
Stops displaying the tracker rectangles.Returns the bounds that are being drawn, expressed relative to the parent widget.boolean
Returnstrue
if the rectangles are drawn with a stippled line,false
otherwise.boolean
open()
Displays the Tracker rectangles for manipulation by the user.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.void
Sets theCursor
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.Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, addTypedListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, getTypedListeners, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, removeTypedListener, reskin, setData, setData, toString
-
Constructor Details
-
Tracker
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 theint
"|" operator) two or more of thoseSWT
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:
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:
-
Tracker
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 theint
"|" operator) two or more of thoseSWT
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 onstyle
- 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:
-
-
Method Details
-
addControlListener
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 theControlListener
interface.- Parameters:
listener
- the listener which should be notified- Throws:
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:
-
addKeyListener
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 theKeyListener
interface.- Parameters:
listener
- the listener which should be notified- Throws:
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:
-
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
-
getRectangles
Returns the bounds that are being drawn, expressed relative to the parent widget. If the parent is aDisplay
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()Returnstrue
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
-
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
-
removeControlListener
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:
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:
-
removeKeyListener
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:
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:
-
setCursor
Sets theCursor
of the Tracker. If this cursor isnull
then the cursor reverts to the default.- Parameters:
newCursor
- the newCursor
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
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:
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
-