| /******************************************************************************* |
| * Copyright (c) 2000, 2003 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Common Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/cpl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.swt.widgets; |
| |
| |
| import org.eclipse.swt.graphics.*; |
| import org.eclipse.swt.*; |
| import org.eclipse.swt.events.*; |
| |
| /** |
| * Instances of this class implement rubber banding rectangles that are |
| * drawn onto a parent <code>Composite</code> or <code>Display</code>. |
| * 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. |
| * |
| * <dl> |
| * <dt><b>Styles:</b></dt> |
| * <dd>LEFT, RIGHT, UP, DOWN, RESIZE</dd> |
| * <dt><b>Events:</b></dt> |
| * <dd>Move, Resize</dd> |
| * </dl> |
| * <p> |
| * Note: Rectangle move behavior is assumed unless RESIZE is specified. |
| * </p><p> |
| * IMPORTANT: This class is <em>not</em> intended to be subclassed. |
| * </p> |
| */ |
| public class Tracker extends Widget { |
| Control parent; |
| Display display; |
| boolean tracking, stippled; |
| Rectangle [] rectangles, proportions; |
| int cursorOrientation = SWT.NONE; |
| |
| /** |
| * Constructs a new instance of this class given its parent |
| * and a style value describing its behavior and appearance. |
| * <p> |
| * The style value is either one of the style constants defined in |
| * class <code>SWT</code> which is applicable to instances of this |
| * class, or must be built by <em>bitwise OR</em>'ing together |
| * (that is, using the <code>int</code> "|" operator) two or more |
| * of those <code>SWT</code> style constants. The class description |
| * lists the style constants that are applicable to the class. |
| * Style bits are also inherited from superclasses. |
| * </p> |
| * |
| * @param parent a widget which will be the parent of the new instance (cannot be null) |
| * @param style the style of widget to construct |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> |
| * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> |
| * </ul> |
| * |
| * @see SWT#LEFT |
| * @see SWT#RIGHT |
| * @see SWT#UP |
| * @see SWT#DOWN |
| * @see SWT#RESIZE |
| * @see Widget#checkSubclass |
| * @see Widget#getStyle |
| */ |
| public Tracker (Composite parent, int style) { |
| super (parent, checkStyle (style)); |
| this.parent = parent; |
| display = parent.getDisplay (); |
| } |
| |
| /** |
| * Constructs a new instance of this class given the display |
| * to create it on and a style value describing its behavior |
| * and appearance. |
| * <p> |
| * The style value is either one of the style constants defined in |
| * class <code>SWT</code> which is applicable to instances of this |
| * class, or must be built by <em>bitwise OR</em>'ing together |
| * (that is, using the <code>int</code> "|" operator) two or more |
| * of those <code>SWT</code> style constants. The class description |
| * lists the style constants that are applicable to the class. |
| * Style bits are also inherited from superclasses. |
| * </p><p> |
| * 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. <b>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.</b> |
| * </p> |
| * |
| * @param display the display to create the tracker on |
| * @param style the style of control to construct |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> |
| * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> |
| * </ul> |
| * |
| * @see SWT#LEFT |
| * @see SWT#RIGHT |
| * @see SWT#UP |
| * @see SWT#DOWN |
| */ |
| public Tracker (Display display, int style) { |
| if (display == null) display = Display.getCurrent (); |
| if (display == null) display = Display.getDefault (); |
| if (!display.isValidThread ()) { |
| error (SWT.ERROR_THREAD_INVALID_ACCESS); |
| } |
| this.style = checkStyle (style); |
| this.display = display; |
| } |
| |
| /** |
| * 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 <code>ControlListener</code> |
| * interface. |
| * |
| * @param listener the listener which should be notified |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| * |
| * @see ControlListener |
| * @see #removeControlListener |
| */ |
| public void addControlListener (ControlListener listener) { |
| checkWidget (); |
| if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); |
| TypedListener typedListener = new TypedListener (listener); |
| addListener (SWT.Move,typedListener); |
| } |
| |
| Point adjustMoveCursor (int xDisplay, int xWindow) { |
| return new Point (0, 0); |
| } |
| |
| Point adjustResizeCursor (int xDisplay, int xWindow) { |
| return new Point (0, 0); |
| } |
| |
| static int checkStyle (int style) { |
| if ((style & (SWT.LEFT | SWT.RIGHT | SWT.UP | SWT.DOWN)) == 0) { |
| style |= SWT.LEFT | SWT.RIGHT | SWT.UP | SWT.DOWN; |
| } |
| return style; |
| } |
| |
| /** |
| * Stops displaying the tracker rectangles. Note that this is not considered |
| * to be a cancelation by the user. |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public void close () { |
| checkWidget (); |
| tracking = false; |
| } |
| Rectangle computeBounds () { |
| int xMin = rectangles [0].x; |
| int yMin = rectangles [0].y; |
| int xMax = rectangles [0].x + rectangles [0].width; |
| int yMax = rectangles [0].y + rectangles [0].height; |
| |
| for (int i = 1; i < rectangles.length; i++) { |
| if (rectangles [i].x < xMin) xMin = rectangles [i].x; |
| if (rectangles [i].y < yMin) yMin = rectangles [i].y; |
| int rectRight = rectangles [i].x + rectangles [i].width; |
| if (rectRight > xMax) xMax = rectRight; |
| int rectBottom = rectangles [i].y + rectangles [i].height; |
| if (rectBottom > yMax) yMax = rectBottom; |
| } |
| |
| return new Rectangle (xMin, yMin, xMax - xMin, yMax - yMin); |
| } |
| |
| Rectangle [] computeProportions (Rectangle [] rects) { |
| Rectangle [] result = new Rectangle [rects.length]; |
| Rectangle bounds = computeBounds (); |
| for (int i = 0; i < rects.length; i++) { |
| result[i] = new Rectangle ( |
| (rects[i].x - bounds.x) * 100 / bounds.width, |
| (rects[i].y - bounds.y) * 100 / bounds.height, |
| rects[i].width * 100 / bounds.width, |
| rects[i].height * 100 / bounds.height); |
| } |
| return result; |
| } |
| |
| void drawRectangles () { |
| if (parent != null) { |
| if (parent.isDisposed ()) return; |
| Shell shell = parent.getShell (); |
| shell.update (true); |
| } else { |
| display.update (); |
| } |
| } |
| |
| public Display getDisplay () { |
| return display; |
| } |
| |
| /** |
| * Returns the bounds that are being drawn, expressed relative to the parent |
| * widget. If the parent is a <code>Display</code> then these are screen |
| * coordinates. |
| * |
| * @return the bounds of the Rectangles being drawn |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public Rectangle [] getRectangles () { |
| checkWidget (); |
| return rectangles; |
| } |
| |
| /** |
| * Returns <code>true</code> if the rectangles are drawn with a stippled line, <code>false</code> otherwise. |
| * |
| * @return the stippled effect of the rectangles |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public boolean getStippled () { |
| checkWidget (); |
| return stippled; |
| } |
| |
| void moveRectangles (int xChange, int yChange) { |
| if (xChange < 0 && ((style & SWT.LEFT) == 0)) return; |
| if (xChange > 0 && ((style & SWT.RIGHT) == 0)) return; |
| if (yChange < 0 && ((style & SWT.UP) == 0)) return; |
| if (yChange > 0 && ((style & SWT.DOWN) == 0)) return; |
| for (int i = 0; i < rectangles.length; i++) { |
| rectangles [i].x += xChange; |
| rectangles [i].y += yChange; |
| } |
| } |
| |
| /** |
| * Displays the Tracker rectangles for manipulation by the user. Returns when |
| * the user has either finished manipulating the rectangles or has cancelled the |
| * Tracker. |
| * |
| * @return <code>true</code> if the user did not cancel the Tracker, <code>false</code> otherwise |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public boolean open () { |
| checkWidget (); |
| if (rectangles == null) return false; |
| return false; |
| } |
| |
| /** |
| * Removes the listener from the collection of listeners who will |
| * be notified when the control is moved or resized. |
| * |
| * @param listener the listener which should be notified |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> |
| * </ul> |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| * |
| * @see ControlListener |
| * @see #addControlListener |
| */ |
| public void removeControlListener (ControlListener listener) { |
| checkWidget (); |
| if (listener == null) error (SWT.ERROR_NULL_ARGUMENT); |
| if (eventTable == null) return; |
| eventTable.unhook (SWT.Move, listener); |
| } |
| |
| void resizeRectangles (int xChange, int yChange) { |
| /* |
| * If the cursor orientation has not been set in the orientation of |
| * this change then try to set it here. |
| */ |
| if (xChange < 0 && ((style & SWT.LEFT) != 0) && ((cursorOrientation & SWT.RIGHT) == 0)) { |
| cursorOrientation |= SWT.LEFT; |
| } else if (xChange > 0 && ((style & SWT.RIGHT) != 0) && ((cursorOrientation & SWT.LEFT) == 0)) { |
| cursorOrientation |= SWT.RIGHT; |
| } else if (yChange < 0 && ((style & SWT.UP) != 0) && ((cursorOrientation & SWT.DOWN) == 0)) { |
| cursorOrientation |= SWT.UP; |
| } else if (yChange > 0 && ((style & SWT.DOWN) != 0) && ((cursorOrientation & SWT.UP) == 0)) { |
| cursorOrientation |= SWT.DOWN; |
| } |
| Rectangle bounds = computeBounds (); |
| if ((cursorOrientation & SWT.LEFT) != 0) { |
| bounds.x += xChange; |
| bounds.width -= xChange; |
| } else if ((cursorOrientation & SWT.RIGHT) != 0) { |
| bounds.width += xChange; |
| } |
| if ((cursorOrientation & SWT.UP) != 0) { |
| bounds.y += yChange; |
| bounds.height -= yChange; |
| } else if ((cursorOrientation & SWT.DOWN) != 0) { |
| bounds.height += yChange; |
| } |
| /* |
| * The following are conditions under which the resize should not be applied |
| */ |
| if (bounds.width < 0 || bounds.height < 0) return; |
| |
| Rectangle [] newRects = new Rectangle [rectangles.length]; |
| for (int i = 0; i < rectangles.length; i++) { |
| Rectangle proportion = proportions[i]; |
| newRects[i] = new Rectangle ( |
| proportion.x * bounds.width / 100 + bounds.x, |
| proportion.y * bounds.height / 100 + bounds.y, |
| proportion.width * bounds.width / 100, |
| proportion.height * bounds.height / 100); |
| } |
| rectangles = newRects; |
| } |
| |
| /** |
| * Sets the <code>Cursor</code> of the Tracker. If this cursor is <code>null</code> |
| * then the cursor reverts to the default. |
| * |
| * @param newCursor the new <code>Cursor</code> to display |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public void setCursor (Cursor value) { |
| checkWidget (); |
| } |
| |
| /** |
| * Specifies the rectangles that should be drawn, expressed relative to the parent |
| * widget. If the parent is a Display then these are screen coordinates. |
| * |
| * @param rectangles the bounds of the rectangles to be drawn |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public void setRectangles (Rectangle [] rectangles) { |
| checkWidget (); |
| this.rectangles = rectangles; |
| proportions = computeProportions (rectangles); |
| } |
| |
| /** |
| * Changes the appearance of the line used to draw the rectangles. |
| * |
| * @param stippled <code>true</code> if rectangle should appear stippled |
| * |
| * @exception SWTException <ul> |
| * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |
| * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> |
| * </ul> |
| */ |
| public void setStippled (boolean stippled) { |
| checkWidget (); |
| this.stippled = stippled; |
| } |
| } |