java.lang.Object | |
↳ | android.widget.Filter |
A filter constrains data with a filtering pattern.
Filters are usually created by Filterable
classes.
Filtering operations performed by calling filter(CharSequence)
or
filter(CharSequence, android.widget.Filter.FilterListener)
are
performed asynchronously. When these methods are called, a filtering request
is posted in a request queue and processed later. Any call to one of these
methods will cancel any previous non-executed filtering request.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Filter.FilterListener | Listener used to receive a notification upon completion of a filtering operation. |
||||||||||
Filter.FilterResults | Holds the results of a filtering operation. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new asynchronous filter. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Converts a value from the filtered set into a CharSequence. | |||||||||||
Starts an asynchronous filtering operation. | |||||||||||
Starts an asynchronous filtering operation. |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Invoked in a worker thread to filter the data according to the constraint. | |||||||||||
Invoked in the UI thread to publish the filtering results in the user interface. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Converts a value from the filtered set into a CharSequence. Subclasses should override this method to convert their results. The default implementation returns an empty String for null values or the default String representation of the value.
resultValue | the value to convert to a CharSequence |
---|
Starts an asynchronous filtering operation. Calling this method cancels all previous non-executed filtering requests and posts a new filtering request that will be executed later.
Upon completion, the listener is notified.
constraint | the constraint used to filter the data |
---|---|
listener | a listener notified upon completion of the operation |
Starts an asynchronous filtering operation. Calling this method cancels all previous non-executed filtering requests and posts a new filtering request that will be executed later.
constraint | the constraint used to filter the data |
---|
Invoked in a worker thread to filter the data according to the
constraint. Subclasses must implement this method to perform the
filtering operation. Results computed by the filtering operation
must be returned as a Filter.FilterResults
that
will then be published in the UI thread through
publishResults(CharSequence, android.widget.Filter.FilterResults)
.
Contract: When the constraint is null, the original data must be restored.
constraint | the constraint used to filter the data |
---|
Invoked in the UI thread to publish the filtering results in the
user interface. Subclasses must implement this method to display the
results computed in performFiltering(CharSequence)
.
constraint | the constraint used to filter the data |
---|---|
results | the results of the filtering operation |