net.sf.cuf.ui.table

Class GuiUtilities

java.lang.Object

net.sf.cuf.ui.table.GuiUtilities

public class GuiUtilities
extends Object

Utility functions for better UI programming. Currently this class offers the following features:

• adjusting the position of popup menus

Multiple instances of this class may exist. One of these instances is the default instance managed by this class.

Author:

Hendrik Wördehoff, sd&m AG

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mPopupAdjustmentStrategy Current adjustment strategy for popup menus.
static int	POPUP_ADJUSTMENT_STRATEGY_FLIP Flip the popup menu to the other side of the mouse coursor.
static int	POPUP_ADJUSTMENT_STRATEGY_MOVE Move the popup menu a little bit to keep it on the screen.

Constructor Summary

Constructors

Constructor and Description
GuiUtilities()

Method Summary

Methods

Modifier and Type	Method and Description
Point	adjustPopupPosition(JPopupMenu popup, Component pInvoker, Point pPosition) Adjust the position of a popup so that it will be displayed in the visible screen area.
protected Rectangle	determineVisibleScreenArea() Determine the visible screen area.
static GuiUtilities	getDefault() Get the default instance.
int	getPopupAdjustmentStrategy() Get the popup adjustment strategy.
protected static void	setDefault(GuiUtilities pInstance) Install a new default instance.
void	setPopupAdjustmentStrategy(int pStrategy) Set the popup adjustment strategy.
void	showPopupAdjusted(JPopupMenu popup, Component pInvoker, Point pPosition) Adjust the position of a popup and show it.

Methods inherited from class java.lang.Object

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

Field Detail

POPUP_ADJUSTMENT_STRATEGY_MOVE

public static final int POPUP_ADJUSTMENT_STRATEGY_MOVE

Move the popup menu a little bit to keep it on the screen.

See Also:

Constant Field Values

POPUP_ADJUSTMENT_STRATEGY_FLIP

public static final int POPUP_ADJUSTMENT_STRATEGY_FLIP

Flip the popup menu to the other side of the mouse coursor.

See Also:

Constant Field Values

mPopupAdjustmentStrategy

protected int mPopupAdjustmentStrategy

Current adjustment strategy for popup menus. Valid values are POPUP_ADJUSTMENT_STRATEGY_MOVE (default) and POPUP_ADJUSTMENT_STRATEGY_FLIP.

Constructor Detail

GuiUtilities

public GuiUtilities()

Method Detail

getDefault

public static GuiUtilities getDefault()

Get the default instance.

Returns:

current default instance

setDefault

protected static void setDefault(GuiUtilities pInstance)

Install a new default instance. Derived classes may use this hook to install themselves as the default instance.

Parameters:

pInstance - new default instance, may be null

getPopupAdjustmentStrategy

public int getPopupAdjustmentStrategy()

Get the popup adjustment strategy.

Returns:

POPUP_ADJUSTMENT_STRATEGY_MOVE or POPUP_ADJUSTMENT_STRATEGY_FLIP

setPopupAdjustmentStrategy

public void setPopupAdjustmentStrategy(int pStrategy)

Set the popup adjustment strategy.

Parameters:

pStrategy - POPUP_ADJUSTMENT_STRATEGY_MOVE or POPUP_ADJUSTMENT_STRATEGY_FLIP

Throws:

IllegalArgumentException - if the value strategy is not supported

adjustPopupPosition

public Point adjustPopupPosition(JPopupMenu popup,
                        Component pInvoker,
                        Point pPosition)

Adjust the position of a popup so that it will be displayed in the visible screen area.

Parameters:

popup - popup whose position has to be adjusted

pInvoker - "invoker" of popup

pPosition - proposed position for popup relative to invoker (should be the mouse cursor position)

Returns:

adjusted position relative to invoker

showPopupAdjusted

public void showPopupAdjusted(JPopupMenu popup,
                     Component pInvoker,
                     Point pPosition)

Adjust the position of a popup and show it.

Parameters:

popup - popup whose position has to be adjusted

pInvoker - "invoker" of popup

pPosition - proposed position for popup relative to invoker (should be the mouse cursor position)

determineVisibleScreenArea

protected Rectangle determineVisibleScreenArea()

Determine the visible screen area. With this hook taksbars and other things obscuring the screen can be taken in account.

Returns:

rectangle of visible screen area