com.alee.managers.focus

Class DefaultFocusTracker

java.lang.Object

com.alee.managers.focus.DefaultFocusTracker

All Implemented Interfaces:

FocusTracker

public abstract class DefaultFocusTracker
extends Object
implements FocusTracker

Default FocusTracker implementation for FocusTracker usage convenience. This implementation also offers customization of additional focusable Components attached to tracked JComponent.

Author:

Mikle Garin

See Also:

How to use FocusManager, FocusManager

Field Summary

Fields

Modifier and Type	Field and Description
protected JComponent	component Tracked JComponent.
protected boolean	enabled Whether or not tracking is currently enabled.
protected Set<Component>	focusableChildren Additional focusable children which should be tracked in addition to the main tracked JComponent.
protected boolean	focused Whether or not tracked JComponent is currently focused according to this tracker settings.
protected boolean	uniteWithChildren Whether or not tracked JComponent and its children should be counted as a single focusable unit.

Constructor Summary

Constructors

Constructor and Description
DefaultFocusTracker(JComponent component, boolean uniteWithChildren) Constructs new DefaultFocusTracker.

Method Summary

Modifier and Type	Method and Description
void	addFocusableChild(Component child) Adds new focusable child Component.
List<Component>	getFocusableChildren() Returns additional focusable children which should be tracked in addition to the main tracked JComponent.
protected boolean	isChildInvolved(Component tracked, Component component) Returns whether specified Component is involved with this tracked Component or not.
boolean	isEnabled() Returns whether or not tracking is currently enabled.
protected boolean	isEqual(Component tracked, Component component) Returns whether or not specified Component is equal to tracked Component.
protected boolean	isEqualOrChild(Component tracked, Component component) Returns whether or not specified Component is equal to tracked Component or any of its children.
boolean	isFocused() Returns whether or not tracked component is currently focused according to this tracker settings.
boolean	isInvolved(JComponent tracked, Component component) Returns whether specified Component is involved with this tracked JComponent or not.
protected boolean	isRelated(Component tracked, Component component) Returns whether or not specified Component is related to tracked Component.
protected boolean	isTrackingWindow(Component tracked) Returns whether or not tracked Component references an actual Window that should be tracked.
boolean	isUniteWithChildren() Returns whether or not tracked JComponent and its children should be counted as a single focusable unit.
void	removeFocusableChild(Component child) Removes focusable child Component.
void	setEnabled(boolean enabled) Sets whether or not tracking is currently enabled.
void	setFocused(boolean focused) Sets tracked component focused state.
void	setUniteWithChildren(boolean unite) Sets whether or not tracked JComponent and its children should be counted as a single focusable unit.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.alee.managers.focus.FocusTracker

focusChanged

Field Detail

component

@NotNull
protected final JComponent component

Tracked JComponent.

uniteWithChildren

protected boolean uniteWithChildren

Whether or not tracked JComponent and its children should be counted as a single focusable unit. In case component and its children are counted as one unit - focus changes between them will be ignored by tracker.

focusableChildren

@Nullable
protected Set<Component> focusableChildren

Additional focusable children which should be tracked in addition to the main tracked JComponent. Note that this Set is backed by WeakHashSet implementation to avoid any memory leaks. So it is safe to add any components here, even ones that might be removed at some point.

enabled

protected boolean enabled

Whether or not tracking is currently enabled.

focused

protected boolean focused

Whether or not tracked JComponent is currently focused according to this tracker settings.

Constructor Detail

DefaultFocusTracker

public DefaultFocusTracker(@NotNull
                           JComponent component,
                           boolean uniteWithChildren)

Constructs new DefaultFocusTracker.

Parameters:

component - tracked JComponent

uniteWithChildren - whether or not tracked JComponent and its children should be counted as a single focusable unit

Method Detail

isUniteWithChildren

public boolean isUniteWithChildren()

Returns whether or not tracked JComponent and its children should be counted as a single focusable unit. In case component and its children are counted as one unit - focus changes between them will be ignored by tracker.

Returns:

true if tracked JComponent and its children should be counted as a single focusable unit, false otherwise

setUniteWithChildren

public void setUniteWithChildren(boolean unite)

Sets whether or not tracked JComponent and its children should be counted as a single focusable unit. In case component and its children are counted as one unit - focus changes between them will be ignored by tracker.

Parameters:

unite - whether or not tracked JComponent and its children should be counted as a single focusable unit

getFocusableChildren

@NotNull
public List<Component> getFocusableChildren()

Returns additional focusable children which should be tracked in addition to the main tracked JComponent. Note that uniteWithChildren setting also affects how these children focus is checked.

Returns:

custom children which should be tracked together with this component

addFocusableChild

public void addFocusableChild(@NotNull
                              Component child)

Adds new focusable child Component. Note that uniteWithChildren setting also affects how these children focus is checked.

Parameters:

child - focusable child Component to add

removeFocusableChild

public void removeFocusableChild(@NotNull
                                 Component child)

Removes focusable child Component. Note that uniteWithChildren setting also affects how these children focus is checked.

Parameters:

child - focusable child Component to remove

isEnabled

public boolean isEnabled()

Description copied from interface: FocusTracker

Returns whether or not tracking is currently enabled.

Specified by:

isEnabled in interface FocusTracker

Returns:

true if tracking is currently enabled, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: FocusTracker

Sets whether or not tracking is currently enabled.

Specified by:

setEnabled in interface FocusTracker

Parameters:

enabled - whether or not tracking is currently enabled

isFocused

public boolean isFocused()

Description copied from interface: FocusTracker

Returns whether or not tracked component is currently focused according to this tracker settings.

Specified by:

isFocused in interface FocusTracker

Returns:

true if tracked component is currently focused according to this tracker settings, false otherwise

setFocused

public void setFocused(boolean focused)

Description copied from interface: FocusTracker

Sets tracked component focused state.

Specified by:

setFocused in interface FocusTracker

Parameters:

focused - component focused state

isInvolved

public boolean isInvolved(@NotNull
                          JComponent tracked,
                          @Nullable
                          Component component)

Description copied from interface: FocusTracker

Returns whether specified Component is involved with this tracked JComponent or not. It basically says whether or not specified Component counts towards tracked JComponent focus changes.

Specified by:

isInvolved in interface FocusTracker

Parameters:

tracked - tracked JComponent

component - Component to check for involvement

Returns:

true if specified Component is involved with this tracked JComponent, false otherwise

isChildInvolved

protected boolean isChildInvolved(@NotNull
                                  Component tracked,
                                  @NotNull
                                  Component component)

Returns whether specified Component is involved with this tracked Component or not.

Parameters:

tracked - tracked Component

component - involved Component

Returns:

true if specified Component is involved with this tracked Component, false otherwise

isRelated

protected boolean isRelated(@NotNull
                            Component tracked,
                            @NotNull
                            Component component)

Returns whether or not specified Component is related to tracked Component. This will check whether or not specified Component is equal to tracked Component or any of its children. It will also check additional cases when tracked Component is referencing a tracked Window.

Parameters:

tracked - tracked Component

component - involved Component

Returns:

true if specified Component is equal to tracked Component, false otherwise

isEqualOrChild

protected boolean isEqualOrChild(@NotNull
                                 Component tracked,
                                 @NotNull
                                 Component component)

Returns whether or not specified Component is equal to tracked Component or any of its children.

Parameters:

tracked - tracked Component

component - involved Component

Returns:

true if specified Component is equal to tracked Component or any of its children, false otherwise

isEqual

protected boolean isEqual(@NotNull
                          Component tracked,
                          @NotNull
                          Component component)

Returns whether or not specified Component is equal to tracked Component.

Parameters:

tracked - tracked Component

component - involved Component

Returns:

true if specified Component is equal to tracked Component, false otherwise

isTrackingWindow

protected boolean isTrackingWindow(@NotNull
                                   Component tracked)

Returns whether or not tracked Component references an actual Window that should be tracked.

Parameters:

tracked - tracked Component

Returns:

true if tracked Component references an actual Window that should be tracked, false otherwise