org.jivesoftware.spark.search
Interface Searchable

All Known Implementing Classes:

UserSearchService

public interface Searchable

Plugin writers will implement Searchable in order to tie into the find feature in Spark.

Method Summary

java.lang.String	getDefaultText() Return the default text that appears in the textfield when a user selects it in the dropdown list.
javax.swing.Icon	getIcon() Return the icon you wish to use in the IconTextField.
java.lang.String	getName() Return the name of your plugin.
java.lang.String	getToolTip() Return the text you wish to show in the tooltip when a user hovers over the searchable find field.
void	search(java.lang.String query) Is called whenver a user does an explict search within Spark.

Method Detail

getIcon

javax.swing.Icon getIcon()

Return the icon you wish to use in the IconTextField.

Returns:

the icon you wish to use in the icon text field.

getName

java.lang.String getName()

Return the name of your plugin.

Returns:

the name of your searchable object.

getDefaultText

java.lang.String getDefaultText()

Return the default text that appears in the textfield when a user selects it in the dropdown list.

Returns:

the default text.

getToolTip

java.lang.String getToolTip()

Return the text you wish to show in the tooltip when a user hovers over the searchable find field.

Returns:

the tooltip text.

search

void search(java.lang.String query)

Is called whenver a user does an explict search within Spark. You are responsible for the searching and displaying of the search results.

Parameters:

query - the explict query.