001 /* ========================================================================
002 * JCommon : a free general purpose class library for the Java(tm) platform
003 * ========================================================================
004 *
005 * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
006 *
007 * Project Info: http://www.jfree.org/jcommon/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
022 * USA.
023 *
024 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
025 * in the United States and other countries.]
026 *
027 * ----------------------
028 * RefineryUtilities.java
029 * ----------------------
030 * (C) Copyright 2000-2005, by Object Refinery Limited.
031 *
032 * Original Author: David Gilbert (for Object Refinery Limited);
033 * Contributor(s): Jon Iles;
034 *
035 * $Id: RefineryUtilities.java,v 1.10 2007/05/21 17:13:59 taqua Exp $
036 *
037 * Changes (from 26-Oct-2001)
038 * --------------------------
039 * 26-Oct-2001 : Changed package to com.jrefinery.ui.*;
040 * 26-Nov-2001 : Changed name to SwingRefinery.java to make it obvious that this is not part of
041 * the Java APIs (DG);
042 * 10-Dec-2001 : Changed name (again) to JRefineryUtilities.java (DG);
043 * 28-Feb-2002 : Moved system properties classes into com.jrefinery.ui.about (DG);
044 * 19-Apr-2002 : Renamed JRefineryUtilities-->RefineryUtilities. Added drawRotatedString()
045 * method (DG);
046 * 21-May-2002 : Changed frame positioning methods to accept Window parameters, as suggested by
047 * Laurence Vanhelsuwe (DG);
048 * 27-May-2002 : Added getPointInRectangle method (DG);
049 * 26-Jun-2002 : Removed unnecessary imports (DG);
050 * 12-Jul-2002 : Added workaround for rotated text (JI);
051 * 14-Oct-2002 : Fixed errors reported by Checkstyle (DG);
052 * 08-May-2003 : Added a new drawRotatedString() method (DG);
053 * 09-May-2003 : Added a drawRotatedShape() method (DG);
054 * 10-Jun-2003 : Updated aligned and rotated string methods (DG);
055 * 29-Oct-2003 : Added workaround for font alignment in PDF output (DG);
056 * 07-Nov-2003 : Added rotateShape() method (DG);
057 * 16-Mar-2004 : Moved rotateShape() method to ShapeUtils.java (DG);
058 * 07-Apr-2004 : Modified text bounds calculation with TextUtilities.getTextBounds() (DG);
059 * 21-May-2004 : Fixed bug 951870 - precision in drawAlignedString() method (DG);
060 * 30-Sep-2004 : Deprecated and moved a number of methods to the TextUtilities class (DG);
061 * 04-Oct-2004 : Renamed ShapeUtils --> ShapeUtilities (DG);
062 * 11-Jan-2005 : Removed deprecated code in preparation for the 1.0.0 release (DG);
063 *
064 */
065
066 package org.jfree.ui;
067
068 import java.awt.BorderLayout;
069 import java.awt.Color;
070 import java.awt.Container;
071 import java.awt.Dialog;
072 import java.awt.Dimension;
073 import java.awt.Font;
074 import java.awt.Toolkit;
075 import java.awt.Window;
076 import java.awt.Point;
077 import java.awt.GraphicsEnvironment;
078 import java.awt.Rectangle;
079 import java.lang.reflect.Method;
080
081 import javax.swing.JButton;
082 import javax.swing.JLabel;
083 import javax.swing.JPanel;
084 import javax.swing.JScrollPane;
085 import javax.swing.JTable;
086 import javax.swing.table.TableColumn;
087 import javax.swing.table.TableModel;
088
089 /**
090 * A collection of utility methods relating to user interfaces.
091 *
092 * @author David Gilbert
093 */
094 public class RefineryUtilities {
095
096 private RefineryUtilities() {
097 }
098
099 /** Access to logging facilities. */
100 // private static final LogContext logger = Log.createContext(RefineryUtilities.class);
101
102 /**
103 * Computes the center point of the current screen device. If this method is called on JDK 1.4, Xinerama-aware
104 * results are returned. (See Sun-Bug-ID 4463949 for details).
105 *
106 * @return the center point of the current screen.
107 */
108 public static Point getCenterPoint ()
109 {
110 final GraphicsEnvironment localGraphicsEnvironment = GraphicsEnvironment.getLocalGraphicsEnvironment();
111 try
112 {
113 final Method method = GraphicsEnvironment.class.getMethod("getCenterPoint", (Class[]) null);
114 return (Point) method.invoke(localGraphicsEnvironment, (Object[]) null);
115 }
116 catch(Exception e)
117 {
118 // ignore ... will fail if this is not a JDK 1.4 ..
119 }
120
121 final Dimension s = Toolkit.getDefaultToolkit().getScreenSize();
122 return new Point (s.width / 2, s.height / 2);
123 }
124
125 /**
126 * Computes the maximum bounds of the current screen device. If this method is called on JDK 1.4, Xinerama-aware
127 * results are returned. (See Sun-Bug-ID 4463949 for details).
128 *
129 * @return the maximum bounds of the current screen.
130 */
131 public static Rectangle getMaximumWindowBounds ()
132 {
133 final GraphicsEnvironment localGraphicsEnvironment = GraphicsEnvironment.getLocalGraphicsEnvironment();
134 try
135 {
136 final Method method = GraphicsEnvironment.class.getMethod("getMaximumWindowBounds", (Class[]) null);
137 return (Rectangle) method.invoke(localGraphicsEnvironment, (Object[]) null);
138 }
139 catch(Exception e)
140 {
141 // ignore ... will fail if this is not a JDK 1.4 ..
142 }
143
144 final Dimension s = Toolkit.getDefaultToolkit().getScreenSize();
145 return new Rectangle (0, 0, s.width, s.height);
146 }
147
148 /**
149 * Positions the specified frame in the middle of the screen.
150 *
151 * @param frame the frame to be centered on the screen.
152 */
153 public static void centerFrameOnScreen(final Window frame) {
154 positionFrameOnScreen(frame, 0.5, 0.5);
155 }
156
157 /**
158 * Positions the specified frame at a relative position in the screen, where 50% is considered
159 * to be the center of the screen.
160 *
161 * @param frame the frame.
162 * @param horizontalPercent the relative horizontal position of the frame (0.0 to 1.0,
163 * where 0.5 is the center of the screen).
164 * @param verticalPercent the relative vertical position of the frame (0.0 to 1.0, where
165 * 0.5 is the center of the screen).
166 */
167 public static void positionFrameOnScreen(final Window frame,
168 final double horizontalPercent,
169 final double verticalPercent) {
170
171 final Rectangle s = getMaximumWindowBounds();
172 final Dimension f = frame.getSize();
173 final int w = Math.max(s.width - f.width, 0);
174 final int h = Math.max(s.height - f.height, 0);
175 final int x = (int) (horizontalPercent * w) + s.x;
176 final int y = (int) (verticalPercent * h) + s.y;
177 frame.setBounds(x, y, f.width, f.height);
178
179 }
180
181 /**
182 * Positions the specified frame at a random location on the screen while ensuring that the
183 * entire frame is visible (provided that the frame is smaller than the screen).
184 *
185 * @param frame the frame.
186 */
187 public static void positionFrameRandomly(final Window frame) {
188 positionFrameOnScreen(frame, Math.random(), Math.random());
189 }
190
191 /**
192 * Positions the specified dialog within its parent.
193 *
194 * @param dialog the dialog to be positioned on the screen.
195 */
196 public static void centerDialogInParent(final Dialog dialog) {
197 positionDialogRelativeToParent(dialog, 0.5, 0.5);
198 }
199
200 /**
201 * Positions the specified dialog at a position relative to its parent.
202 *
203 * @param dialog the dialog to be positioned.
204 * @param horizontalPercent the relative location.
205 * @param verticalPercent the relative location.
206 */
207 public static void positionDialogRelativeToParent(final Dialog dialog,
208 final double horizontalPercent,
209 final double verticalPercent) {
210 final Dimension d = dialog.getSize();
211 final Container parent = dialog.getParent();
212 final Dimension p = parent.getSize();
213
214 final int baseX = parent.getX() - d.width;
215 final int baseY = parent.getY() - d.height;
216 final int w = d.width + p.width;
217 final int h = d.height + p.height;
218 int x = baseX + (int) (horizontalPercent * w);
219 int y = baseY + (int) (verticalPercent * h);
220
221 // make sure the dialog fits completely on the screen...
222 final Rectangle s = getMaximumWindowBounds();
223 x = Math.min(x, (s.width - d.width));
224 x = Math.max(x, 0);
225 y = Math.min(y, (s.height - d.height));
226 y = Math.max(y, 0);
227
228 dialog.setBounds(x + s.x, y + s.y, d.width, d.height);
229
230 }
231
232 /**
233 * Creates a panel that contains a table based on the specified table model.
234 *
235 * @param model the table model to use when constructing the table.
236 *
237 * @return The panel.
238 */
239 public static JPanel createTablePanel(final TableModel model) {
240
241 final JPanel panel = new JPanel(new BorderLayout());
242 final JTable table = new JTable(model);
243 for (int columnIndex = 0; columnIndex < model.getColumnCount(); columnIndex++) {
244 final TableColumn column = table.getColumnModel().getColumn(columnIndex);
245 final Class c = model.getColumnClass(columnIndex);
246 if (c.equals(Number.class)) {
247 column.setCellRenderer(new NumberCellRenderer());
248 }
249 }
250 panel.add(new JScrollPane(table));
251 return panel;
252
253 }
254
255 /**
256 * Creates a label with a specific font.
257 *
258 * @param text the text for the label.
259 * @param font the font.
260 *
261 * @return The label.
262 */
263 public static JLabel createJLabel(final String text, final Font font) {
264
265 final JLabel result = new JLabel(text);
266 result.setFont(font);
267 return result;
268
269 }
270
271 /**
272 * Creates a label with a specific font and color.
273 *
274 * @param text the text for the label.
275 * @param font the font.
276 * @param color the color.
277 *
278 * @return The label.
279 */
280 public static JLabel createJLabel(final String text, final Font font, final Color color) {
281
282 final JLabel result = new JLabel(text);
283 result.setFont(font);
284 result.setForeground(color);
285 return result;
286
287 }
288
289 /**
290 * Creates a {@link JButton}.
291 *
292 * @param label the label.
293 * @param font the font.
294 *
295 * @return The button.
296 */
297 public static JButton createJButton(final String label, final Font font) {
298
299 final JButton result = new JButton(label);
300 result.setFont(font);
301 return result;
302
303 }
304
305 }
306
307