ca.odell.glazedlists.swt.TextWidgetMatcherEditor Maven / Gradle / Ivy
/* Glazed Lists (c) 2003-2006 */
/* http://publicobject.com/glazedlists/ publicbobject.com,*/
/* O'Dell Engineering Ltd.*/
package ca.odell.glazedlists.swt;
// the core Glazed Lists packages
import ca.odell.glazedlists.GlazedLists;
import ca.odell.glazedlists.TextFilterator;
import ca.odell.glazedlists.matchers.MatcherEditor;
import ca.odell.glazedlists.matchers.TextMatcherEditor;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.widgets.Text;
import javax.swing.*;
/**
* A {@link MatcherEditor} that matches elements that contain the filter text located
* within a {@link Text} field. This {@link TextWidgetMatcherEditor} is directly
* coupled with a {@link Text} and fires {@link MatcherEditor} events in response to
* {@link ModifyEvent}s received from the {@link Text}. This matcher is fully
* concrete for use in SWT applications.
*
* If this {@link MatcherEditor} must be garbage collected before the underlying
* Text, the listener can be unregistered by calling {@link #dispose()}.
*
* @author Kevin Maltby
*/
public final class TextWidgetMatcherEditor extends TextMatcherEditor {
/** the filter edit text field */
private Text text;
/** whether we're listening to each keystroke */
private boolean live;
/** the listener that triggers refiltering when events occur */
private FilterChangeListener filterChangeListener = new FilterChangeListener();
/**
* Creates a TextWidgetMatcherEditor bound to the provided {@link Text}
* with the given textFilterator.
*
* @param text the {@link Text} widget that drives the text-filtering
* @param textFilterator an object capable of producing Strings from the
* objects being filtered. If textFilterator is
* null then all filtered objects are expected to
* implement {@link ca.odell.glazedlists.TextFilterable}.
*
* @see GlazedLists#textFilterator(String[])
*/
public TextWidgetMatcherEditor(Text text, TextFilterator textFilterator) {
this(text, textFilterator, true);
}
/**
* Creates a TextWidgetMatcherEditor bound to the provided {@link Text}
* with the given textFilterator where filtering can
* be specified as "live" or to be based on another event such as the
* user pressing Enter or a button being clicked.
*
* @param text the {@link Text} widget that drives the text-filtering
* @param textFilterator an object capable of producing Strings from the
* objects being filtered. If textFilterator is
* null then all filtered objects are expected to
* implement {@link ca.odell.glazedlists.TextFilterable}.
* @param live true to filter by the keystroke or false
* to filter only when the ENTER key is pressed within the Text. Optionnally,
* you can use the {@link SelectionListener} provided via {@link #getFilterSelectionListener()}
* to register a Button or other component to trigger filtering.
*
* @see GlazedLists#textFilterator(String[])
*/
public TextWidgetMatcherEditor(Text text, TextFilterator textFilterator, boolean live) {
super(textFilterator);
this.text = text;
this.live = live;
registerListeners(live);
// if the document is non-empty to begin with!
refilter();
}
/**
* Whether filtering occurs by the keystroke or not.
*/
public boolean isLive() {
return this.live;
}
/**
* Toggle between filtering by the keystroke and not.
*
* @param live true to filter by the keystroke or false
* to filter only when {@link java.awt.event.KeyEvent#VK_ENTER Enter} is pressed
* within the {@link JTextField}. Note that non-live filtering is only
* supported if textComponent is a {@link JTextField}.
*/
public void setLive(boolean live) {
if(live == this.live) return;
deregisterListeners(this.live);
this.live = live;
registerListeners(this.live);
}
/**
* Listen live or on action performed.
*/
private void registerListeners(boolean live) {
if(live) {
this.text.addModifyListener(filterChangeListener);
} else {
this.text.addSelectionListener(filterChangeListener);
}
}
/**
* Stop listening.
*/
private void deregisterListeners(boolean live) {
if(live) {
this.text.removeModifyListener(filterChangeListener);
} else {
this.text.removeSelectionListener(filterChangeListener);
}
}
/**
* Gets a SelectionListener that refilters the list when it is fired. This
* listener can be used to filter when the user presses a 'Search' button.
*/
public SelectionListener getFilterSelectionListener() {
return filterChangeListener;
}
/**
* A cleanup method which stops this MatcherEditor from listening to
* changes on the {@link Text} component, thus freeing the
* MatcherEditor to be garbage collected. Garbage collection could be
* blocked if you have registered the SelectionListener provided by
* {@link #getFilterSelectionListener()} and not removed that listener
* (of disposed of the widget it was registered to).
*/
public void dispose() {
deregisterListeners(live);
}
/**
* Refilter based on the new contents of the Text..
*/
private void refilter() {
setFilterText(text.getText().split("[ \t]"));
}
/**
* Implements the SelectionListener interface for text filter updates. When
* the user clicks a button (supplied by external code), this
* SelectionListener can be used to update the filter in response.
*/
private class FilterChangeListener implements SelectionListener, ModifyListener {
@Override
public void widgetSelected(SelectionEvent e) {
refilter();
}
@Override
public void widgetDefaultSelected(SelectionEvent e) {
refilter();
}
@Override
public void modifyText(ModifyEvent e) {
refilter();
}
}
}