workspace
Interface SearchableContainer

All Known Implementing Classes:
FactoryCanvas, MiniMap, Page

public interface SearchableContainer

Denotes objects that contain SearchableElements that may be searched by a search bar.


Method Summary
 java.lang.Iterable<? extends SearchableElement> getSearchableElements()
          Returns all of the searchable elements within this Searchable.
 void updateContainsSearchResults(boolean containsSearchResults)
          Called by the search bar to update the Searchable of whether it currently belongs to the search bar's results.
 

Method Detail

getSearchableElements

java.lang.Iterable<? extends SearchableElement> getSearchableElements()
Returns all of the searchable elements within this Searchable. For example, the MiniMap contains RenderableBlocks, which may be searched.

Returns:
the SearchableElements contained within this SearchableContainer.

updateContainsSearchResults

void updateContainsSearchResults(boolean containsSearchResults)
Called by the search bar to update the Searchable of whether it currently belongs to the search bar's results. Guaranteed to be called on the Swing thread. It is the responsibility of this SearchableContainer to update any necessary state and repaint any necessary components as a result of a call to this method.

Parameters:
containsSearchResults - true when the SearchableContainer is part of the current results.