bibliothek.gui.dock.control.focus
Class DefaultFocusRequest

java.lang.Object
  bibliothek.gui.dock.control.focus.DefaultFocusRequest

All Implemented Interfaces:

FocusRequest

public class DefaultFocusRequest
extends Object
implements FocusRequest

The default implementation of a FocusRequest, the kind of request clients usually will use.

Author:

Benjamin Sigg

Constructor Summary

DefaultFocusRequest(DockElementRepresentative source, boolean force)
Creates a new request for setting the focused Dockable.

DefaultFocusRequest(DockElementRepresentative source, Component component, boolean force)
Creates a new request for setting the focused Dockable.

DefaultFocusRequest(DockElementRepresentative source, Component component, boolean force, boolean ensureFocusSet, boolean ensureDockableFocused)
Creates a new request for setting the focused Dockable.

DefaultFocusRequest(DockElementRepresentative source, Component component, boolean force, boolean ensureFocusSet, boolean ensureDockableFocused, boolean hardRequest)
Creates a new request for setting the focused Dockable.

Method Summary

boolean	acceptable(Component component) Tells whether component would be an acceptable Component to receive the focus.
Component	getComponent() Gets the Component which may receive the focus.
int	getDelay() Gets a delay in milliseconds, the FocusController will wait executing this request until the delay has passed.
DockElementRepresentative	getSource() Gets the source of this request.
FocusVetoListener.FocusVeto	getVeto() Tells whether the FocusVetoListeners approved of this request.
FocusRequest	grant(Component component) Called once this FocusRequest is granted, this request must now call a method like Component.requestFocusInWindow() on component.
boolean	isHardRequest() A hard request is not checked for correctness regarding the visibility or showing.
boolean	validate(FocusController controller) Invoked by controller right before this request is processed.
void	veto(FocusVetoListener.FocusVeto veto) Informs this request of the result of calling the FocusVetoListeners.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFocusRequest

public DefaultFocusRequest(DockElementRepresentative source,
                           boolean force)

Creates a new request for setting the focused Dockable.

Parameters:

source - the item to focus, may be null

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

DefaultFocusRequest

public DefaultFocusRequest(DockElementRepresentative source,
                           Component component,
                           boolean force)

Creates a new request for setting the focused Dockable.

Parameters:

source - the item to focus, may be null

component - the Component which triggered this request for example because the user clicked with the mouse on it. This request can assume that the focus will automatically be transfered to component by the Swing framework itself. Can be null, in which case this request decides on its own which Component to focus. This request 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 request must ensure that all properties are correct, false if some optimations are allowed. Clients normally can set this argument to false.

DefaultFocusRequest

public DefaultFocusRequest(DockElementRepresentative source,
                           Component component,
                           boolean force,
                           boolean ensureFocusSet,
                           boolean ensureDockableFocused)

Creates a new request for setting the focused Dockable.

Parameters:

source - the item to focus, may be null

component - the Component which triggered this request for example because the user clicked with the mouse on it. This request can assume that the focus will automatically be transfered to component by the Swing framework itself. Can be null, in which case this request decides on its own which Component to focus. This request 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 request must ensure that all properties are correct, false if some optimations are allowed. Clients normally can set this argument to false.

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

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

DefaultFocusRequest

public DefaultFocusRequest(DockElementRepresentative source,
                           Component component,
                           boolean force,
                           boolean ensureFocusSet,
                           boolean ensureDockableFocused,
                           boolean hardRequest)

Creates a new request for setting the focused Dockable.

Parameters:

source - the item to focus, may be null

component - the Component which triggered this request for example because the user clicked with the mouse on it. This request can assume that the focus will automatically be transfered to component by the Swing framework itself. Can be null, in which case this request decides on its own which Component to focus. This request 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 request must ensure that all properties are correct, false if some optimations are allowed. Clients normally can set this argument to false.

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

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

hardRequest - whether this request should be executed even if the involved Components are not visible.

Method Detail

getSource

public DockElementRepresentative getSource()

Description copied from interface: FocusRequest

Gets the source of this request. The source may be the Dockable which receives the focus, or the Component which received a MouseEvent. The source will be used to ask the FocusVetoListeners whether to accept this request or not.

Specified by:

getSource in interface FocusRequest

Returns:

the source of this request, may be null

getComponent

public Component getComponent()

Description copied from interface: FocusRequest

Gets the Component which may receive the focus. This is no necessarily the Component that gains the focus because the FocusStrategy may choose another Component. This Component may be not focusable, not visible, not showing, or not valid in any other respect. It is the FocusController's job to correct such issues.

Specified by:

getComponent in interface FocusRequest

Returns:

the Component which may receive the focus, can be null

getDelay

public int getDelay()

Description copied from interface: FocusRequest

Gets a delay in milliseconds, the FocusController will wait executing this request until the delay has passed.

Specified by:

getDelay in interface FocusRequest

Returns:

the delay in milliseconds, can be 0

isHardRequest

public boolean isHardRequest()

Description copied from interface: FocusRequest

A hard request is not checked for correctness regarding the visibility or showing. These requests can be executed even if the application is not yet visible.

Specified by:

isHardRequest in interface FocusRequest

Returns:

whether this request should be executable even if the involved Components are not visible

acceptable

public boolean acceptable(Component component)

Description copied from interface: FocusRequest

Tells whether component would be an acceptable Component to receive the focus. This method usually is called when FocusRequest.getComponent() returned an invalid Component (e.g. null or a component that is not focusable) and that Component gets replaced.

Specified by:

acceptable in interface FocusRequest

Parameters:

component - the component that might gain the focus

Returns:

true if this request approves on component replacing the result of FocusRequest.getComponent()

validate

public boolean validate(FocusController controller)

Description copied from interface: FocusRequest

Invoked by controller right before this request is processed. The method checks whether this request is still valid, e.g. a request may no longer be valid because it points to a Dockable that is no longer visible.

Specified by:

validate in interface FocusRequest

Parameters:

controller - the controller which will process this request

Returns:

true if this request is valid, false if this request is invalid and should be ignored

veto

public void veto(FocusVetoListener.FocusVeto veto)

Description copied from interface: FocusRequest

Informs this request of the result of calling the FocusVetoListeners. This method is called after FocusRequest.validate(FocusController).

Specified by:

veto in interface FocusRequest

Parameters:

veto - the veto that was cast, including no veto

getVeto

public FocusVetoListener.FocusVeto getVeto()

Tells whether the FocusVetoListeners approved of this request.

Returns:

the veto, may be null

grant

public FocusRequest grant(Component component)

Description copied from interface: FocusRequest

Called once this FocusRequest is granted, this request must now call a method like Component.requestFocusInWindow() on component.

Specified by:

grant in interface FocusRequest

Parameters:

component - the Component which gains the focus. Usually this Component is valid in the sense of that it is focusable, visible and showing. There are no guarantees for this properties tough.

Returns:

a new FocusRequest that will be executed. If the result of FocusRequest.getSource() of this and of the result matches, and if the result of FocusRequest.getComponent() is the same as component, then the FocusController will accept the request without calling neither FocusVetoListener nor FocusStrategy. In any other case the request will be treated like a completely new request. The result of this method can also be null. The result of this method can also by this.