public abstract class SearchProgress
extends java.lang.Object
SearchListener
to notify the
SearchField
of search progress. This is only used when the
style
of the SearchField
is
SearchField.Style.SEARCH
.
Obtain an object implementing this interface using
SearchEvent.getSearchProgress()
.
API users should not extend this class directly. It is implemented
internally by the SearchField
.
It is safe to call all methods defined in this class on instances
returned from SearchEvent.getSearchProgress()
from any thread.
Constructor and Description |
---|
SearchProgress() |
Modifier and Type | Method and Description |
---|---|
abstract void |
finish()
Notifies the
SearchField that the search is complete. |
boolean |
isStopped()
Indicates whether the user requested that the search be stopped.
|
void |
setDeterminate(int totalSteps)
Indicates that searching will take a determinate number of steps to
complete.
|
void |
setProgress(int progress)
Sets the current progress of the search.
|
public final boolean isStopped()
finish()
method when the search is
complete, whether or not it was stopped.public void setDeterminate(int totalSteps)
SearchField
that it can
use determinate progress UI. By default, the field will use indeterminate
progress.
You should call setProgress( int )
as each step is complete to
notify the SearchField
to update its progress UI.
You should not call this method twice on the same instance of
SearchProgress
. Once you have established the total number of
steps, it should not change during the progress of a search
totalSteps
- specifies the number of distinct steps that this
search will take. Must be greater than 0.java.lang.IllegalArgumentException
- if totalSteps is less than or
equal to zero.java.lang.IllegalStateException
- if you call this method twice on the same
instance.public void setProgress(int progress)
setDeterminate(int)
.
You should only call this method if the setDeterminate(int)
method has previously been called to establish that this search will
take a specific number of steps.
progress
- the number of completed steps. Must be greater than the
zero and less than or equal to the number of total steps. If you
specify a value that is less than the current progress, it will be
ignored.java.lang.IllegalArgumentException
- if progress is less than or
equal to zero, or greater than the number of steps specified by
setDeterminate(int)
.java.lang.IllegalStateException
- if setDeterminate(int)
was
never called to establish the total number of steps.public abstract void finish()
SearchField
that the search is complete. You must
always call this when the search completes (whether it was successful or
not, and even if the user canceled the search) to reset the search field.