|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.jdesktop.swingx.search.RecentSearches
public class RecentSearches
Maintains a list of recent searches and persists this list automatically
using Preferences. A recent searches popup menu can be installed on
a JXSearchField using #install(JXSearchField).
| Nested Class Summary | |
|---|---|
static class |
RecentSearches.RecentSearchesPopup
The popup menu returned by RecentSearches#createPopupMenu(JXSearchField). |
| Constructor Summary | |
|---|---|
RecentSearches(java.util.prefs.Preferences prefs,
java.lang.String saveName)
Creates a list of recent searches and uses saveName to
persist this list under the prefs node. |
|
RecentSearches(java.lang.String saveName)
Creates a list of recent searches and uses saveName to
persist this list under the Preferences user root node. |
|
| Method Summary | |
|---|---|
void |
actionPerformed(java.awt.event.ActionEvent e)
Calls put(String) with the ActionEvents action command
as the search string. |
void |
addChangeListener(javax.swing.event.ChangeListener l)
Add a change listener. |
protected javax.swing.JPopupMenu |
createPopupMenu(javax.swing.JTextField searchField)
Creates the recent searches popup menu which will be used by #install(JXSearchField) to set a search popup menu on
searchField. |
javax.swing.event.ChangeListener[] |
getChangeListeners()
Returns all registered ChangeListeners. |
int |
getLength()
The number of recent searches. |
int |
getMaxRecents()
Returns the maximum number of recent searches. |
java.lang.String[] |
getRecentSearches()
Returns all recent searches in this list. |
void |
install(javax.swing.JTextField searchField)
Install a recent the searches popup menu returned by #createPopupMenu(JXSearchField) on searchField. |
void |
put(java.lang.String searchString)
Add a search string as the first element. |
void |
removeAll()
Remove all recent searches. |
void |
removeChangeListener(javax.swing.event.ChangeListener l)
Remove a change listener. |
void |
setMaxRecents(int maxRecents)
Set the maximum number of recent searches. |
void |
uninstall(JXSearchField searchField)
Remove the recent searches popup from searchField when
installed and stop listening for ActionEvents fired by the
search field. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public RecentSearches(java.lang.String saveName)
saveName to
persist this list under the Preferences user root node. Existing
entries will be loaded automatically.
saveName - a unique name for saving this list of recent searches
public RecentSearches(java.util.prefs.Preferences prefs,
java.lang.String saveName)
saveName to
persist this list under the prefs node. Existing entries
will be loaded automatically.
prefsNode - the preferences node under which this list will be persisted.
If prefsNode is null the preferences node will
be set to the user root nodesaveName - a unique name for saving this list of recent searches. If
saveName is null, the list will not be
persisted| Method Detail |
|---|
public void put(java.lang.String searchString)
null or empty nothing will be added. If the search string
already exists, the old element will be removed. The modified list will
automatically be persisted.
If the number of elements exceeds the maximum number of entries, the last
entry will be removed.
searchString - the search string to addgetMaxRecents()public java.lang.String[] getRecentSearches()
public int getLength()
public void removeAll()
public int getMaxRecents()
put(String)public void setMaxRecents(int maxRecents)
maxRecents - maximum number of recent searchesput(String)public void addChangeListener(javax.swing.event.ChangeListener l)
ChangeEvent will be fired whenever a
search is added or removed.
l - the ChangeListenerpublic void removeChangeListener(javax.swing.event.ChangeListener l)
l - a registered ChangeListenerpublic javax.swing.event.ChangeListener[] getChangeListeners()
ChangeListeners.
ChangeListenersprotected javax.swing.JPopupMenu createPopupMenu(javax.swing.JTextField searchField)
#install(JXSearchField) to set a search popup menu on
searchField.
Override to return a custom popup menu.
searchField - the search field the returned popup menu will be installed on
public void install(javax.swing.JTextField searchField)
#createPopupMenu(JXSearchField) on searchField.
Also registers an ActionListener on searchField
and adds the search string to the list of recent searches whenever a
ActionEvent is received.
Uses NativeSearchFieldSupport to achieve compatibility with the native
search field support provided by the Mac Look And Feel since Mac OS 10.5.
searchField - the search field to install a recent searches popup menu onpublic void uninstall(JXSearchField searchField)
searchField when
installed and stop listening for ActionEvents fired by the
search field.
searchField - uninstall recent searches popup menupublic void actionPerformed(java.awt.event.ActionEvent e)
put(String) with the ActionEvents action command
as the search string.
actionPerformed in interface java.awt.event.ActionListener
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||