org.assertj.swing.core

Enum ComponentLookupScope

java.lang.Object

java.lang.Enum<ComponentLookupScope>

org.assertj.swing.core.ComponentLookupScope

All Implemented Interfaces:

Serializable, Comparable<ComponentLookupScope>

public enum ComponentLookupScope
extends Enum<ComponentLookupScope>

Scopes of AWT or Swing Component lookups.

Author:

Alex Ruiz

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL All AWT or Swing Components participate in a lookup, regardless if they are being shown on the screen or not.
DEFAULT For most of the cases, only AWT or Swing Components that are being shown on the screen participate in a lookup.
SHOWING_ONLY Only AWT or Swing Components that are being shown on the screen can participate in a lookup.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	requireShowing() Returns whether showing AWT or Swing Components are the only ones participating in lookups.
static ComponentLookupScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static ComponentLookupScope[]	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

DEFAULT

public static final ComponentLookupScope DEFAULT

For most of the cases, only AWT or Swing Components that are being shown on the screen participate in a lookup. Currently, the only exception is JMenuItem, which participates in a lookup regardless if it is showing or not.

ALL

public static final ComponentLookupScope ALL

All AWT or Swing Components participate in a lookup, regardless if they are being shown on the screen or not.

SHOWING_ONLY

public static final ComponentLookupScope SHOWING_ONLY

Only AWT or Swing Components that are being shown on the screen can participate in a lookup.

Method Detail

values

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

Returns:

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

valueOf

public static ComponentLookupScope 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

requireShowing

public boolean requireShowing()

Returns whether showing AWT or Swing Components are the only ones participating in lookups.

Returns:

true if only showing Components participate in lookups; false if any Component (showing or not showing) can participate in lookup.