net.sf.swinglib.components
Enum ProgressMonitor.Options

java.lang.Object
  java.lang.Enum<ProgressMonitor.Options>
      net.sf.swinglib.components.ProgressMonitor.Options

All Implemented Interfaces:

Serializable, Comparable<ProgressMonitor.Options>

Enclosing class:

ProgressMonitor

public static enum ProgressMonitor.Options
extends Enum<ProgressMonitor.Options>

Options to control the dialog's appearance. Rather than providing a plethora of constructors (like typical Swing dialogs), you can pass zero or more of these options to the base constructor.

Enum Constant Summary

CENTER
If present, the dialog will be displayed centered on its parent.

MODAL
If present, the dialog is modal.

NO_PROGRESS_BAR
If present, the dialog will be constructed without a progress bar (typically this is used with SHOW_STATUS).

SHOW_PERCENT_COMPLETE
If present, the progress bar displays completion percentage; by default it shows the count.

SHOW_STATUS
If present, the dialog will include space for a status message below the progress bar.

Method Summary

static ProgressMonitor.Options	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProgressMonitor.Options[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MODAL

public static final ProgressMonitor.Options MODAL

If present, the dialog is modal.

CENTER

public static final ProgressMonitor.Options CENTER

If present, the dialog will be displayed centered on its parent. If the dialog was constructed without a parent, it will be centered on the screen.

NO_PROGRESS_BAR

public static final ProgressMonitor.Options NO_PROGRESS_BAR

If present, the dialog will be constructed without a progress bar (typically this is used with SHOW_STATUS).

SHOW_STATUS

public static final ProgressMonitor.Options SHOW_STATUS

If present, the dialog will include space for a status message below the progress bar.

SHOW_PERCENT_COMPLETE

public static final ProgressMonitor.Options SHOW_PERCENT_COMPLETE

If present, the progress bar displays completion percentage; by default it shows the count.

Method Detail

values

public static final ProgressMonitor.Options[] values()

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

for(ProgressMonitor.Options c : ProgressMonitor.Options.values())
        System.out.println(c);

Returns:

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

valueOf

public static ProgressMonitor.Options 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