org.openstreetmap.josm.gui.util

Class GuiHelper

java.lang.Object

org.openstreetmap.josm.gui.util.GuiHelper

public final class GuiHelper
extends Object

basic gui utils

Constructor Summary

Constructors

Modifier	Constructor and Description
private	GuiHelper()

Method Summary

Modifier and Type	Method and Description
static JScrollPane	embedInVerticalScrollPane(Component panel) Embeds the given component into a new vertical-only scrollable JScrollPane.
static void	executeByMainWorkerInEDT(Runnable task)
static Stroke	getCustomizedStroke(String code) Return s new BasicStroke object with given thickness and style
static ImageIcon	getDisabledIcon(ImageIcon icon) Replies the disabled (grayed) version of the specified icon.
static Image	getDisabledImage(Image image) Replies the disabled (grayed) version of the specified image.
static int	getMenuShortcutKeyMaskEx() Returns extended modifier key used as the appropriate accelerator key for menu shortcuts.
static Font	getMonospacedFont(JComponent component) Gets the font used to display monospaced text in a component, if possible.
static Font	getTitleFont() Gets the font used to display JOSM title in about dialog and splash screen.
static void	notifyUserHtmlError(Component parent, String title, String message, String html) Notifies user about an error received from an external source as an HTML page.
static Component	prepareResizeableOptionPane(Component pane, Dimension minDimension) Attaches a HierarchyListener to the specified Component that will set its parent dialog resizeable.
static void	runInEDT(Runnable task) Executes asynchronously a runnable in Event Dispatch Thread.
static void	runInEDTAndWait(Runnable task) Executes synchronously a runnable in Event Dispatch Thread.
static <V> V	runInEDTAndWaitAndReturn(Callable<V> callable) Executes synchronously a callable in Event Dispatch Thread and return a value.
static Timer	scheduleTimer(int initialDelay, ActionListener actionListener, boolean repeats) Schedules a new Timer to be run in the future (once or several times).
static void	setBackgroundReadable(JComponent c, Color background) Sets the background color for this component, and adjust the foreground color so the text remains readable.
static void	setEnabledRec(Container root, boolean enabled) disable / enable a component and all its child components
static void	setUIFont(String name) Sets a global font for all UI, replacing default font of current look and feel.
static boolean	warnUser(String title, String content, ImageIcon baseActionIcon, String continueToolTip) Warns user about a dangerous action requiring confirmation.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiHelper

private GuiHelper()

Method Detail

setEnabledRec

public static void setEnabledRec(Container root,
                                 boolean enabled)

disable / enable a component and all its child components

Parameters:

root - component

enabled - enabled state

executeByMainWorkerInEDT

public static void executeByMainWorkerInEDT(Runnable task)

runInEDT

public static void runInEDT(Runnable task)

Executes asynchronously a runnable in Event Dispatch Thread.

Parameters:

task - The runnable to execute

See Also:

SwingUtilities.invokeLater(java.lang.Runnable)

runInEDTAndWait

public static void runInEDTAndWait(Runnable task)

Executes synchronously a runnable in Event Dispatch Thread.

Parameters:

task - The runnable to execute

See Also:

SwingUtilities.invokeAndWait(java.lang.Runnable)

runInEDTAndWaitAndReturn

public static <V> V runInEDTAndWaitAndReturn(Callable<V> callable)

Executes synchronously a callable in Event Dispatch Thread and return a value.

Type Parameters:

V - the result type of method call

Parameters:

callable - The callable to execute

Returns:

The computed result

Since:

7204

warnUser

public static boolean warnUser(String title,
                               String content,
                               ImageIcon baseActionIcon,
                               String continueToolTip)

Warns user about a dangerous action requiring confirmation.

Parameters:

title - Title of dialog

content - Content of dialog

baseActionIcon - Unused? FIXME why is this parameter unused?

continueToolTip - Tooltip to display for "continue" button

Returns:

true if the user wants to cancel, false if they want to continue

notifyUserHtmlError

public static void notifyUserHtmlError(Component parent,
                                       String title,
                                       String message,
                                       String html)

Notifies user about an error received from an external source as an HTML page.

Parameters:

parent - Parent component

title - Title of dialog

message - Message displayed at the top of the dialog

html - HTML content to display (real error message)

Since:

7312

getDisabledImage

public static Image getDisabledImage(Image image)

Replies the disabled (grayed) version of the specified image.

Parameters:

image - The image to disable

Returns:

The disabled (grayed) version of the specified image, brightened by 20%.

Since:

5484

getDisabledIcon

public static ImageIcon getDisabledIcon(ImageIcon icon)

Replies the disabled (grayed) version of the specified icon.

Parameters:

icon - The icon to disable

Returns:

The disabled (grayed) version of the specified icon, brightened by 20%.

Since:

5484

prepareResizeableOptionPane

public static Component prepareResizeableOptionPane(Component pane,
                                                    Dimension minDimension)

Attaches a HierarchyListener to the specified Component that will set its parent dialog resizeable. Use it before a call to JOptionPane#showXXXXDialog to make it resizeable.

Parameters:

pane - The component that will be displayed

minDimension - The minimum dimension that will be set for the dialog. Ignored if null

Returns:

pane

Since:

5493

scheduleTimer

public static Timer scheduleTimer(int initialDelay,
                                  ActionListener actionListener,
                                  boolean repeats)

Schedules a new Timer to be run in the future (once or several times).

Parameters:

initialDelay - milliseconds for the initial and between-event delay if repeatable

actionListener - an initial listener; can be null

repeats - specify false to make the timer stop after sending its first action event

Returns:

The (started) timer.

Since:

5735

getCustomizedStroke

public static Stroke getCustomizedStroke(String code)

Return s new BasicStroke object with given thickness and style

Parameters:

code - = 3.5 -> thickness=3.5px; 3.5 10 5 -> thickness=3.5px, dashed: 10px filled + 5px empty

Returns:

stroke for drawing

getMonospacedFont

public static Font getMonospacedFont(JComponent component)

Gets the font used to display monospaced text in a component, if possible.

Parameters:

component - The component

Returns:

the font used to display monospaced text in a component, if possible

Since:

7896

getTitleFont

public static Font getTitleFont()

Gets the font used to display JOSM title in about dialog and splash screen.

Returns:

title font

Since:

5797

embedInVerticalScrollPane

public static JScrollPane embedInVerticalScrollPane(Component panel)

Embeds the given component into a new vertical-only scrollable JScrollPane.

Parameters:

panel - The component to embed

Returns:

the vertical scrollable JScrollPane

Since:

6666

getMenuShortcutKeyMaskEx

public static int getMenuShortcutKeyMaskEx()

Returns extended modifier key used as the appropriate accelerator key for menu shortcuts. It is advised everywhere to use Toolkit.getMenuShortcutKeyMask() to get the cross-platform modifier, but:

• it returns KeyEvent.CTRL_MASK instead of KeyEvent.CTRL_DOWN_MASK. We used the extended modifier for years, and Oracle recommends to use it instead, so it's best to keep it
• the method throws a HeadlessException ! So we would need to handle it for unit tests anyway

Returns:

extended modifier key used as the appropriate accelerator key for menu shortcuts

Since:

7539

setUIFont

public static void setUIFont(String name)

Sets a global font for all UI, replacing default font of current look and feel.

Parameters:

name - Font name. It is up to the caller to make sure the font exists

Throws:

IllegalArgumentException - if name is null

Since:

7896

setBackgroundReadable

public static void setBackgroundReadable(JComponent c,
                                         Color background)

Sets the background color for this component, and adjust the foreground color so the text remains readable.

Parameters:

c - component

background - background color

Since:

9223