ice.ri.common.search
Interface SearchStatusEventListener

All Superinterfaces:

EventListener

All Known Implementing Classes:

SearchPanel, SearchStatusEventAdapter

public interface SearchStatusEventListener

extends EventListener

The listener interface for receiving search result or status fired from SearchHelper, which basically is a helper class of ice.pilots.html4.Search for frameset support.

The class that is interested in processing the search status must implements this interface to set search result message or enable/disable find buttons.

The class that implements this interface needs to be registered to SearchHelper using addStatusChangeListener method.

Since:

6.1

Author:

ICEsoft Technologies Inc.

See Also:

SearchStatusEventAdapter, SearchHelper

Method Summary

void	reset(int signal) Invoked when the document of top level Viewport or child Viewport is changed.
void	setSearchEnabled(boolean b) Invoked when executing search is currently allowed or disallowed.
void	setSearchStatusMessage(int status, int number_of_matches) Invoked when search result message needs to be set.

Method Detail

setSearchStatusMessage

public void setSearchStatusMessage(int status,
                                   int number_of_matches)

Invoked when search result message needs to be set.

Parameters:

status -

• SearchHelper.MATCH_FOUND if search found match.
• SearchHelper.NO_MATCH_FOUND if search did not find match.
• SearchHelper.END_OF_SEARCH if search has reached the end of the page

number_of_matches - The number of matches found. It is meaningful only if status equals SearchHelper.MATCH_FOUND and number_of_matches > 0.

setSearchEnabled

public void setSearchEnabled(boolean b)

Invoked when executing search is currently allowed or disallowed. This method can be used to enable or disable search buttons. This is useful when you use it in a non-modal form because search operation should be disabled when browser is in the process of loading new document.

Parameters:

b - true if executing search is allowed, false otherwise.

reset

public void reset(int signal)

Invoked when the document of top level Viewport or child Viewport is changed. This is useful when you use it in a non-modal form.

Parameters:

signal -

• SearchHelper.RESET_ALL, document of top level Viewport is changed and HIGHLIGHT button, WHOLE-WORD and MATCH-CASE check boxes need to be reset.
• SearchHelper.RESET_HIGHLIGHT, document of a child Viewport is changed and for example HIGHLIGHT button needs to be reset.