bibliothek.gui.dock.control

Class DefaultFocusController

java.lang.Object

bibliothek.gui.dock.control.focus.AbstractFocusController

bibliothek.gui.dock.control.DefaultFocusController

All Implemented Interfaces:

FocusController

public class DefaultFocusController
extends AbstractFocusController

Default implementation of FocusController.

Author:

Benjamin Sigg

Constructor Summary

Constructors

Constructor and Description
DefaultFocusController(DockController controller) Creates a new focus-controller

Method Summary

Modifier and Type	Method and Description
protected Component	accept(FocusRequest request, Dockable dockable) Decides whether to execute or to refuse request.
FocusVetoListener.FocusVeto	checkFocusedDockable(DockElementRepresentative source) Checks whether source can be used to select the next focused Dockable.
void	ensureFocusSet(boolean dockableOnly) Ensures that a title or a Component of the currently focused Dockable really has the focus.
protected void	execute(FocusRequest request, Dockable dockable, Component component) Called if accept(FocusRequest, Dockable) accepted request.
void	focus(FocusRequest request) Requests focus for the Component that is described by request.
Dockable	getFocusedDockable() Gets the Dockable which is currently focused.
boolean	isOnFocusing() Tells whether one of the methods which change the focus is currently running, or not.
void	onFocusRequestCompletion(Runnable run) After the currently executed FocusRequest is completed, or if there is currently no FocusRequest running, run is executed.
FocusVetoListener.FocusVeto	setFocusedDockable(DockElementRepresentative source, Component component, boolean force, boolean ensureFocusSet, boolean ensureDockableFocused) Sets the Dockable which should have the focus.

Methods inherited from class bibliothek.gui.dock.control.focus.AbstractFocusController

addDockableFocusListener, addVetoListener, dockableFocusListeners, fireDockableFocused, fireVetoDockable, fireVetoTitle, freezeFocus, getController, getStrategy, isFrozen, meltFocus, removeDockableFocusListener, removeVetoListener, setStrategy

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFocusController

public DefaultFocusController(DockController controller)

Creates a new focus-controller

Parameters:

controller - the owner of this controller

Method Detail

isOnFocusing

public boolean isOnFocusing()

Description copied from interface: FocusController

Tells whether one of the methods which change the focus is currently running, or not. If the result is true, no-one should change the focus.

Returns:

true if the focus is currently changing

getFocusedDockable

public Dockable getFocusedDockable()

Description copied from interface: FocusController

Gets the Dockable which is currently focused.

Returns:

the focused element or null

checkFocusedDockable

public FocusVetoListener.FocusVeto checkFocusedDockable(DockElementRepresentative source)

Description copied from interface: FocusController

Checks whether source can be used to select the next focused Dockable.

Parameters:

source - the element which may be focused

Returns:

whether the focus can be transferred, a value of null indicates that source does not represent a Dockable

setFocusedDockable

public FocusVetoListener.FocusVeto setFocusedDockable(DockElementRepresentative source,
                                                      Component component,
                                                      boolean force,
                                                      boolean ensureFocusSet,
                                                      boolean ensureDockableFocused)

Description copied from interface: FocusController

Sets the Dockable which should have the focus.

Parameters:

source - the item to focus, may be null

component - the Component which triggered this call for example because the user clicked with the mouse on it. This method can assume that the focus will automatically be transferred to component by the Swing framework itself. Can be null, in which case this method decides on its own which Component to focus. This method may or may not do sanity checks concerning component. An invalid argument will silently be ignored and treated as if it would be null.

force - true if this controller must ensure that all properties are correct, false if some optimizations are allowed. Clients normally can set this argument to false.

ensureFocusSet - if true, then this method should make sure that either focusedDockable itself or one of its DockElementRepresentative is the focus owner

ensureDockableFocused - if true, then this method should make sure that focusedDockable is the focus owner. This parameter is stronger that ensureFocusSet

Returns:

whether focus could be transferred, a value of null indicates that FocusController.isOnFocusing() returned true and the call was ignored

ensureFocusSet

public void ensureFocusSet(boolean dockableOnly)

Description copied from interface: FocusController

Ensures that a title or a Component of the currently focused Dockable really has the focus.

Parameters:

dockableOnly - if true, then only the Dockable itself should be focused

focus

public void focus(FocusRequest request)

Requests focus for the Component that is described by request. The request is either executed now (if delay is 0) or in the near future. The request may be canceled either because another request is executed first, because of a FocusVetoListener, or because the request contains invalid data.

Parameters:

request - the request

onFocusRequestCompletion

public void onFocusRequestCompletion(Runnable run)

Description copied from interface: FocusController

After the currently executed FocusRequest is completed, or if there is currently no FocusRequest running, run is executed. If this controller is frozen, then run is executed Immediately.

Parameters:

run - some code to execute once a new Dockable has been focused

See Also:

FocusController.focus(FocusRequest)

accept

protected Component accept(FocusRequest request,
                           Dockable dockable)

Decides whether to execute or to refuse request.

Parameters:

request - the request to check

dockable - the dockable that would receive the focus through this request

Returns:

the accepted Component or null if the request is to be refused

execute

protected void execute(FocusRequest request,
                       Dockable dockable,
                       Component component)

Called if accept(FocusRequest, Dockable) accepted request.

Parameters:

request - the request to execute

dockable - the element that will receive the focus

component - the Component that is to be focused