bibliothek.gui.dock.event

Enum FocusVetoListener.FocusVeto

java.lang.Object

java.lang.Enum<FocusVetoListener.FocusVeto>

bibliothek.gui.dock.event.FocusVetoListener.FocusVeto

All Implemented Interfaces:

Serializable, Comparable<FocusVetoListener.FocusVeto>

Enclosing interface:

FocusVetoListener

public static enum FocusVetoListener.FocusVeto
extends Enum<FocusVetoListener.FocusVeto>

Tells how to react on a potential change of the focus.

Author:

Benjamin Sigg

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE No veto, allows the focus to be transferred to a new element
VETO Focus transfer is canceled, and the event leading to the transfer is consumed (meaning: the event is marked as invalid and components will not process it).
VETO_NO_CONSUME Focus transfer is canceled, but the event leading to the transfer is allowed to be processed.

Method Summary

Modifier and Type	Method and Description
static FocusVetoListener.FocusVeto	valueOf(String name) Returns the enum constant of this type with the specified name.
static FocusVetoListener.FocusVeto[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final FocusVetoListener.FocusVeto NONE

No veto, allows the focus to be transferred to a new element

VETO

public static final FocusVetoListener.FocusVeto VETO

Focus transfer is canceled, and the event leading to the transfer is consumed (meaning: the event is marked as invalid and components will not process it).

VETO_NO_CONSUME

public static final FocusVetoListener.FocusVeto VETO_NO_CONSUME

Focus transfer is canceled, but the event leading to the transfer is allowed to be processed. This behavior can lead to components wrongly process the event and make hide a Dockable that should have the focus. Client code should in general use VETO.

Method Detail

values

public static FocusVetoListener.FocusVeto[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FocusVetoListener.FocusVeto c : FocusVetoListener.FocusVeto.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FocusVetoListener.FocusVeto valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null