public class TextComponentSearchable extends Searchable implements javax.swing.event.DocumentListener, java.beans.PropertyChangeListener
TextComponentSearchable
is an concrete implementation of Searchable
that enables the search
function in JTextComponent. It's very simple to use it. Assuming you have a JTextComponent, all you need to do is
to call
Now the JTextComponent will have the search function.
JTextComponent textComponent = ....;
TextComponentSearchable searchable = new TextComponentSearchable(textComponent);
JTextComponent textComponent = ....;
TextComponentSearchable searchable = new ListSearchable(textComponent) {
protected String convertElementToString(Object object) {
...
}
protected boolean isActivateKey(KeyEvent e) { // change to a different activation key
return (e.getID() == KeyEvent.KEY_PRESSED && e.getKeyCode() == KeyEvent.VK_F &&
(KeyEvent.CTRL_MASK & e.getModifiers()) != 0);
}
};
Additional customization can be done on the base Searchable class such as background and foreground color,
keystrokes, case sensitivity. TextComponentSearchable also has a special attribute called highlightColor. You can
change it using setHighlightColor(java.awt.Color)
.
Due to the special case of JTextComponent, the searching doesn't support wild card '*' or '?' as in other
Searchables. The other difference is JTextComponent will keep the highlights after search popup hides. If you want to
hide the highlights, just press ESC again (the first ESC will hide popup; the second ESC will hide all highlights if
any).Searchable.SearchField, Searchable.SearchPopup
_component, _componentListener, _focusListener, _keyListener, CLIENT_PROPERTY_SEARCHABLE, listenerList, PROPERTY_SEARCH_TEXT
Constructor and Description |
---|
TextComponentSearchable(javax.swing.text.JTextComponent textComponent) |
Modifier and Type | Method and Description |
---|---|
protected void |
addHighlight(int index,
java.lang.String text,
boolean incremental)
Adds highlight to text component at specified index and text.
|
void |
changedUpdate(javax.swing.event.DocumentEvent e) |
protected java.lang.String |
convertElementToString(java.lang.Object object)
Converts the element in JTextComponent to string.
|
int |
findFirst(java.lang.String s)
Finds the first element that matches the searching text.
|
int |
findFromCursor(java.lang.String s)
Finds the next matching index from the cursor.
|
int |
findLast(java.lang.String s)
Finds the last element that matches the searching text.
|
int |
findNext(java.lang.String s)
Finds the next matching index from the cursor.
|
int |
findPrevious(java.lang.String s)
Finds the previous matching index from the cursor.
|
protected java.lang.Object |
getElementAt(int index)
Gets the element at the specified index.
|
protected int |
getElementCount()
Gets the total element count in the component.
|
java.awt.Color |
getHighlightColor()
Gets the highlight color.
|
protected int |
getSelectedIndex()
Gets the selected index in the component.
|
void |
hidePopup()
Hides the popup.
|
void |
insertUpdate(javax.swing.event.DocumentEvent e) |
void |
installHighlightsRemover()
Installs the handler for ESC key to remove all highlights
|
void |
installListeners()
Installs necessary listeners to the component.
|
protected boolean |
isActivateKey(java.awt.event.KeyEvent e)
Checks if the key in KeyEvent should activate the search popup.
|
void |
propertyChange(java.beans.PropertyChangeEvent evt) |
protected void |
removeAllHighlights()
Removes all highlights from the text component.
|
void |
removeUpdate(javax.swing.event.DocumentEvent e) |
int |
reverseFindFromCursor(java.lang.String s)
Finds the previous matching index from the cursor.
|
void |
setHighlightColor(java.awt.Color highlightColor)
Changes the highlight color.
|
protected void |
setSelectedIndex(int index,
boolean incremental)
Sets the selected index.
|
void |
uninstallHighlightsRemover()
Uninstalls the handler for ESC key to remove all highlights
|
void |
uninstallListeners()
Uninstall the listeners that installed before.
|
addPropertyChangeListener, addSearchableListener, adjustSelectedIndex, compare, compare, createComponentListener, createFocusListener, createKeyListener, createSearchPopup, firePropertyChangeEvent, fireSearchableEvent, getBackground, getComponent, getCurrentIndex, getCursor, getForeground, getMismatchForeground, getPopupLocation, getPopupLocationRelativeTo, getResourceString, getSearchable, getSearchableListeners, getSearchableProvider, getSearchingDelay, getSearchingText, getSearchLabel, getWildcardSupport, isCaseSensitive, isDeactivateKey, isFindFirstKey, isFindLastKey, isFindNextKey, isFindPreviousKey, isFromStart, isHeavyweightComponentEnabled, isIncrementalSelectKey, isNavigationKey, isPopupVisible, isProcessModelChangeEvent, isRepeats, isReverseOrder, isSelectAllKey, isWildcardEnabled, keyTypedOrPressed, removePropertyChangeListener, removeSearchableListener, setBackground, setCaseSensitive, setCursor, setCursor, setForeground, setFromStart, setHeavyweightComponentEnabled, setMismatchForeground, setPopupLocation, setPopupLocationRelativeTo, setProcessModelChangeEvent, setRepeats, setReverseOrder, setSearchableProvider, setSearchingDelay, setSearchLabel, setWildcardEnabled, setWildcardSupport, showPopup
public TextComponentSearchable(javax.swing.text.JTextComponent textComponent)
public void uninstallHighlightsRemover()
public void installHighlightsRemover()
public void installListeners()
Searchable
installListeners
in class Searchable
public void uninstallListeners()
Searchable
uninstallListeners
in class Searchable
protected void setSelectedIndex(int index, boolean incremental)
Searchable
setSelectedIndex
in class Searchable
index
- the index to be selectedincremental
- a flag to enable multiple selection. If the flag is true, the element at the index should be
added to current selection. If false, you should clear previous selection and then select the
element.protected void addHighlight(int index, java.lang.String text, boolean incremental) throws javax.swing.text.BadLocationException
index
- the index of the text to be highlightedtext
- the text to be highlightedincremental
- if this is an incremental adding highlightjavax.swing.text.BadLocationException
protected void removeAllHighlights()
protected int getSelectedIndex()
Searchable
Here are some examples. In the case of JList, the index is the row index. In the case of JTree, the index is the row index too. In the case of JTable, depending on the selection mode, the index could be row index (in row selection mode), could be column index (in column selection mode) or could the cell index (in cell selection mode).
getSelectedIndex
in class Searchable
protected java.lang.Object getElementAt(int index)
Searchable
getElementAt
in class Searchable
index
- the indexprotected int getElementCount()
Searchable
getElementCount
in class Searchable
protected java.lang.String convertElementToString(java.lang.Object object)
toString()
of
whatever element that returned from list.getModel().getElementAt(i)
.convertElementToString
in class Searchable
object
- public void propertyChange(java.beans.PropertyChangeEvent evt)
propertyChange
in interface java.beans.PropertyChangeListener
public void insertUpdate(javax.swing.event.DocumentEvent e)
insertUpdate
in interface javax.swing.event.DocumentListener
public void removeUpdate(javax.swing.event.DocumentEvent e)
removeUpdate
in interface javax.swing.event.DocumentListener
public void changedUpdate(javax.swing.event.DocumentEvent e)
changedUpdate
in interface javax.swing.event.DocumentListener
protected boolean isActivateKey(java.awt.event.KeyEvent e)
Searchable
isActivateKey
in class Searchable
e
- the key eventpublic java.awt.Color getHighlightColor()
public void setHighlightColor(java.awt.Color highlightColor)
highlightColor
- public int findLast(java.lang.String s)
Searchable
findLast
in class Searchable
s
- the searching textpublic int findFirst(java.lang.String s)
Searchable
findFirst
in class Searchable
s
- the searching textpublic int findFromCursor(java.lang.String s)
Searchable
findFromCursor
in class Searchable
s
- the searching textpublic int reverseFindFromCursor(java.lang.String s)
Searchable
reverseFindFromCursor
in class Searchable
s
- the searching textpublic int findNext(java.lang.String s)
Searchable
findNext
in class Searchable
s
- the searching textpublic int findPrevious(java.lang.String s)
Searchable
findPrevious
in class Searchable
s
- the searching textpublic void hidePopup()
Searchable
hidePopup
in class Searchable