UIUtils (XDEV Application Framework 6.0.0 API)

java.lang.Object
- xdev.ui.UIUtils

All Implemented Interfaces:

ClientProperties
```
public final class UIUtils
extends Object
implements ClientProperties
```
The UIUtils class provides utility methods for dialog, window and general UI (user interface) handling.

Since:

2.0

Author:

XDEV Software

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UIUtils.MessageDialogType
Message types.

Nested Classes
Modifier and Type	Class and Description
`static class`	`UIUtils.MessageDialogType` Message types.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CANCEL_OPTION` Return value from class method if CANCEL is chosen.
`static int`	`CLOSED_OPTION` Return value from class method if user closes window without selecting anything, more than likely this should be treated as either a `CANCEL_OPTION` or `NO_OPTION`.
`static int`	`DEFAULT_OPTION` Type meaning Look and Feel should not supply any options -- only use the options from the `JOptionPane`.
`static int`	`ERROR_MESSAGE` Used for error messages.
`static int`	`INFORMATION_MESSAGE` Used for information messages.
`static int`	`NO_OPTION` Return value from class method if NO is chosen.
`static int`	`OK_CANCEL_OPTION` Type used for `showConfirmDialog`.
`static int`	`OK_OPTION` Return value form class method if OK is chosen.
`static int`	`PLAIN_MESSAGE` No icon is used.
`static int`	`QUESTION_MESSAGE` Used for questions.
`static int`	`WARNING_MESSAGE` Used for warning messages.
`static int`	`YES_NO_CANCEL_OPTION` Type used for `showConfirmDialog`.
`static int`	`YES_NO_OPTION` Type used for `showConfirmDialog`.
`static int`	`YES_OPTION` Return value from class method if YES is chosen.

Fields inherited from interface xdev.ui.ClientProperties
DATA_FIELD, FORMULAR_CONDITION_FILTER, FORMULAR_CONDITION_PRECISION, FORMULAR_FILTER_OPERATOR, FORMULAR_SKIP, FORMULAR_VERIFIER, TAG_DATA

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addChildren(Container parent, XdevList<Component> children, boolean deep)` Adds children of the provided `Container` `parent` to the provided `XdevList`.
`static ButtonGroup`	`createButtonGroup(AbstractButton... buttons)` Creates and returns a new `ButtonGroup` containing the provided `AbstractButton` `buttons`.
`static XdevDialog`	`createDialog(XdevWindow content, Component owner, boolean modal)` Creates and shows a `XdevDialog` hosting the provided `XdevWindow` `content`, using content's title as title for the dialog.
`static XdevDialog`	`createDialog(XdevWindow content, Component owner, String title, boolean modal)` Creates and shows a `XdevDialog` with the provided `title`, hosting the provided `XdevWindow` `content`.
`static JFileChooser`	`createFileChooser(Collection<?> allowedSuffixes)` Shows the system file chooser dialog to select a file.
`static JFileChooser`	`createFolderChooser()` Returns a `JFileChooser` configured to chose folders.
`static XdevFrame`	`createFrame(XdevWindow content)` Creates and shows a `XdevFrame` hosting the provided `XdevWindow` `content`, using content's title as title for the frame.
`static XdevFrame`	`createFrame(XdevWindow content, String title)` Creates and shows a `XdevFrame` with the provided `title`, hosting the provided `XdevWindow` `content`.
`static XdevImage`	`createImageFrom(Component cpn)` Creates a `XdevImage` from the provided `Component` `cpn`.
`static XdevScreen`	`createScreen(XdevWindow content, Component owner)` Creates and shows a `XdevScreen` hosting the provided `XdevWindow` `content`.
`static Window`	`getActiveWindow()` Returns the current active `Window`.
`static JApplet`	`getApplet()` Returns the JApplet of the running application, if the running application runs as applet.
`static XdevList<Component>`	`getChildrenOf(Container parent, boolean deep)` Returns a `XdevList` containing all children of the provided `Container` `parent`.
`static Component`	`getComponentByName(String name)` Returns the component for the provided `name`.Searches for the component in the current active `Window`.
`static Component`	`getComponentByName(String name, Window window)` Returns the component for the provided `name`.
`static GraphicsConfiguration`	`getGraphicsConfigurationOf(Component cpn)` Returns the `GraphicsConfiguration` for the provided `Component` `cpn`.
`static String`	`getIP()`
`static int`	`getMessageType(Severity severity)` Returns the appropriate message type for the specified severity.
`static <T> T`	`getParentOfClass(Class<T> c, Component cpn)` Convenience method for searching above `cpn` in the component hierarchy and returns the first object of class `c` it finds.
`static JFileChooser`	`getSharedFileChooser()` Returns the shared `JFileChooser`.
`static String`	`getTagData(Object obj)` Deprecated.
`static XdevWindow`	`getXdevWindowOf(Component component)` Return the `XdevWindow` on which the provided `Component` `component` is located on.
`static XdevWindow`	`getXdevWindowOf(Window window)` Returns the `XdevWindow` of the specified `Window` `window`.
`static void`	`insertMouseListener(Component cpn, MouseListener mouseListener, int index)` Registers the provided `MouseListener` `mouseListener` at the desired `index` for the `Component` `cpn`.
`static void`	`insertMouseMotionListener(Component cpn, MouseMotionListener mouseMotionListener, int index)` Registers the provided `MouseMotionListener` `mouseMotionListener` at the desired `index` for the `Component` `cpn` .
`static boolean`	`isDoubleClick(MouseEvent e)` Returns `true` if `e` is a left double click; otherwise `false`.
`static boolean`	`isLeftMouseButton(MouseEvent e)` Returns `true` if the mouse event specifies the left mouse button.
`static boolean`	`isMiddleMouseButton(MouseEvent e)` Returns `true` if the mouse event specifies the middle mouse button.
`static boolean`	`isRightMouseButton(MouseEvent e)` Returns `true` if the mouse event specifies the right mouse button.
`static Icon`	`loadIcon(String path)` Calls `GraphicUtils.loadIcon(String)` and catches the `IOException`.
`static <T,C extends Component> T`	`lookupComponentTree(Container parent, ComponentTreeVisitor<T,C> visitor)` Shortcut for `lookupComponentTree(parent,visitor,null)`.
`static <T,C extends Component> T`	`lookupComponentTree(Container parent, ComponentTreeVisitor<T,C> visitor, Class<C> type)` Walks through the `parent`'s component tree hierarchy.
`static void`	`move(Component cpn, int x, int y, boolean relative)` Moves the `Component` `cpn` to the specified position.
`static void`	`move(Component cpn, int toX, int toY, long duration, boolean relative, boolean wait)` Moves the `Component` `cpn` to the specified position.
`static void`	`pause(long millis)` Causes the currently executing thread to sleep (temporarily cease execution) for the specified number of milliseconds, subject to the precision and accuracy of system timers and schedulers.
`static void`	`registerPopup(Component cpn, XdevMenu popup)` Registers listeners to the component to show the popup in the platform's specific manner. To register a popup to a JTree `TreeUtils.registerPopup(JTree, XdevMenu)` is the preferred way.
`static void`	`registerPopupHandler(Component cpn, PopupHandler handler)` Registers listeners to the component to show the popup in the platform's specific manner. To register a popup to a JTree `TreeUtils.registerPopupHandler(JTree, xdev.ui.tree.TreePopupHandler)` is the preferred way.
`static void`	`registerShortcut(AbstractButton button, KeyStroke keyStroke)` Registers a keyboard shortcut for the specified `button`.
`static void`	`removeMouseListener(Component cpn, Class<? extends MouseListener> type)` Unregisters all instances of the provided `MouseListener` class from the `Component` `cpn`.
`static void`	`removeMouseMotionListener(Component cpn, Class<? extends MouseMotionListener> type)` Unregisters all instances of the provided `MouseMotionListener` class from the `Component` `cpn`.
`static void`	`runInSwingThread(Runnable runnable)` Ensures that the runnable is executed in the Java Swing thread.
`static void`	`scale(Component cpn, int x, int y, int width, int height, boolean relative)` Moves the `Component` `cpn` to the specified position and scales the `Component` to fit the new `width` and `height`.
`static void`	`scale(Component cpn, int toX, int toY, int toWidth, int toHeight, long duration, boolean wait)` Moves the `Component` `cpn` to the specified position and scales the `Component` to fit the new `width` and `height`.
`static void`	`scrollToStart(JComponent cpn)` Scrolls to the visible start of the component, e.g.
`static void`	`setBorderTitle(JComponent cpn, String title)` Sets the border title for provided `JComponent` `cpn`.
`static EnabledState`	`setEnabled(Container root, boolean enabled)` Performs the `Component.setEnabled(boolean)` method on all `Component`s in the provided `Container` `root`.
`static void`	`setQualityHints(Graphics2D g)` Set rendering hints to quality on the provided `Graphics2D` `g`.
`static void`	`setSpeedHints(Graphics2D g)` Set rendering hints to speed on the provided `Graphics2D` `g`.
`static void`	`setTagData(Object obj, String tagData)` Deprecated.
`static Color`	`showColorChooser(String title, Color initialColor)` Shows a `JColorChooser` dialog so the user can choose a `Color`.
`static Object`	`showConfirmMessage(String title, String message, Collection<?> options, int selectedIndex, int messageType)` Brings up a simple confirm dialog with the specified icon.
`static Object`	`showConfirmMessage(String title, String message, Collection<?> options, int selectedIndex, UIUtils.MessageDialogType messageDialogType)` Brings up a simple confirm dialog with the specified icon.
`static Object`	`showConfirmMessage(String title, String message, Object[] options, int selectedIndex, int messageType)` Brings up a simple confirm dialog with the specified icon.
`static Object`	`showConfirmMessage(String title, String message, Object[] options, int selectedIndex, UIUtils.MessageDialogType messageDialogType)` Brings up a simple confirm dialog with the specified icon.
`static boolean`	`showConfirmMessage(String title, String message, String ok, String cancel)` Brings up a simple confirm dialog.
`static boolean`	`showConfirmMessage(String title, String message, String ok, String cancel, int messageType)` Brings up a simple confirm dialog with the specified icon.
`static boolean`	`showConfirmMessage(String title, String message, String ok, String cancel, UIUtils.MessageDialogType messageDialogType)` Brings up a simple confirm dialog with the specified icon.
`static XdevFile`	`showFileChooser()` Shows the system file chooser dialog to select a file.
`static XdevFile`	`showFileChooser(Collection<?> allowedSuffixes)` Shows the system file chooser dialog to select a file.
`static XdevFile`	`showFileChooser(String okButtonText, Collection<?> allowedSuffixes)` Shows the system file chooser dialog to select a file.
`static XdevFile`	`showFileChooser(String okButtonText, Collection<?> allowedSuffixes, String initialPath)` Shows the system file chooser dialog to select a file.
`static XdevFile`	`showFolderChooser()` Shows the system file chooser dialog to select a folder.
`static XdevFile`	`showFolderChooser(String okButtonText)` Shows the system file chooser dialog to select a folder.
`static XdevFile`	`showFolderChooser(String okButtonText, String initialPath)` Shows the system file chooser dialog to select a folder.
`static void`	`showMessage(String title, String message)` Brings up a dialog that displays a message using a no icon.
`static void`	`showMessage(String title, String message, int messageType)` Brings up a dialog that displays a message using a default icon determined by the `messageType` parameter.
`static void`	`showMessage(String title, String message, UIUtils.MessageDialogType messageDialogType)` Brings up a dialog that displays a message using a default icon determined by the `messageType` parameter.
`static void`	`toBack(Component cpn)` Sets the provided `Component` `cpn` to back.
`static void`	`toFront(Component cpn)` Sets the provided `Component` `cpn` to front.
`static String`	`toString(JComponent cpn)` Returns a `String` representation of the provided `JComponent` `cpn`.
`static boolean`	`validateState(FormularComponent formCpn)` Validates the state of `formCpn` using the `Validator`s of the `FormularComponent` and displays an error if one of the validators throws an error.
`static boolean`	`verifyFormularComponent(JComponent cpn)` Deprecated. use `validateState(FormularComponent)` instead

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_OPTION
```
public static final int DEFAULT_OPTION
```
    Type meaning Look and Feel should not supply any options -- only use the options from the JOptionPane.
    
    See Also:
    
    Constant Field Values
  - YES_NO_OPTION
```
public static final int YES_NO_OPTION
```
    Type used for showConfirmDialog.
    
    See Also:
    
    Constant Field Values
  - YES_NO_CANCEL_OPTION
```
public static final int YES_NO_CANCEL_OPTION
```
    Type used for showConfirmDialog.
    
    See Also:
    
    Constant Field Values
  - OK_CANCEL_OPTION
```
public static final int OK_CANCEL_OPTION
```
    Type used for showConfirmDialog.
    
    See Also:
    
    Constant Field Values
  - YES_OPTION
```
public static final int YES_OPTION
```
    Return value from class method if YES is chosen.
    
    See Also:
    
    Constant Field Values
  - NO_OPTION
```
public static final int NO_OPTION
```
    Return value from class method if NO is chosen.
    
    See Also:
    
    Constant Field Values
  - CANCEL_OPTION
```
public static final int CANCEL_OPTION
```
    Return value from class method if CANCEL is chosen.
    
    See Also:
    
    Constant Field Values
  - OK_OPTION
```
public static final int OK_OPTION
```
    Return value form class method if OK is chosen.
    
    See Also:
    
    Constant Field Values
  - CLOSED_OPTION
```
public static final int CLOSED_OPTION
```
    Return value from class method if user closes window without selecting anything, more than likely this should be treated as either a CANCEL_OPTION or NO_OPTION.
    
    See Also:
    
    Constant Field Values
  - ERROR_MESSAGE
```
public static final int ERROR_MESSAGE
```
    Used for error messages.
    
    See Also:
    
    Constant Field Values
  - INFORMATION_MESSAGE
```
public static final int INFORMATION_MESSAGE
```
    Used for information messages.
    
    See Also:
    
    Constant Field Values
  - WARNING_MESSAGE
```
public static final int WARNING_MESSAGE
```
    Used for warning messages.
    
    See Also:
    
    Constant Field Values
  - QUESTION_MESSAGE
```
public static final int QUESTION_MESSAGE
```
    Used for questions.
    
    See Also:
    
    Constant Field Values
  - PLAIN_MESSAGE
```
public static final int PLAIN_MESSAGE
```
    No icon is used.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setSpeedHints
```
public static void setSpeedHints(Graphics2D g)
                          throws NullPointerException
```
    Set rendering hints to speed on the provided Graphics2D g.
    
    Parameters:
    
    g - Graphics2D to set the rendering hints on.
    
    Throws:
    
    NullPointerException - if provided Graphics2D g is null.
  - setQualityHints
```
public static void setQualityHints(Graphics2D g)
                            throws NullPointerException
```
    Set rendering hints to quality on the provided Graphics2D g.
    
    Parameters:
    
    g - Graphics2D to set the rendering hints on.
    
    Throws:
    
    NullPointerException - if provided Graphics2D g is null.
  - loadIcon
```
public static Icon loadIcon(String path)
```
    Calls GraphicUtils.loadIcon(String) and catches the IOException.
    
    Parameters:
    
    path - the relative path of the icon, e.g. 'res/image/splash.png'
    
    Returns:
    
    The loaded icon or null if an IOException occurs
  - getXdevWindowOf
```
public static XdevWindow getXdevWindowOf(Component component)
```
    Return the XdevWindow on which the provided Component component is located on. If the provided Component component is not placed on a XdevWindow null will be returned.
    
    Parameters:
    
    component - Component to get the XdevWindow for.
    
    Returns:
    
    the XdevWindow on which the provided Component component is located on. If the provided Component component is not placed on a XdevWindow null will be returned.
  - getParentOfClass
```
public static <T> T getParentOfClass(Class<T> c,
                                     Component cpn)
```
    Convenience method for searching above cpn in the component hierarchy and returns the first object of class c it finds. Can return null, if a class c cannot be found.
    
    Parameters:
    
    c - The type to search for
    
    cpn - The starting point in the component hierarchy
    
    Returns:
    
    The owner of cpn or null if no owner of type c could be found
  - getSharedFileChooser
```
public static JFileChooser getSharedFileChooser()
```
    Returns the shared JFileChooser.
    Hint: Does not show the JFileChooser. To show the JFileChooser use showFileChooser(String, Collection) .
    
    Returns:
    
    the shared JFileChooser.
  - createFolderChooser
```
public static JFileChooser createFolderChooser()
```
    Returns a JFileChooser configured to chose folders.
    Hint: Does not show the JFileChooser. To show the JFileChooser use showFolderChooser(String).
    
    Returns:
    
    a JFileChooser configured to chose folders.
  - showFolderChooser
```
public static XdevFile showFolderChooser()
```
    Shows the system file chooser dialog to select a folder.
    The chooser starts the last use folder.
    
    Returns:
    
    the chosen folder; null if the user closes the dialog or does not select a folder.
    
    Since:
    
    4.0
  - showFolderChooser
```
public static XdevFile showFolderChooser(String okButtonText)
```
    Shows the system file chooser dialog to select a folder.
    The chooser starts the last use folder.
    
    Parameters:
    
    okButtonText - String to use as text for the ok button of the folder chooser. If null the default text is used.
    
    Returns:
    
    the chosen folder; null if the user closes the dialog or does not select a folder.
  - showFolderChooser
```
public static XdevFile showFolderChooser(String okButtonText,
                                         String initialPath)
```
    Shows the system file chooser dialog to select a folder.
    
    Parameters:
    
    okButtonText - String to use as text for the ok button of the folder chooser. If null the default text is used.
    
    initialPath - String path to open the file chooser for. If null the folder chooser starts in the last used folder.
    
    Returns:
    
    the chosen folder; null if the user closes the dialog or does not select a folder.
  - showFileChooser
```
public static XdevFile showFileChooser()
```
    Shows the system file chooser dialog to select a file.
    The chooser starts in the last used folder.
    
    Hint:
    For a more sophisticated way to use file choosers see XdevFileChooserFactory.
    
    Returns:
    
    the chosen folder; null if the user closes the dialog or does not select a folder.
    
    Since:
    
    4.0
  - showFileChooser
```
public static XdevFile showFileChooser(Collection<?> allowedSuffixes)
```
    Shows the system file chooser dialog to select a file.
    The chooser starts in the last used folder.
    
    Hint:
    For a more sophisticated way to use file choosers see XdevFileChooserFactory.
    
    Parameters:
    
    allowedSuffixes - a Collection containing the allowed suffixes for files this file chooser should display. If null or empty (= list with not entries) all files will be displayed.
    
    Returns:
    
    the chosen folder; null if the user closes the dialog or does not select a folder.
    
    Since:
    
    4.0
  - showFileChooser
```
public static XdevFile showFileChooser(String okButtonText,
                                       Collection<?> allowedSuffixes)
```
    Shows the system file chooser dialog to select a file.
    The chooser starts in the last used folder.
    
    Hint:
    For a more sophisticated way to use file choosers see XdevFileChooserFactory.
    
    Parameters:
    
    okButtonText - String to use as text for the ok button of the file chooser. If null the default text is used.
    
    allowedSuffixes - a Collection containing the allowed suffixes for files this file chooser should display. If null or empty (= list with not entries) all files will be displayed.
    
    Returns:
    
    the chosen folder; null if the user closes the dialog or does not select a folder.
  - showFileChooser
```
public static XdevFile showFileChooser(String okButtonText,
                                       Collection<?> allowedSuffixes,
                                       String initialPath)
```
    Shows the system file chooser dialog to select a file.
    Hint:
    For a more sophisticated way to use file choosers see XdevFileChooserFactory.
    
    Parameters:
    
    okButtonText - String to use as text for the ok button of the file chooser. If null the default text is used.
    
    allowedSuffixes - a Collection containing the allowed suffixes for files this file chooser should display. If null or empty (= list with not entries) all files will be displayed.
    
    initialPath - String path to open the file chooser for. If null the folder chooser starts in the last used folder.
    
    Returns:
    
    the chosen folder; null if the user closes the dialog or does not select a folder.
  - createFileChooser
```
public static JFileChooser createFileChooser(Collection<?> allowedSuffixes)
```
    Shows the system file chooser dialog to select a file.
    The standard ok button text is used. The chooser starts in the last used folder.
    
    Hint: Does not show the JFileChooser. To show the JFileChooser use showFileChooser(String, Collection) .
    
    Hint:
    For a more sophisticated way to use file choosers see XdevFileChooserFactory.
    
    Parameters:
    
    allowedSuffixes - a Collection containing the allowed suffixes for files this file chooser should display. If null or empty (= list with not entries) all files will be displayed.
    
    Returns:
    
    the chosen folder; null if the user closes the dialog or does not select a folder.
  - showColorChooser
```
public static Color showColorChooser(String title,
                                     Color initialColor)
```
    Shows a JColorChooser dialog so the user can choose a Color.
    
    Parameters:
    
    title - String title of the dialog. If null the chooser title will be empty.
    
    initialColor - Color to start with. If null the chooser is started with Color.white.
    
    Returns:
    
    the selected Color; or null if the user closes the dialog or does not select a Color.
  - lookupComponentTree
```
public static <T,C extends Component> T lookupComponentTree(Container parent,
                                                            ComponentTreeVisitor<T,C> visitor)
```
    Shortcut for lookupComponentTree(parent,visitor,null).
    
    Type Parameters:
    
    T - The return type
    
    C - The component type to visit
    
    Parameters:
    
    parent - The root of the component tree to visit
    
    visitor - the ComponentTreeVisitor
    
    See Also:
    
    ComponentTreeVisitor
  - lookupComponentTree
```
public static <T,C extends Component> T lookupComponentTree(Container parent,
                                                            ComponentTreeVisitor<T,C> visitor,
                                                            Class<C> type)
```
    Walks through the parent's component tree hierarchy.
    For every child in the tree hierarchy, which fits the type parameter (or type is null), the visitor's ComponentTreeVisitor.visit(Component) is invoked.
    If the visit method returns a value != null, the visitation ends and that value is returned.
    
    Type Parameters:
    
    T - The return type
    
    C - The component type to visit
    
    Parameters:
    
    parent - The root of the component tree to visit
    
    visitor - the ComponentTreeVisitor
    
    type - The component type class to visit
    
    See Also:
    
    ComponentTreeVisitor
  - getActiveWindow
```
public static Window getActiveWindow()
```
    Returns the current active Window.
    
    Returns:
    
    the current active Window.
  - showMessage
```
public static void showMessage(String title,
                               String message)
```
    Brings up a dialog that displays a message using a no icon.
    
    Parameters:
    
    message - the message to display
    
    title - the title string for the dialog
    
    See Also:
    
    showMessage(String, String, int)
  - showMessage
```
public static void showMessage(String title,
                               String message,
                               int messageType)
```
    Brings up a dialog that displays a message using a default icon determined by the messageType parameter.
    
    Parameters:
    
    message - the message to display
    
    title - the title string for the dialog
    
    messageType - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE
    
    See Also:
    
    ERROR_MESSAGE, WARNING_MESSAGE, INFORMATION_MESSAGE, QUESTION_MESSAGE, PLAIN_MESSAGE
  - showMessage
```
public static void showMessage(String title,
                               String message,
                               UIUtils.MessageDialogType messageDialogType)
```
    Brings up a dialog that displays a message using a default icon determined by the messageType parameter.
    
    Parameters:
    
    message - the message to display
    
    title - the title string for the dialog
    
    messageDialogType - the type of message to be displayed: UIUtils.MessageDialogType.ERROR_MESSAGE, UIUtils.MessageDialogType.INFORMATION_MESSAGE UIUtils.MessageDialogType.WARNING_MESSAGE, UIUtils.MessageDialogType.QUESTION_MESSAGE, or UIUtils.MessageDialogType.PLAIN_MESSAGE
    
    Since:
    
    3.0
    
    See Also:
    
    UIUtils.MessageDialogType
  - showConfirmMessage
```
public static boolean showConfirmMessage(String title,
                                         String message,
                                         String ok,
                                         String cancel)
```
    Brings up a simple confirm dialog.
    
    Parameters:
    
    message - the message to display
    
    title - the title string for the dialog
    
    ok - String to use as text for the ok button.
    
    cancel - String to use as text for the cancel button.
    
    Returns:
    
    true if the user selected the ok button; otherwise false.
  - showConfirmMessage
```
public static boolean showConfirmMessage(String title,
                                         String message,
                                         String ok,
                                         String cancel,
                                         int messageType)
```
    Brings up a simple confirm dialog with the specified icon.
    
    Parameters:
    
    message - the message to display
    
    title - the title string for the dialog
    
    ok - String to use as text for the ok button.
    
    cancel - String to use as text for the cancel button.
    
    messageType - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE
    
    Returns:
    
    true if the user selected the ok button; otherwise false.
    
    See Also:
    
    ERROR_MESSAGE, WARNING_MESSAGE, INFORMATION_MESSAGE, QUESTION_MESSAGE, PLAIN_MESSAGE
  - showConfirmMessage
```
public static boolean showConfirmMessage(String title,
                                         String message,
                                         String ok,
                                         String cancel,
                                         UIUtils.MessageDialogType messageDialogType)
                                  throws NullPointerException
```
    Brings up a simple confirm dialog with the specified icon.
    
    Parameters:
    
    message - the message to display
    
    title - the title string for the dialog
    
    ok - String to use as text for the ok button.
    
    cancel - String to use as text for the cancel button.
    
    messageDialogType - the type of message to be displayed: UIUtils.MessageDialogType.ERROR_MESSAGE, UIUtils.MessageDialogType.INFORMATION_MESSAGE UIUtils.MessageDialogType.WARNING_MESSAGE, UIUtils.MessageDialogType.QUESTION_MESSAGE, or UIUtils.MessageDialogType.PLAIN_MESSAGE
    
    Returns:
    
    true if the user selected the ok button; otherwise false.
    
    Throws:
    
    NullPointerException - if messageDialogType is null
    
    Since:
    
    3.0
    
    See Also:
    
    UIUtils.MessageDialogType
  - showConfirmMessage
```
public static Object showConfirmMessage(String title,
                                        String message,
                                        Collection<?> options,
                                        int selectedIndex,
                                        int messageType)
```
    Brings up a simple confirm dialog with the specified icon.
    
    Parameters:
    
    message - the message to display
    
    title - the title string for the dialog
    
    options - an Collection of objects indicating the possible choices the user can make; if the objects are components, they are rendered properly; non-String objects are rendered using their toString methods; if this parameter is null, the options are determined by the Look and Feel
    
    selectedIndex - the index of the option that should be the default selection for the dialog. The first element of options has the index 0.
    
    messageType - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE
    
    Returns:
    
    the option object indicating the option chosen by the user, or null if the user closed the dialog.
    
    See Also:
    
    ERROR_MESSAGE, WARNING_MESSAGE, INFORMATION_MESSAGE, QUESTION_MESSAGE, PLAIN_MESSAGE
  - showConfirmMessage
```
public static Object showConfirmMessage(String title,
                                        String message,
                                        Collection<?> options,
                                        int selectedIndex,
                                        UIUtils.MessageDialogType messageDialogType)
                                 throws NullPointerException
```
    Brings up a simple confirm dialog with the specified icon.
    
    Parameters:
    
    message - the message to display
    
    title - the title string for the dialog
    
    options - an Collection of objects indicating the possible choices the user can make; if the objects are components, they are rendered properly; non-String objects are rendered using their toString methods; if this parameter is null, the options are determined by the Look and Feel
    
    selectedIndex - the index of the option that should be the default selection for the dialog. The first element of options has the index 0.
    
    messageDialogType - the type of message to be displayed: UIUtils.MessageDialogType.ERROR_MESSAGE, UIUtils.MessageDialogType.INFORMATION_MESSAGE UIUtils.MessageDialogType.WARNING_MESSAGE, UIUtils.MessageDialogType.QUESTION_MESSAGE, or UIUtils.MessageDialogType.PLAIN_MESSAGE
    
    Returns:
    
    the option object indicating the option chosen by the user, or null if the user closed the dialog.
    
    Throws:
    
    NullPointerException - if messageDialogType is null
    
    Since:
    
    3.0
    
    See Also:
    
    UIUtils.MessageDialogType
  - showConfirmMessage
```
public static Object showConfirmMessage(String title,
                                        String message,
                                        Object[] options,
                                        int selectedIndex,
                                        int messageType)
```
    Brings up a simple confirm dialog with the specified icon.
    
    Parameters:
    
    message - the message to display
    
    title - the title string for the dialog
    
    options - an array of objects indicating the possible choices the user can make; if the objects are components, they are rendered properly; non-String objects are rendered using their toString methods; if this parameter is null, the options are determined by the Look and Feel
    
    selectedIndex - the index of the option that should be the default selection for the dialog. The first element of options has the index 0.
    
    messageType - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE
    
    Returns:
    
    the option object indicating the option chosen by the user, or null if the user closed the dialog.
    
    See Also:
    
    ERROR_MESSAGE, WARNING_MESSAGE, INFORMATION_MESSAGE, QUESTION_MESSAGE, PLAIN_MESSAGE
  - showConfirmMessage
```
public static Object showConfirmMessage(String title,
                                        String message,
                                        Object[] options,
                                        int selectedIndex,
                                        UIUtils.MessageDialogType messageDialogType)
                                 throws NullPointerException
```
    Brings up a simple confirm dialog with the specified icon.
    
    Parameters:
    
    message - the message to display
    
    title - the title string for the dialog
    
    options - an array of objects indicating the possible choices the user can make; if the objects are components, they are rendered properly; non-String objects are rendered using their toString methods; if this parameter is null, the options are determined by the Look and Feel
    
    selectedIndex - the index of the option that should be the default selection for the dialog. The first element of options has the index 0.
    
    messageDialogType - the type of message to be displayed: UIUtils.MessageDialogType.ERROR_MESSAGE, UIUtils.MessageDialogType.INFORMATION_MESSAGE UIUtils.MessageDialogType.WARNING_MESSAGE, UIUtils.MessageDialogType.QUESTION_MESSAGE, or UIUtils.MessageDialogType.PLAIN_MESSAGE
    
    Returns:
    
    the option object indicating the option chosen by the user, or null if the user closed the dialog.
    
    Throws:
    
    NullPointerException - if messageDialogType is null
    
    Since:
    
    3.0
    
    See Also:
    
    UIUtils.MessageDialogType
  - getIP
```
public static String getIP()
```
  - pause
```
public static void pause(long millis)
```
    Causes the currently executing thread to sleep (temporarily cease execution) for the specified number of milliseconds, subject to the precision and accuracy of system timers and schedulers. The thread does not lose ownership of any monitors.
    
    Parameters:
    
    millis - the length of time to sleep in milliseconds.
  - getComponentByName
```
public static Component getComponentByName(String name)
```
    Returns the component for the provided name.Searches for the component in the current active Window.
    
    Parameters:
    
    name - to get component for.
    
    Returns:
    
    the requested component if the component could be found in the provided window; otherwise null.
  - getComponentByName
```
public static Component getComponentByName(String name,
                                           Window window)
```
    Returns the component for the provided name. Searches for the component in the given Window window.
    
    Parameters:
    
    name - to get component for.
    
    window - Window to search for the component in.
    
    Returns:
    
    the requested component if the component could be found in the provided window; otherwise null.
  - getApplet
```
public static JApplet getApplet()
```
    Returns the JApplet of the running application, if the running application runs as applet.
    
    Returns:
    
    the JApplet of the running application, if the running application runs as applet; otherwise null.
  - createFrame
```
public static XdevFrame createFrame(XdevWindow content)
```
    Creates and shows a XdevFrame hosting the provided XdevWindow content, using content's title as title for the frame.
    
    Parameters:
    
    content - XdevWindow to display in the frame
    
    Returns:
    
    the created XdevFrame with the provided title, hosting the provided XdevWindow content .
  - createFrame
```
public static XdevFrame createFrame(XdevWindow content,
                                    String title)
```
    Creates and shows a XdevFrame with the provided title, hosting the provided XdevWindow content.
    
    Parameters:
    
    content - XdevWindow to display in the frame
    
    title - title of the frame
    
    Returns:
    
    the created XdevFrame with the provided title, hosting the provided XdevWindow content .
  - createDialog
```
public static XdevDialog createDialog(XdevWindow content,
                                      Component owner,
                                      boolean modal)
```
    Creates and shows a XdevDialog hosting the provided XdevWindow content, using content's title as title for the dialog.
    
    Parameters:
    
    content - XdevWindow to display in the dialog
    
    owner - the owner of the dialog
    
    modal - if true the dialog is modal; otherwise it is not
    
    Returns:
    
    the created XdevDialog with the provided title, hosting the provided XdevWindow content .
  - createDialog
```
public static XdevDialog createDialog(XdevWindow content,
                                      Component owner,
                                      String title,
                                      boolean modal)
```
    Creates and shows a XdevDialog with the provided title, hosting the provided XdevWindow content.
    
    Parameters:
    
    content - XdevWindow to display in the dialog
    
    owner - the owner of the dialog
    
    title - title of the dialog
    
    modal - if true the dialog is modal; otherwise it is not
    
    Returns:
    
    the created XdevDialog with the provided title, hosting the provided XdevWindow content .
  - createScreen
```
public static XdevScreen createScreen(XdevWindow content,
                                      Component owner)
```
    Creates and shows a XdevScreen hosting the provided XdevWindow content.
    
    Parameters:
    
    content - XdevWindow to display in the window
    
    owner - the owner of the window
    
    Returns:
    
    the created XdevScreen with the provided title, hosting the provided XdevWindow content .
  - move
```
public static void move(Component cpn,
                        int x,
                        int y,
                        boolean relative)
```
    Moves the Component cpn to the specified position.
    
    Parameters:
    
    cpn - Component to move
    
    x - new x coordinate of the Component
    
    y - new y coordinate of the Component
    
    relative - if true the Component will be moved relative to is current position; other wise the Component will be moved absolute.
  - move
```
public static void move(Component cpn,
                        int toX,
                        int toY,
                        long duration,
                        boolean relative,
                        boolean wait)
```
    Moves the Component cpn to the specified position.
    
    Parameters:
    
    cpn - Component to move
    
    toX - new x coordinate of the Component
    
    toY - new y coordinate of the Component
    
    duration - duration of the move operation in milliseconds
    
    relative - if true the Component will be moved relative to is current position; other wise the Component will be moved absolute.
    
    wait - if true the moving operation forces all following operations to wait for it to finish; otherwise the following operation will start immediately.
  - scale
```
public static void scale(Component cpn,
                         int x,
                         int y,
                         int width,
                         int height,
                         boolean relative)
```
    Moves the Component cpn to the specified position and scales the Component to fit the new width and height.
    
    Parameters:
    
    cpn - Component to move
    
    x - new x coordinate of the Component
    
    y - new y coordinate of the Component
    
    width - new width of the Component
    
    height - new height of the Component
    
    relative - if true the Component will be moved relative to is current position; other wise the Component will be moved absolute.
  - scale
```
public static void scale(Component cpn,
                         int toX,
                         int toY,
                         int toWidth,
                         int toHeight,
                         long duration,
                         boolean wait)
```
    Moves the Component cpn to the specified position and scales the Component to fit the new width and height.
    
    Parameters:
    
    cpn - Component to move
    
    toX - new x coordinate of the Component
    
    toY - new y coordinate of the Component
    
    duration - duration of the move operation in milliseconds
    
    toWidth - new width of the Component
    
    toHeight - new height of the Component
    
    wait - if true the moving operation forces all following operations to wait for it to finish; otherwise the following operation will start immediately.
  - toFront
```
public static void toFront(Component cpn)
```
    Sets the provided Component cpn to front.
    
    Parameters:
    
    cpn - Component to set to front
  - toBack
```
public static void toBack(Component cpn)
```
    Sets the provided Component cpn to back.
    
    Parameters:
    
    cpn - Component to set to back
  - verifyFormularComponent
```
@Deprecated
public static boolean verifyFormularComponent(JComponent cpn)
```
    Deprecated. use validateState(FormularComponent) instead
    
    Verifies the value of the given JComponent cpn using the set constrains of the component.
    
    Parameters:
    
    cpn - JComponent to check value on
    
    Returns:
    
    true if the value of the component is valid or the component has no constaints set; otherwise false
  - validateState
```
public static boolean validateState(FormularComponent formCpn)
```
    Validates the state of formCpn using the Validators of the FormularComponent and displays an error if one of the validators throws an error.
    
    Parameters:
    
    formCpn - the component to validate
    
    Returns:
    
    false if at least one of the validators returns with an error, true otherwise
  - getMessageType
```
public static int getMessageType(Severity severity)
```
    Returns the appropriate message type for the specified severity.
    Severity.ERROR -> ERROR_MESSAGE
    Severity.WARNING -> WARNING_MESSAGE
    Severity.INFORMATION -> INFORMATION_MESSAGE
    
    Parameters:
    
    severity -
    
    Returns:
    
    the appropriate message type for the specified severity
    
    Since:
    
    3.1
  - createImageFrom
```
public static XdevImage createImageFrom(Component cpn)
```
    Creates a XdevImage from the provided Component cpn.
    
    Parameters:
    
    cpn - Component to create a image from
    
    Returns:
    
    a XdevImage from the provided Component cpn.
  - setBorderTitle
```
public static void setBorderTitle(JComponent cpn,
                                  String title)
```
    Sets the border title for provided JComponent cpn.
    Hint: Works only if the component has a TitledBorder. You can set a TitledBorder for a component via XDEV IDE or manually with JComponent.setBorder(Border).
    
    Parameters:
    
    cpn - JComponent to set the title for
    
    title - String to be displayed in title of the border.
    
    See Also:
    
    JComponent.setBorder(Border)
  - toString
```
public static String toString(JComponent cpn)
```
    Returns a String representation of the provided JComponent cpn.
    
    Parameters:
    
    cpn - JComponent to get the String representation for.
    
    Returns:
    
    a String representation of the provided JComponent cpn or null if no suitable String could be created.
  - getTagData
```
@Deprecated
public static String getTagData(Object obj)
```
    Deprecated.
    
    Return a String representation of the tag data for the provided Object obj.
    
    Parameters:
    
    obj - Object to get the tag data for.
    
    Returns:
    
    a String representation of the tag data for the provided Object obj or null if the object has no tag data set.
  - setTagData
```
@Deprecated
public static void setTagData(Object obj,
                                          String tagData)
```
    Deprecated.
    
    Sets the tagData for the provided Object obj.
    
    Parameters:
    
    obj - Object to set the tagData for.
    
    tagData - to set for the provided object
  - setEnabled
```
public static EnabledState setEnabled(Container root,
                                      boolean enabled)
```
    Performs the Component.setEnabled(boolean) method on all Components in the provided Container root. For the Container itself the method is also called.
    Before this a EnabledState is created to store the original state. This state is returned.
    
    Hint: This is a deep operation that also affects all children of children of root and so on.
    
    Parameters:
    
    root - Container to perform the operation on
    
    enabled - true to enable all Components; false to disable all Components.
    
    Returns:
    
    the previous state of root's hierarchy
    
    Since:
    
    3.1 now returns the previous EnabledState
    
    See Also:
    
    EnabledState
  - getChildrenOf
```
public static XdevList<Component> getChildrenOf(Container parent,
                                                boolean deep)
```
    Returns a XdevList containing all children of the provided Container parent.
    Hint: Depending on deep, this can be a deep operation that also returns all children of children of parent and so on.
    
    Parameters:
    
    parent - Container to perform the operation on
    
    deep - true to make this a deep operation; otherwise false
    
    Returns:
    
    a XdevList containing all children of the provided Container parent. The XdevList does not contain the provided parent itself.
  - addChildren
```
public static void addChildren(Container parent,
                               XdevList<Component> children,
                               boolean deep)
```
    Adds children of the provided Container parent to the provided XdevList.
    Hint: Depending on deep, this can be a deep operation that also returns all children of children of parent and so on.
    
    Parameters:
    
    parent - Container to perform the operation on
    
    children - XdevList to add the children to
    
    deep - true to make this a deep operation; otherwise false
  - insertMouseListener
```
public static void insertMouseListener(Component cpn,
                                       MouseListener mouseListener,
                                       int index)
```
    Registers the provided MouseListener mouseListener at the desired index for the Component cpn.
    
    Parameters:
    
    cpn - Component to register the MouseListener for
    
    mouseListener - MouseListener to register
    
    index - desired position of the MouseListener
  - removeMouseListener
```
public static void removeMouseListener(Component cpn,
                                       Class<? extends MouseListener> type)
```
    Unregisters all instances of the provided MouseListener class from the Component cpn.
    
    Parameters:
    
    cpn - Component to unregister the MouseListener for
    
    type - class of the MouseListeners to unregister
  - insertMouseMotionListener
```
public static void insertMouseMotionListener(Component cpn,
                                             MouseMotionListener mouseMotionListener,
                                             int index)
```
    Registers the provided MouseMotionListener mouseMotionListener at the desired index for the Component cpn .
    
    Parameters:
    
    cpn - Component to register the MouseMotionListener for
    
    mouseMotionListener - MouseMotionListener to register
    
    index - desired position of the MouseMotionListener
  - removeMouseMotionListener
```
public static void removeMouseMotionListener(Component cpn,
                                             Class<? extends MouseMotionListener> type)
```
    Unregisters all instances of the provided MouseMotionListener class from the Component cpn.
    
    Parameters:
    
    cpn - Component to unregister the MouseMotionListener for
    
    type - class of the MouseMotionListeners to unregister
  - createButtonGroup
```
public static ButtonGroup createButtonGroup(AbstractButton... buttons)
```
    Creates and returns a new ButtonGroup containing the provided AbstractButton buttons.
    
    Parameters:
    
    buttons - members of the new ButtonGroup
    
    Returns:
    
    a new ButtonGroup containing the provided AbstractButton buttons.
  - registerShortcut
```
public static void registerShortcut(AbstractButton button,
                                    KeyStroke keyStroke)
```
    Registers a keyboard shortcut for the specified button.
    
    Parameters:
    
    button - to register the shortcut for
    
    keyStroke - KeyStroke to use a shortcut for the specified button.
    
    See Also:
    
    KeyStroke
  - getXdevWindowOf
```
public static XdevWindow getXdevWindowOf(Window window)
```
    Returns the XdevWindow of the specified Window window.
    
    Parameters:
    
    window - to get the XdevWindow for
    
    Returns:
    
    the XdevWindow of the specified Window window or null if the Window does not contain a XdevWindow.
  - getGraphicsConfigurationOf
```
public static GraphicsConfiguration getGraphicsConfigurationOf(Component cpn)
```
    Returns the GraphicsConfiguration for the provided Component cpn.
    
    Parameters:
    
    cpn - Component to get the GraphicsConfiguration for
    
    Returns:
    
    the GraphicsConfiguration for the provided Component cpn.
  - isDoubleClick
```
public static boolean isDoubleClick(MouseEvent e)
```
    Returns true if e is a left double click; otherwise false.
    
    Parameters:
    
    e - MouseEvent to be checked
    
    Returns:
    
    true if e is a left double click; otherwise false.
  - isLeftMouseButton
```
public static boolean isLeftMouseButton(MouseEvent e)
```
    Returns true if the mouse event specifies the left mouse button.
    
    Parameters:
    
    e - a MouseEvent object
    
    Returns:
    
    true if the left mouse button was active
    
    Since:
    
    3.1
  - isMiddleMouseButton
```
public static boolean isMiddleMouseButton(MouseEvent e)
```
    Returns true if the mouse event specifies the middle mouse button.
    
    Parameters:
    
    e - a MouseEvent object
    
    Returns:
    
    true if the middle mouse button was active
    
    Since:
    
    3.1
  - isRightMouseButton
```
public static boolean isRightMouseButton(MouseEvent e)
```
    Returns true if the mouse event specifies the right mouse button.
    
    Parameters:
    
    e - a MouseEvent object
    
    Returns:
    
    true if the right mouse button was active
    
    Since:
    
    3.1
  - registerPopup
```
public static void registerPopup(Component cpn,
                                 XdevMenu popup)
```
    Registers listeners to the component to show the popup in the platform's specific manner.
    
    To register a popup to a JTree TreeUtils.registerPopup(JTree, XdevMenu) is the preferred way.
    
    Parameters:
    
    cpn -
    
    popup -
  - registerPopupHandler
```
public static void registerPopupHandler(Component cpn,
                                        PopupHandler handler)
```
    Registers listeners to the component to show the popup in the platform's specific manner.
    
    To register a popup to a JTree TreeUtils.registerPopupHandler(JTree, xdev.ui.tree.TreePopupHandler) is the preferred way.
    
    Parameters:
    
    cpn -
    
    handler -
  - scrollToStart
```
public static void scrollToStart(JComponent cpn)
```
    Scrolls to the visible start of the component, e.g. the first line of a multiline text component.
    
    Parameters:
    
    cpn -
    
    Since:
    
    4.0
  - runInSwingThread
```
public static void runInSwingThread(Runnable runnable)
```
    Ensures that the runnable is executed in the Java Swing thread.
    
    Since:
    
    5.0

Class UIUtils

Nested Class Summary

Field Summary

Fields inherited from interface xdev.ui.ClientProperties

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_OPTION

YES_NO_OPTION

YES_NO_CANCEL_OPTION

OK_CANCEL_OPTION

YES_OPTION

NO_OPTION

CANCEL_OPTION

OK_OPTION

CLOSED_OPTION

ERROR_MESSAGE

INFORMATION_MESSAGE

WARNING_MESSAGE

QUESTION_MESSAGE

PLAIN_MESSAGE

Method Detail

setSpeedHints

setQualityHints

loadIcon

getXdevWindowOf

getParentOfClass

getSharedFileChooser

createFolderChooser

showFolderChooser

showFolderChooser

showFolderChooser

showFileChooser

showFileChooser

showFileChooser

showFileChooser

createFileChooser

showColorChooser

lookupComponentTree

lookupComponentTree

getActiveWindow

showMessage

showMessage

showMessage

showConfirmMessage

showConfirmMessage

showConfirmMessage

showConfirmMessage

showConfirmMessage

showConfirmMessage

showConfirmMessage

getIP

pause

getComponentByName

getComponentByName

getApplet

createFrame

createFrame

createDialog

createDialog

createScreen

move

move

scale

scale

toFront

toBack

verifyFormularComponent

validateState

getMessageType

createImageFrom

setBorderTitle

toString

getTagData

setTagData

setEnabled

getChildrenOf

addChildren

insertMouseListener

removeMouseListener