oracle.dss.util.dimensionList
Class DimFindEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--oracle.dss.util.dimensionList.DimFindEvent

All Implemented Interfaces:

java.io.Serializable

public class DimFindEvent

extends java.util.EventObject

The event class that describes a number of events that are generated during processing.

See Also:

EventObject, Serialized Form

Field Summary

static int	FIND_ERROR The code that is sent if an unknown or unexpected error occurs.
static int	FIND_EXIT The code that is sent when the DimFindTool is exiting or closing.
static int	FIND_FINDHELP The code that is sent for a request to find the previous item.
static int	FIND_FINDNEXT The code that is sent for a request to find the next item.

Constructor Summary

DimFindEvent(java.lang.Object source)
Constructor.

DimFindEvent(java.lang.Object source, int id, java.lang.String str, int startPos, boolean bMatchCase, boolean bSearchDescendants, int iSearchChoice)
Constructor that specifies all arguments.

Method Summary

int	getId() Retrieves the identifier for this event.
boolean	getMatchCase() Retrieves whether the search is case-sensitive.
int	getPosition() Retrieves the starting search position.
int	getSearchChoice() Retrieves the type of search.
boolean	getSearchDecendents() Deprecated. As of 2.6.0.23, replaced by getSearchDescendants()
boolean	getSearchDescendants() Retrieves whether the search includes descendants.
java.lang.String	getText() Retrieves the search string.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FIND_ERROR

public static final int FIND_ERROR

The code that is sent if an unknown or unexpected error occurs.

FIND_EXIT

public static final int FIND_EXIT

The code that is sent when the DimFindTool is exiting or closing.

FIND_FINDNEXT

public static final int FIND_FINDNEXT

The code that is sent for a request to find the next item.

FIND_FINDHELP

public static final int FIND_FINDHELP

The code that is sent for a request to find the previous item.

Constructor Detail

DimFindEvent

public DimFindEvent(java.lang.Object source)

Constructor.

Parameters:

source - The object that is generating the event.

DimFindEvent

public DimFindEvent(java.lang.Object source,
                    int id,
                    java.lang.String str,
                    int startPos,
                    boolean bMatchCase,
                    boolean bSearchDescendants,
                    int iSearchChoice)

Constructor that specifies all arguments.

Parameters:

source - The object that is generating the event.

id - The identifier for this event.

str - The search string.

startPos - The starting index within a source from where the search begins.

bMatchCase - true if the search is case-sensitive, false if it is not.

bSearchDescendants - true if the descendants are searched, false if they are not.

Method Detail

getId

public int getId()

Retrieves the identifier for this event.

Returns:

An integer that represents the event identifier.

getText

public java.lang.String getText()

Retrieves the search string.

Returns:

A string that represents the search text.

getPosition

public int getPosition()

Retrieves the starting search position.

Returns:

An integer that represents the starting search position.

getMatchCase

public boolean getMatchCase()

Retrieves whether the search is case-sensitive.

Returns:

true if the search is case-sensitive, false if it is not.

getSearchDecendents

public boolean getSearchDecendents()

Deprecated. As of 2.6.0.23, replaced by getSearchDescendants()

Retrieves whether the search includes descendants.

Returns:

true if the search includes descendants false if it does not.

getSearchDescendants

public boolean getSearchDescendants()

Retrieves whether the search includes descendants.

Returns:

true if the search includes descendants false if it does not.

getSearchChoice

public int getSearchChoice()

Retrieves the type of search.

Returns:

An integer that represents the type of search.