maspack.widgets

Class GuiUtils

java.lang.Object

maspack.widgets.GuiUtils

public class GuiUtils
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GuiUtils.RelativeLocation

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABOVE Place one component above another.
static int	BELOW Place one component below another.
static int	CENTER Align centers.
static int	LEFT Place one component completely to the left of another.
static int	RIGHT Place one component completely to the right of another.

Method Summary

Modifier and Type	Method and Description
static javax.swing.JButton	addHorizontalButton(javax.swing.JComponent comp, java.lang.String cmd, java.awt.event.ActionListener listener, java.lang.String toolTip) Creates a horizontal button and adds it to a JComponent.
static javax.swing.JButton	addVerticalButton(javax.swing.JComponent comp, java.lang.String cmd, java.awt.event.ActionListener listener, java.lang.String toolTip) Creates a vertical button and adds it to a JComponent.
static boolean	confirmAction(java.awt.Component comp, java.lang.String msg)
static boolean	confirmOverwrite(java.awt.Component comp, java.io.File file)
static boolean	containsComponent(java.awt.Container parent, java.awt.Component comp)
static boolean	containsMenuComponent(javax.swing.JMenu parent, java.awt.Component comp)
static java.awt.Component	createBoxFiller()
static javax.swing.JButton	createHorizontalButton(java.lang.String cmd, java.awt.event.ActionListener listener, java.lang.String toolTip) Create a button to be arranged horizontally within a panel (such as the "Cancel", "Done" buttons at the bottom of a dialog.
static javax.swing.JMenuItem	createMenuItem(java.awt.event.ActionListener listener, java.lang.String cmd, java.lang.String toolTip)
static javax.swing.border.TitledBorder	createTitledPanelBorder(java.lang.String title)
static javax.swing.JButton	createVerticalButton(java.lang.String cmd, java.awt.event.ActionListener listener, java.lang.String toolTip) Creates a button to be arranged vertically in JComponent.
static java.awt.Dimension	getMaxPreferredSize(java.util.Collection<? extends javax.swing.JComponent> comps) Returns the maximum dimension for a set of components.
static java.awt.Rectangle	getScreenBounds(java.awt.Component ref) Gets the current screen bounds of a component.
static java.awt.Point	getScreenLocation(java.awt.Component ref, double xr, double yr) Gets the current screen location of a specified point within a reference component.
static java.awt.Rectangle	getVirtualScreenBounds()
static void	growSize(java.awt.Dimension size0, java.awt.Dimension size1) Grow size0 as needed to to accommodate size1
static int	indexOfComponent(java.awt.Container parent, java.awt.Component comp)
static int	indexOfMenuComponent(javax.swing.JMenu parent, java.awt.Component comp)
static javax.swing.ImageIcon	loadIcon(java.lang.Object ref, java.lang.String path)
static javax.swing.ImageIcon	loadIcon(java.lang.String fullpath)
static void	locateAbove(java.awt.Window win, java.awt.Component ref) Locates a window above the window containing a specified reference component.
static void	locateBelow(java.awt.Window win, java.awt.Component ref) Locates a window below the window containing a specified reference component.
static void	locateCenter(java.awt.Window win, java.awt.Component ref) Center a window on the window containing a specified reference component.
static void	locateHorizontally(java.awt.Window win, java.awt.Component ref, int location) Sets the horizonal position of a window relative to another component.
static void	locateLeft(java.awt.Window win, java.awt.Component ref) Locates a window to the left of the window containing a specified reference component.
static void	locateRelative(java.awt.Window win, java.awt.Component ref, GuiUtils.RelativeLocation loc) Locates a window relative to the window containing a specific component.
static void	locateRelative(java.awt.Window win, java.awt.Component ref, GuiUtils.RelativeLocation hloc, GuiUtils.RelativeLocation vloc) Locates a window relative to a reference window containing a specific component.
static void	locateRelative(java.awt.Window win, java.awt.Rectangle bounds, double px, double py, double wx, double wy) Locates a window relative to a given set of screen bounds.
static void	locateRight(java.awt.Window win, java.awt.Component ref) Locates a window to the right of the window containing a specified reference component.
static void	locateVertically(java.awt.Window win, java.awt.Component ref, int location) Sets the vertical position of a window relative to another component.
static void	repackComponentWindow(java.awt.Component c)
static void	setFixedHeight(java.awt.Component comp, int h) Sets the height of a component to a rigidly fixed value
static void	setFixedSize(java.util.Collection<? extends javax.swing.JComponent> comps, java.awt.Dimension size) Sets the size of a set of components to be as rigidly fixed as we possibly can.
static void	setFixedSize(java.awt.Component comp, java.awt.Dimension size) Sets the size of a component to be as rigidly fixed as we possibly can.
static void	setFixedSize(java.awt.Component comp, int w, int h) Sets the size of a component to be a rigidly fixed as we possibly can.
static void	setFixedWidth(java.awt.Component comp, int w) Sets the width of a component to a rigidly fixed value
static void	setItalicFont(javax.swing.JComponent jcomp)
static void	showError(java.awt.Component comp, java.lang.String msg)
static void	showError(java.awt.Component comp, java.lang.String msg, java.lang.Exception e)
static void	showNotice(java.awt.Component comp, java.lang.String msg)
static void	showResult(java.awt.Component comp, java.lang.String msg)
static void	showWarning(java.awt.Component comp, java.lang.String msg)

Methods inherited from class java.lang.Object

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

Field Detail

CENTER

public static final int CENTER

Align centers.

See Also:

Constant Field Values

LEFT

public static final int LEFT

Place one component completely to the left of another.

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

Place one component completely to the right of another.

See Also:

Constant Field Values

ABOVE

public static final int ABOVE

Place one component above another.

See Also:

Constant Field Values

BELOW

public static final int BELOW

Place one component below another.

See Also:

Constant Field Values

Method Detail

growSize

public static void growSize(java.awt.Dimension size0,
                            java.awt.Dimension size1)

Grow size0 as needed to to accommodate size1

getMaxPreferredSize

public static java.awt.Dimension getMaxPreferredSize(java.util.Collection<? extends javax.swing.JComponent> comps)

Returns the maximum dimension for a set of components.

setFixedSize

public static void setFixedSize(java.util.Collection<? extends javax.swing.JComponent> comps,
                                java.awt.Dimension size)

Sets the size of a set of components to be as rigidly fixed as we possibly can.

setFixedSize

public static void setFixedSize(java.awt.Component comp,
                                java.awt.Dimension size)

Sets the size of a component to be as rigidly fixed as we possibly can.

setFixedSize

public static void setFixedSize(java.awt.Component comp,
                                int w,
                                int h)

Sets the size of a component to be a rigidly fixed as we possibly can.

setFixedWidth

public static void setFixedWidth(java.awt.Component comp,
                                 int w)

Sets the width of a component to a rigidly fixed value

setFixedHeight

public static void setFixedHeight(java.awt.Component comp,
                                  int h)

Sets the height of a component to a rigidly fixed value

createBoxFiller

public static java.awt.Component createBoxFiller()

getScreenLocation

public static java.awt.Point getScreenLocation(java.awt.Component ref,
                                               double xr,
                                               double yr)

Gets the current screen location of a specified point within a reference component. This can then be used for positioning windows relative to that component. The location of the point relative to the component is specified using coordinates xr and yr. These are normalized for the component's size, so that (0,0) indicates the top left, (1,1) indicates the lower right, etc.

Parameters:

ref - reference component

xr - normalized horizontal point location

yr - normalized vertical point location

Returns:

point location in screen coordinates

getScreenBounds

public static java.awt.Rectangle getScreenBounds(java.awt.Component ref)

Gets the current screen bounds of a component.

locateHorizontally

public static void locateHorizontally(java.awt.Window win,
                                      java.awt.Component ref,
                                      int location)

Sets the horizonal position of a window relative to another component. The vertical position is unchanged. The relative location is specified by either LEFT, RIGHT, or CENTER. This placement may be altered in order to keep the window on the screen.

Parameters:

win - window to be located

ref - reference component

location - desired horizonal location of the window relative to the component

locateVertically

public static void locateVertically(java.awt.Window win,
                                    java.awt.Component ref,
                                    int location)

Sets the vertical position of a window relative to another component. The horizontal position is unchanged. The relative location is specified by either ABOVE, BELOW, or CENTER. This placement may be altered in order to keep the window on the screen.

Parameters:

win - window to be located

ref - reference component

location - desired horizonal location of the window relative to the component

locateRelative

public static void locateRelative(java.awt.Window win,
                                  java.awt.Rectangle bounds,
                                  double px,
                                  double py,
                                  double wx,
                                  double wy)

Locates a window relative to a given set of screen bounds. The location is set so that point (wx, wy) in the window maps to point (bx, by) in the bounds. Both sets of points are normalized to relative to the window and bounds sizes, so that (0, 0) corresponds to the upper left corner, (0.5, 0.5) is the center, (1, 1) is the lower right, etc.

locateRelative

public static void locateRelative(java.awt.Window win,
                                  java.awt.Component ref,
                                  GuiUtils.RelativeLocation loc)

Locates a window relative to the window containing a specific component.

Parameters:

win - window to be located

ref - reference component contained by the reference window

loc - desired relative location of win with respect to the reference window.

locateRelative

public static void locateRelative(java.awt.Window win,
                                  java.awt.Component ref,
                                  GuiUtils.RelativeLocation hloc,
                                  GuiUtils.RelativeLocation vloc)

Locates a window relative to a reference window containing a specific component. Location alignment can be optionally specified along each of the horizontal and vertical axes. When alignment is not specified, the x or y location of the window is set to that of the reference window.

Parameters:

win - window to be located

ref - reference component contained by the reference window

hloc - if non-null, gives the desired relative horizontal location of win with respect to the reference window. Must be GuiUtils.RelativeLocation.LEFT, GuiUtils.RelativeLocation.RIGHT, or GuiUtils.RelativeLocation.CENTER.

vloc - if non-null, gives the desired relative vertical location of win with respect to the reference window. Must be GuiUtils.RelativeLocation.ABOVE, GuiUtils.RelativeLocation.BELOW, or GuiUtils.RelativeLocation.CENTER.

locateCenter

public static void locateCenter(java.awt.Window win,
                                java.awt.Component ref)

Center a window on the window containing a specified reference component.

locateRight

public static void locateRight(java.awt.Window win,
                               java.awt.Component ref)

Locates a window to the right of the window containing a specified reference component. The top edges of the window and the reference component are aligned. Final placement may be altered slightly to keep the window fully on the screen.

locateLeft

public static void locateLeft(java.awt.Window win,
                              java.awt.Component ref)

Locates a window to the left of the window containing a specified reference component. The top edges of the window and the reference component are aligned. Final placement may be altered slightly to keep the window fully on the screen.

locateAbove

public static void locateAbove(java.awt.Window win,
                               java.awt.Component ref)

Locates a window above the window containing a specified reference component. The left edges of the window and the reference component are aligned. Final placement may be altered slightly to keep the window fully on the screen.

locateBelow

public static void locateBelow(java.awt.Window win,
                               java.awt.Component ref)

Locates a window below the window containing a specified reference component. The left edges of the window and the reference component are aligned. Final placement may be altered slightly to keep the window fully on the screen.

getVirtualScreenBounds

public static java.awt.Rectangle getVirtualScreenBounds()

loadIcon

public static javax.swing.ImageIcon loadIcon(java.lang.Object ref,
                                             java.lang.String path)

loadIcon

public static javax.swing.ImageIcon loadIcon(java.lang.String fullpath)

indexOfComponent

public static int indexOfComponent(java.awt.Container parent,
                                   java.awt.Component comp)

containsComponent

public static boolean containsComponent(java.awt.Container parent,
                                        java.awt.Component comp)

indexOfMenuComponent

public static int indexOfMenuComponent(javax.swing.JMenu parent,
                                       java.awt.Component comp)

containsMenuComponent

public static boolean containsMenuComponent(javax.swing.JMenu parent,
                                            java.awt.Component comp)

setItalicFont

public static void setItalicFont(javax.swing.JComponent jcomp)

repackComponentWindow

public static void repackComponentWindow(java.awt.Component c)

createTitledPanelBorder

public static javax.swing.border.TitledBorder createTitledPanelBorder(java.lang.String title)

createMenuItem

public static javax.swing.JMenuItem createMenuItem(java.awt.event.ActionListener listener,
                                                   java.lang.String cmd,
                                                   java.lang.String toolTip)

showError

public static void showError(java.awt.Component comp,
                             java.lang.String msg)

showError

public static void showError(java.awt.Component comp,
                             java.lang.String msg,
                             java.lang.Exception e)

showWarning

public static void showWarning(java.awt.Component comp,
                               java.lang.String msg)

showNotice

public static void showNotice(java.awt.Component comp,
                              java.lang.String msg)

showResult

public static void showResult(java.awt.Component comp,
                              java.lang.String msg)

confirmAction

public static boolean confirmAction(java.awt.Component comp,
                                    java.lang.String msg)

confirmOverwrite

public static boolean confirmOverwrite(java.awt.Component comp,
                                       java.io.File file)

createHorizontalButton

public static javax.swing.JButton createHorizontalButton(java.lang.String cmd,
                                                         java.awt.event.ActionListener listener,
                                                         java.lang.String toolTip)

Create a button to be arranged horizontally within a panel (such as the "Cancel", "Done" buttons at the bottom of a dialog.

Parameters:

cmd - name and command associated with the button

listener - action listener for the button command

toolTip - if not null, specifies tool tip text

Returns:

created button

addHorizontalButton

public static javax.swing.JButton addHorizontalButton(javax.swing.JComponent comp,
                                                      java.lang.String cmd,
                                                      java.awt.event.ActionListener listener,
                                                      java.lang.String toolTip)

Creates a horizontal button and adds it to a JComponent.

Parameters:

comp - component to which the button should be added

cmd - name and command associated with the button

listener - action listener for the button command

toolTip - if not null, specifies tool tip text

Returns:

created button

createVerticalButton

public static javax.swing.JButton createVerticalButton(java.lang.String cmd,
                                                       java.awt.event.ActionListener listener,
                                                       java.lang.String toolTip)

Creates a button to be arranged vertically in JComponent.

Parameters:

cmd - name and command associated with the button

listener - action listener for the button command

toolTip - if not null, specifies tool tip text

Returns:

created button

addVerticalButton

public static javax.swing.JButton addVerticalButton(javax.swing.JComponent comp,
                                                    java.lang.String cmd,
                                                    java.awt.event.ActionListener listener,
                                                    java.lang.String toolTip)

Creates a vertical button and adds it to a JComponent.

Parameters:

comp - component to which the button should be added

cmd - name and command associated with the button

listener - action listener for the button command

toolTip - if not null, specifies tool tip text

Returns:

created button