org.jfree.ui
Class RefineryUtilities

java.lang.Object
  org.jfree.ui.RefineryUtilities

public class RefineryUtilities

extends java.lang.Object

A collection of utility methods relating to user interfaces.

Author:

David Gilbert

Constructor Summary

RefineryUtilities()

Method Summary

static void	centerDialogInParent(java.awt.Dialog dialog) Positions the specified dialog within its parent.
static void	centerFrameOnScreen(java.awt.Window frame) Positions the specified frame in the middle of the screen.
static javax.swing.JButton	createJButton(java.lang.String label, java.awt.Font font) Creates a JButton.
static javax.swing.JLabel	createJLabel(java.lang.String text, java.awt.Font font) Creates a label with a specific font.
static javax.swing.JLabel	createJLabel(java.lang.String text, java.awt.Font font, java.awt.Color color) Creates a label with a specific font and color.
static javax.swing.JPanel	createTablePanel(javax.swing.table.TableModel model) Creates a panel that contains a table based on the specified table model.
static void	drawAlignedString(java.lang.String text, java.awt.Graphics2D g2, float x, float y, TextAnchor anchor) Draws a string that is aligned by an anchor point.
static void	drawRotatedShape(java.awt.Shape shape, java.awt.Graphics2D g2, float x, float y, double angle) Draws a rotated shape.
static void	drawRotatedString(java.lang.String text, java.awt.Graphics2D g2, float x, float y, double angle) A utility method for drawing rotated text.
static void	drawRotatedString(java.lang.String text, java.awt.Graphics2D g2, float textX, float textY, double angle, float rotateX, float rotateY) A utility method for drawing rotated text.
static void	drawRotatedString(java.lang.String text, java.awt.Graphics2D g2, float x, float y, TextAnchor textAnchor, TextAnchor rotationAnchor, double angle) Draws a string that is aligned by one anchor point and rotated about another anchor point.
static java.awt.geom.Point2D	getPointInRectangle(double x, double y, java.awt.geom.Rectangle2D area) Returns a point based on (x, y) but constrained to be within the bounds of a given rectangle.
static void	positionDialogRelativeToParent(java.awt.Dialog dialog, double horizontalPercent, double verticalPercent) Positions the specified dialog at a position relative to its parent.
static void	positionFrameOnScreen(java.awt.Window frame, double horizontalPercent, double verticalPercent) Positions the specified frame at a relative position in the screen, where 50% is considered to be the center of the screen.
static void	positionFrameRandomly(java.awt.Window frame) Positions the specified frame at a random location on the screen while ensuring that the entire frame is visible (provided that the frame is smaller than the screen).
static void	setUseDrawRotatedStringWorkaround(boolean use) Sets the flag that controls whether or not the rotated string workaround is used.

Methods inherited from class java.lang.Object

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

Constructor Detail

RefineryUtilities

public RefineryUtilities()

Method Detail

setUseDrawRotatedStringWorkaround

public static void setUseDrawRotatedStringWorkaround(boolean use)

Sets the flag that controls whether or not the rotated string workaround is used.

Parameters:

use - the new flag value.

centerFrameOnScreen

public static void centerFrameOnScreen(java.awt.Window frame)

Positions the specified frame in the middle of the screen.

Parameters:

frame - the frame to be centered on the screen.

positionFrameOnScreen

public static void positionFrameOnScreen(java.awt.Window frame,
                                         double horizontalPercent,
                                         double verticalPercent)

Positions the specified frame at a relative position in the screen, where 50% is considered to be the center of the screen.

Parameters:

frame - the frame.

horizontalPercent - the relative horizontal position of the frame (0.0 to 1.0, where 0.5 is the center of the screen).

verticalPercent - the relative vertical position of the frame (0.0 to 1.0, where 0.5 is the center of the screen).

positionFrameRandomly

public static void positionFrameRandomly(java.awt.Window frame)

Positions the specified frame at a random location on the screen while ensuring that the entire frame is visible (provided that the frame is smaller than the screen).

Parameters:

frame - the frame.

centerDialogInParent

public static void centerDialogInParent(java.awt.Dialog dialog)

Positions the specified dialog within its parent.

Parameters:

dialog - the dialog to be positioned on the screen.

positionDialogRelativeToParent

public static void positionDialogRelativeToParent(java.awt.Dialog dialog,
                                                  double horizontalPercent,
                                                  double verticalPercent)

Positions the specified dialog at a position relative to its parent.

Parameters:

dialog - the dialog to be positioned.

horizontalPercent - the relative location.

verticalPercent - the relative location.

createTablePanel

public static javax.swing.JPanel createTablePanel(javax.swing.table.TableModel model)

Creates a panel that contains a table based on the specified table model.

Parameters:

model - the table model to use when constructing the table.

Returns:

the panel.

createJLabel

public static javax.swing.JLabel createJLabel(java.lang.String text,
                                              java.awt.Font font)

Creates a label with a specific font.

Parameters:

text - the text for the label.

font - the font.

Returns:

the label.

createJLabel

public static javax.swing.JLabel createJLabel(java.lang.String text,
                                              java.awt.Font font,
                                              java.awt.Color color)

Creates a label with a specific font and color.

Parameters:

text - the text for the label.

font - the font.

color - the color.

Returns:

the label.

createJButton

public static javax.swing.JButton createJButton(java.lang.String label,
                                                java.awt.Font font)

Creates a JButton.

Parameters:

label - the label.

font - the font.

Returns:

the button.

drawAlignedString

public static void drawAlignedString(java.lang.String text,
                                     java.awt.Graphics2D g2,
                                     float x,
                                     float y,
                                     TextAnchor anchor)

Draws a string that is aligned by an anchor point.

Parameters:

text - the text.

g2 - the graphics device.

x - the x coordinate (Java 2D).

y - the y coordinate (Java 2D).

anchor - the anchor location.

drawRotatedString

public static void drawRotatedString(java.lang.String text,
                                     java.awt.Graphics2D g2,
                                     float x,
                                     float y,
                                     TextAnchor textAnchor,
                                     TextAnchor rotationAnchor,
                                     double angle)

Draws a string that is aligned by one anchor point and rotated about another anchor point.

Parameters:

text - the text.

g2 - the graphics device.

x - the location of the text anchor.

y - the location of the text anchor.

textAnchor - the text anchor.

rotationAnchor - the rotation anchor.

angle - the rotation angle.

drawRotatedString

public static void drawRotatedString(java.lang.String text,
                                     java.awt.Graphics2D g2,
                                     float x,
                                     float y,
                                     double angle)

A utility method for drawing rotated text.

A common rotation is -Math.PI/2 which draws text 'vertically' (with the top of the characters on the left).

Parameters:

text - the text.

g2 - the graphics device.

x - the x-coordinate.

y - the y-coordinate.

angle - the angle of the (clockwise) rotation (in radians).

drawRotatedString

public static void drawRotatedString(java.lang.String text,
                                     java.awt.Graphics2D g2,
                                     float textX,
                                     float textY,
                                     double angle,
                                     float rotateX,
                                     float rotateY)

A utility method for drawing rotated text.

A common rotation is -Math.PI/2 which draws text 'vertically' (with the top of the characters on the left).

Parameters:

text - the text.

g2 - the graphics device.

textX - the x-coordinate for the text (before rotation).

textY - the y-coordinate for the text (before rotation).

angle - the angle of the (clockwise) rotation (in radians).

rotateX - the point about which the text is rotated.

rotateY - the point about which the text is rotated.

drawRotatedShape

public static void drawRotatedShape(java.awt.Shape shape,
                                    java.awt.Graphics2D g2,
                                    float x,
                                    float y,
                                    double angle)

Draws a rotated shape.

Parameters:

shape - the shape.

g2 - the graphics device.

x - the x coordinate for the rotation point.

y - the y coordinate for the rotation point.

angle - the angle.

getPointInRectangle

public static java.awt.geom.Point2D getPointInRectangle(double x,
                                                        double y,
                                                        java.awt.geom.Rectangle2D area)

Returns a point based on (x, y) but constrained to be within the bounds of a given rectangle.

Parameters:

x - the x-coordinate.

y - the y-coordinate.

area - the constraining rectangle.

Returns:

a point within the rectangle.