Skip navigation links

oracle.javatools.ui.search
Enum SearchField.Style

java.lang.Object
java.lang.Enum<SearchField.Style>
oracle.javatools.ui.search.SearchField.Style

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SearchField.Style>

Enclosing class:

SearchField

public static enum SearchField.Style

extends java.lang.Enum<SearchField.Style>

The style of search supported by an instance of SearchField. You set the style using SearchField.setStyle(Style).

Enum Constant Summary

FILTER
A filter is search that restricts an existing data set.

FIND
A find is appropriate when users want to navigate an existing data set matching item by item.

SEARCH
A search creates a new data set based on specified criteria, or filters an existing data set when using FILTER would not be fast enough.

Method Summary

static SearchField.Style	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SearchField.Style[]	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

FILTER

public static final SearchField.Style FILTER

A filter is search that restricts an existing data set. You should use a filter when:

• You start with existing data and want to refine it based on some search term.
• The filtering can be executed in a highly performant fashion. If results cannot be fetched in under one second, use an explicit search (SEARCH).
• You want filtering to execute automatically as the user types.

SEARCH

public static final SearchField.Style SEARCH

A search creates a new data set based on specified criteria, or filters an existing data set when using FILTER would not be fast enough.

Searching is not triggered as the user types, instead the user must explicitly invoke the search by clicking on a "Go" button.

FIND

public static final SearchField.Style FIND

A find is appropriate when users want to navigate an existing data set matching item by item.

Method Detail

values

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

Returns:

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

valueOf

public static SearchField.Style 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

Skip navigation links