oracle.ide.inspector.find

Interface SearchableContainer

All Known Implementing Classes:

AbstractAdditionalPage, PropertyInspector

public interface SearchableContainer

SearchableContainer is an interface to be implemented by components that will participate in the property label text searching initiated by the user from the PropertyInspector's toolbar.

The SearchableContainer must be capable of iterating its own subcomponents either forward or backward. A SearchableContainer is also expected to remember the property label matched by a previous call to findText so that if the search is repeated, it can continue from the previous match.

It is recommended that a custom component within PropertyInspector use PropertyLabel rather than JLabel as the label for a property because PropertyLabel has methods to support searching and highlighting the matching label text.

There is a default implementation of findText for SearchableContainers. To make use of it, embed an instance of ContainerSearch in the class implementing SearchableContainer, and delegate the findText call to it.

See Also:

PropertyLabel, PropertyRadioButton, PropertyCheckBox, ContainerSearch

Method Summary

Methods

Modifier and Type	Method and Description
boolean	findText(java.lang.String searchText, boolean searchForward, boolean searchRepeat) Find the specified searchText by searching forward or backward through the property labels of the Searchable component.

Method Detail

findText

boolean findText(java.lang.String searchText,
               boolean searchForward,
               boolean searchRepeat)

Find the specified searchText by searching forward or backward through the property labels of the Searchable component.

An implementation of this method should perform the following steps:

• If a label was previously found in this component, its highlight should be cleared (see PropertyLabel.clearHighlight).
• If the searchText length is zero, return false. If there was a previously found label, its highlight should be cleared before returning.
• Iterate the contained labels either forward or backward. If a previous invocation of findText found a match, skip the iterated items until the previous match is reached. Once the previous match is reached, it is probably a good time to null out the saved reference to the previous match. If searchRepeat is false, start looking for a match at this point. If searchRepeat is true, start looking for a match on the next iteration.
• If a property label containing the specified searchText is found, the Searchable component should make sure the label is visible and highlighted. Using PropertyText.findLabel will ensure that the matching text in the label is highlighted. Ensuring that the label is actually visible is implementation dependent, but will likely involve calling scrollRectToVisible using the label's bounds. The Searchable component should also remember the matched label for the next invocation.

Parameters:

searchText - the text to be found.

searchForward - the direction of the search.

searchRepeat - repeat the search starting beyond the last match location (if any)

Returns:

true if a property label containing the searchText could be found.

See Also:

ContainerSearch