org.jivesoftware.sparkimpl.search.users
Class UserSearchService

java.lang.Object
  org.jivesoftware.sparkimpl.search.users.UserSearchService

All Implemented Interfaces:

Searchable

public class UserSearchService
extends java.lang.Object
implements Searchable

Constructor Summary

UserSearchService()

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.util.Collection	getSearchServices() Return the Search Services discovered by the client.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserSearchService

public UserSearchService()

Method Detail

search

public void search(java.lang.String query)

Description copied from interface: Searchable

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

Specified by:

search in interface Searchable

Parameters:

query - the explict query.

getSearchServices

public java.util.Collection getSearchServices()

Return the Search Services discovered by the client.

Returns:

the discovered search services.

getToolTip

public java.lang.String getToolTip()

Description copied from interface: Searchable

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

Specified by:

getToolTip in interface Searchable

Returns:

the tooltip text.

getDefaultText

public java.lang.String getDefaultText()

Description copied from interface: Searchable

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

Specified by:

getDefaultText in interface Searchable

Returns:

the default text.

getName

public java.lang.String getName()

Description copied from interface: Searchable

Return the name of your plugin.

Specified by:

getName in interface Searchable

Returns:

the name of your searchable object.

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: Searchable

Return the icon you wish to use in the IconTextField.

Specified by:

getIcon in interface Searchable

Returns:

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