Package docking

Class DockingUtils

java.lang.Object

docking.DockingUtils

public class DockingUtils
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DockingUtils.ComponentCallback<T extends java.awt.Component>	A callback to operate on a component
static class	DockingUtils.TreeTraversalOrder	Specifies the order of component traversal
static class	DockingUtils.TreeTraversalResult	Controls traversal and communicates cause for termination

Field Summary

Fields

Modifier and Type	Field	Description
static int	CONTROL_KEY_MODIFIER_MASK	System dependent mask for the Ctrl key
static int	CONTROL_KEY_MODIFIER_MASK_DEPRECATED	Deprecated. use instead CONTROL_KEY_MODIFIER_MASK
static java.lang.String	CONTROL_KEY_NAME

Constructor Summary

Constructors

Constructor	Description
DockingUtils()

Method Summary

Modifier and Type	Method	Description
static javax.swing.JSeparator	createToolbarSeparator()
static DockingUtils.TreeTraversalResult	forAllDescendants(java.awt.Container start, DockingUtils.ComponentCallback<java.awt.Component> cb)	Perform some operation on a component and all of its descendents, recursively.
static <T extends java.awt.Component> DockingUtils.TreeTraversalResult	forAllDescendants(java.awt.Container start, java.lang.Class<T> type, DockingUtils.TreeTraversalOrder order, DockingUtils.ComponentCallback<T> cb)	Perform some operation on a component and all of its descendants, recursively This traverses the swing/awt component tree starting at the given container and descends recursively through all containers.
static UndoRedoKeeper	installUndoRedo(javax.swing.text.JTextComponent textComponent)
static boolean	isControlModifier(java.awt.event.KeyEvent keyEvent)	Checks if the mouseEvent has the "control" key down.
static boolean	isControlModifier(java.awt.event.MouseEvent mouseEvent)	Checks if the mouseEvent has the "control" key down.
static javax.swing.Icon	scaleIconAsNeeded(javax.swing.Icon icon)
static void	setTransparent(javax.swing.JComponent c)	Sets the given component to transparent, which allows the parent component's background to be painted.

Methods inherited from class java.lang.Object

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

Field Detail

CONTROL_KEY_MODIFIER_MASK

public static final int CONTROL_KEY_MODIFIER_MASK

System dependent mask for the Ctrl key

CONTROL_KEY_MODIFIER_MASK_DEPRECATED

@Deprecated
public static final int CONTROL_KEY_MODIFIER_MASK_DEPRECATED

Deprecated.

use instead CONTROL_KEY_MODIFIER_MASK

A version the control key modifiers that is based upon the pre-Java 9 InputEvent usage. This mask is here for those clients that cannot be upgraded, such as those with dependencies on 3rd-party libraries that still use the old mask style.

CONTROL_KEY_NAME

public static final java.lang.String CONTROL_KEY_NAME

Constructor Detail

DockingUtils

public DockingUtils()

Method Detail

createToolbarSeparator

public static javax.swing.JSeparator createToolbarSeparator()

scaleIconAsNeeded

public static javax.swing.Icon scaleIconAsNeeded(javax.swing.Icon icon)

isControlModifier

public static boolean isControlModifier(java.awt.event.MouseEvent mouseEvent)

Checks if the mouseEvent has the "control" key down. On windows, this is actually the control key. On Mac, it is the command key.

Parameters:

mouseEvent - the event to check

Returns:

true if the control key is pressed

isControlModifier

public static boolean isControlModifier(java.awt.event.KeyEvent keyEvent)

Checks if the mouseEvent has the "control" key down. On windows, this is actually the control key. On Mac, it is the command key.

Parameters:

keyEvent - the event to check

Returns:

true if the control key is pressed

installUndoRedo

public static UndoRedoKeeper installUndoRedo(javax.swing.text.JTextComponent textComponent)

forAllDescendants

public static <T extends java.awt.Component> DockingUtils.TreeTraversalResult forAllDescendants(java.awt.Container start,
                                                                                                java.lang.Class<T> type,
                                                                                                DockingUtils.TreeTraversalOrder order,
                                                                                                DockingUtils.ComponentCallback<T> cb)

Perform some operation on a component and all of its descendants, recursively This traverses the swing/awt component tree starting at the given container and descends recursively through all containers. Any time a component of type (or subclass of type) is found, the given callback is executed on it. If order is DockingUtils.TreeTraversalOrder.CHILDREN_FIRST, then the traversal will execute the callback on the children of a container before executing the callback on the container itself; if DockingUtils.TreeTraversalOrder.PARENT_FIRST, then the traversal will execute the callback on the container before descending. The callback must return one of three result values. In normal circumstances, it should return DockingUtils.TreeTraversalResult.CONTINUE, allowing traversal to continue to the next element. If the callback wishes to terminate traversal "successfully," e.g., because it needed to locate the first element satisfying some predicate, then it should return DockingUtils.TreeTraversalResult.FINISH. If an error occurs during traversal, then it should either return DockingUtils.TreeTraversalResult.TERMINATE or throw an appropriate exception to terminate traversal "unsuccessfully." This method will also return a value of DockingUtils.TreeTraversalResult indicating how traversal terminated. If DockingUtils.TreeTraversalResult.CONTINUE, then every element in the subtree was visited, and traversal was successful. If DockingUtils.TreeTraversalResult.FINISH, then some elements may have been omitted, but traversal was still successful. If DockingUtils.TreeTraversalResult.TERMINATE, then some elements may have been omitted, and traversal was not successful.

Parameters:

start - the "root" container of the subtree on which to operate

type - the type of components on which to operate

order - whether to operation on children or parents first

cb - the callback to perform the actual operation

Returns:

a result indicating whether or not traversal completed successfully

forAllDescendants

public static DockingUtils.TreeTraversalResult forAllDescendants(java.awt.Container start,
                                                                 DockingUtils.ComponentCallback<java.awt.Component> cb)

Perform some operation on a component and all of its descendents, recursively. This applies the operation to all components in the tree, children first.

Parameters:

start - the "root" container of the subtree on which to operate

cb - the callback to perform the actual operation

Returns:

a result indicating whether or not traversal completed successfully

See Also:

forAllDescendants(Container, Class, TreeTraversalOrder, ComponentCallback)

setTransparent

public static void setTransparent(javax.swing.JComponent c)

Sets the given component to transparent, which allows the parent component's background to be painted.

Notes Historically, to make a component transparent you would call JComponent.setOpaque(boolean) with a false value. However, it turns out that the definition and the implementation of this method are at odds. setOpaque(false) is meant to signal that some part of the component is transparent, so the parent component needs to be painted. Most LaFs implemented this by not painting the background of the component, but used the parent's color instead. The Nimbus LaF actually honors the contract of setOpaque(), which has the effect of painting the components background by default.

This method allows components to achieve transparency when they used to rely on setOpaque(false).

Parameters:

c - the component to be made transparent