icy.search

Class SearchResult

java.lang.Object

icy.search.SearchResult

All Implemented Interfaces:

java.lang.Comparable<SearchResult>

Direct Known Subclasses:

KernelSearchResultProducer.KernelSearchResult, PluginSearchResult

public abstract class SearchResult
extends java.lang.Object
implements java.lang.Comparable<SearchResult>

Defines an item in the SearchResultPanel.

Author:

Thomas Provoost & Stephane Dallongeville

Constructor Summary

Constructors

Constructor and Description
SearchResult(SearchResultProducer producer)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(SearchResult o) Default implementation
abstract void	execute() Executes the associated action for this result.
abstract void	executeAlternate() Executes the associated alternate action (right mouse button) for this result.
abstract java.lang.String	getDescription() Returns the description of the result.
abstract java.awt.Image	getImage() Returns the image of the result (can be null).
SearchResultProducer	getProducer()
abstract org.pushingpixels.flamingo.api.common.RichTooltip	getRichToolTip() Get the RichTooltip associated to the result.
abstract java.lang.String	getTitle() Returns the title of the result.
abstract java.lang.String	getTooltip() Returns the tooltip that will be displayed for this result.
boolean	isEnabled() Returns enabled state of the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResult

public SearchResult(SearchResultProducer producer)

Method Detail

getProducer

public SearchResultProducer getProducer()

Returns:

Returns the producer.

getTitle

public abstract java.lang.String getTitle()

Returns the title of the result.

getImage

public abstract java.awt.Image getImage()

Returns the image of the result (can be null).

getDescription

public abstract java.lang.String getDescription()

Returns the description of the result.

getTooltip

public abstract java.lang.String getTooltip()

Returns the tooltip that will be displayed for this result.

isEnabled

public boolean isEnabled()

Returns enabled state of the result.

execute

public abstract void execute()

Executes the associated action for this result.

executeAlternate

public abstract void executeAlternate()

Executes the associated alternate action (right mouse button) for this result.

getRichToolTip

public abstract org.pushingpixels.flamingo.api.common.RichTooltip getRichToolTip()

Get the RichTooltip associated to the result.

compareTo

public int compareTo(SearchResult o)

Default implementation

Specified by:

compareTo in interface java.lang.Comparable<SearchResult>