org.jdesktop.application
Enum Task.BlockingScope

java.lang.Object
  extended by java.lang.Enum<Task.BlockingScope>
      extended by org.jdesktop.application.Task.BlockingScope
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Task.BlockingScope>
Enclosing class:
Task<T,V>

public static enum Task.BlockingScope
extends java.lang.Enum<Task.BlockingScope>

Specifies to what extent the GUI should be blocked a Task is executed by a TaskService. Input blocking is carried out by the Task's inputBlocker.

See Also:
Task.InputBlocker, Action.block()

Enum Constant Summary
ACTION
          Block an Action while the task is executing, typically by temporarily disabling it.
APPLICATION
          Block all of the application's top level windows, typically by showing a application-modal dialog.
COMPONENT
          Block a component while the task is executing, typically by temporarily disabling it.
NONE
          Don't block the GUI while this Task is executing.
WINDOW
          Block a top level window while the task is executing, typically by showing a window-modal dialog.
 
Method Summary
static Task.BlockingScope valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Task.BlockingScope[] 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 Task.BlockingScope NONE
Don't block the GUI while this Task is executing.


ACTION

public static final Task.BlockingScope ACTION
Block an Action while the task is executing, typically by temporarily disabling it.


COMPONENT

public static final Task.BlockingScope COMPONENT
Block a component while the task is executing, typically by temporarily disabling it.


WINDOW

public static final Task.BlockingScope WINDOW
Block a top level window while the task is executing, typically by showing a window-modal dialog.


APPLICATION

public static final Task.BlockingScope APPLICATION
Block all of the application's top level windows, typically by showing a application-modal dialog.

Method Detail

values

public static Task.BlockingScope[] 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 (Task.BlockingScope c : Task.BlockingScope.values())
    System.out.println(c);

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

valueOf

public static Task.BlockingScope valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null