001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: /**
043: *
044: * $Id$ $Revision$ $Date$
045: *
046: */package org.netbeans.modules.visualweb.gravy;
047:
048: import java.awt.Color;
049: import java.awt.Dimension;
050: import java.awt.Graphics;
051: import java.awt.Component;
052: import java.awt.Point;
053: import javax.swing.JDialog;
054: import javax.swing.JFrame;
055: import javax.swing.JLayeredPane;
056: import javax.swing.JPanel;
057: import javax.swing.SwingUtilities;
058:
059: import org.netbeans.jemmy.operators.ComponentOperator;
060: import org.netbeans.jemmy.JemmyException;
061: import org.netbeans.jemmy.JemmyProperties;
062: import org.netbeans.jemmy.Timeoutable;
063: import org.netbeans.jemmy.Timeouts;
064:
065: /**
066: * Flasher is a utility class allowing to highlight special point by drawing a cross with
067: * this point as center. It can be useful when it's necessary to see where is given point situated
068: * @version 1.0 Mar 15, 2005
069: */
070: public class Flasher implements Timeoutable {
071:
072: /**
073: * Default color of the cross. Now it's red.
074: */
075: public static final Color DEFAULT_COLOR = new Color(255, 0, 0);
076: protected static final int len = 30;
077: protected Color color = DEFAULT_COLOR;
078: protected static long WAIT_TIME = 1000;
079:
080: /**
081: * By default, flash is executed in the main thread
082: */
083: protected boolean separateThread = false;
084: protected Timeouts timeouts;
085:
086: static {
087: Timeouts.initDefault("Flasher.FlashTimeout", WAIT_TIME);
088: }
089:
090: public void setTimeouts(Timeouts timeouts) {
091: this .timeouts = timeouts;
092: }
093:
094: public Timeouts getTimeouts() {
095: return timeouts;
096: }
097:
098: /**
099: * Constructs new object ready for flashing
100: */
101: public Flasher() {
102: this (false);
103: }
104:
105: /**
106: * Constructs new object ready for flashing
107: * @param separateThread If true, flash will be started in separate thread
108: * and test execution continues without delay
109: */
110: public Flasher(boolean separateThread) {
111: this .separateThread = separateThread;
112: setTimeouts(JemmyProperties.getProperties().getTimeouts());
113: }
114:
115: /**
116: * Sets color of the cross. Must be used before flash() call
117: * @param color New color
118: */
119: public void setColor(Color color) {
120: this .color = color;
121: }
122:
123: /**
124: * Draws a cross with center in specified point of component
125: * Delays by "Flasher.FlashTimeout" timeout, then cross disappears
126: * @param p Center of the cross
127: * @param op Operator for parent component of the point
128: */
129: public void flash(ComponentOperator op, Point p) {
130: flash(op.getSource(), p);
131: }
132:
133: /**
134: * Draws a cross with center in specified point of component
135: * Delays by "Flasher.FlashTimeout" timeout, then cross disappears
136: * @param x x-coordinate of center of the cross
137: * @param y x-coordinate of center of the cross
138: * @param op Operator for parent component of the point
139: */
140: public void flash(ComponentOperator op, int x, int y) {
141: flash(op.getSource(), x, y);
142: }
143:
144: /**
145: * Draws a cross with center in specified point of component
146: * Delays by "Flasher.FlashTimeout" timeout, then cross disappears
147: * @param x x-coordinate of center of the cross
148: * @param y x-coordinate of center of the cross
149: * @param comp Parent component of the point
150: */
151: public void flash(Component comp, int x, int y) {
152: flash(comp, new Point(x, y));
153: }
154:
155: /**
156: * Draws a cross with center in specified point of component
157: * Delays by "Flasher.FlashTimeout" timeout, then cross disappears
158: * @param p Center of the cross
159: * @param comp Parent component of the point
160: */
161: public void flash(final Component comp, final Point p) {
162:
163: if (separateThread) {
164: new Thread(new Runnable() {
165: public void run() {
166: doFlash(comp, p);
167: }
168: }).start();
169: } else {
170: doFlash(comp, p);
171: }
172: }
173:
174: /**
175: * Draws a cross. Called from flash() in the main thread or in a
176: * separate thread depending on separateThread field value
177: */
178: protected void doFlash(Component comp, Point p) {
179:
180: // we need to find JDialog or JFrame ancestor to use JLayeredPane
181: JFrame f;
182: JDialog d;
183: JLayeredPane lpane = null;
184: if (comp instanceof JDialog) {
185: lpane = ((JDialog) comp).getLayeredPane();
186: } else if (comp instanceof JFrame) {
187: lpane = ((JFrame) comp).getLayeredPane();
188: } else if ((d = (JDialog) SwingUtilities.getAncestorOfClass(
189: JDialog.class, comp)) != null) {
190: lpane = d.getLayeredPane();
191: } else if ((f = (JFrame) SwingUtilities.getAncestorOfClass(
192: JFrame.class, comp)) != null) {
193: lpane = f.getLayeredPane();
194: } else {
195: throw new JemmyException(
196: "Containing dialog or frame not found");
197: }
198: Point p1 = new Point(p.x + comp.getLocationOnScreen().x
199: - lpane.getLocationOnScreen().x, p.y
200: + comp.getLocationOnScreen().y
201: - lpane.getLocationOnScreen().y);
202: JPanel flash = new FlashPane(p1, lpane.getSize());
203: lpane.add(flash, JLayeredPane.DRAG_LAYER);
204: lpane.repaint();
205: try {
206: Thread.currentThread().sleep(
207: timeouts.getTimeout("Flasher.FlashTimeout"));
208: } catch (InterruptedException e) {
209: }
210: lpane.remove(flash);
211: lpane.repaint();
212: }
213:
214: protected class FlashPane extends JPanel {
215:
216: private Point p;
217:
218: public FlashPane(Point p, Dimension d) {
219: super ();
220: this .p = p;
221: setSize(d);
222: setOpaque(false);
223: }
224:
225: public synchronized void paint(Graphics g) {
226: super.paint(g);
227: g.setColor(color);
228: g.drawLine(p.x - len, p.y, p.x + len, p.y);
229: g.drawLine(p.x, p.y - len, p.x, p.y + len);
230: }
231: }
232: }
|