Class FilterButton

code/src/java/pcgen/gui2/filter/FilterButton.java:38–94

This class represents a simple filter represented as a toggle button. When the button is selected (i.e. pressed) the filter assigned to this button will become active. When deselected the filter will become inactive. Selecting and deselecting the button will trigger its FilterHandler to refilter its

 * to refilter its contents.
 */
public class FilterButton<C, E> extends JToggleButton implements DisplayableFilter<C, E>, ActionListener
{

	private FilterHandler filterHandler;
	private Filter<C, E> filter;
	private final PropertyContext filterContext;

	public FilterButton(String prefKey)
	{
		this(prefKey, false);
	}

	public FilterButton(String prefKey, boolean defaultSelectedState)
	{
		if (StringUtils.isEmpty(prefKey))
		{
			throw new NullPointerException("prefKey cannot be null");
		}
		addActionListener(this);
		PropertyContext baseContext = UIPropertyContext.createContext("filterPrefs");
		filterContext = baseContext.createChildContext(prefKey);
		setSelected(filterContext.initBoolean("active", defaultSelectedState));
	}

	@Override
	public Component getFilterComponent()
	{
		return this;
	}

	@Override
	public void setFilterHandler(FilterHandler handler)
	{
		this.filterHandler = handler;
	}

	public void setFilter(Filter<C, E> filter)
	{
		this.filter = filter;
	}

	@Override
	public boolean accept(C context, E element)
	{
		//if this button is not selected treat it as if
		//this filter always accepts
		return !isEnabled() || !isSelected() || filter.accept(context, element);
	}

	@Override
	public void actionPerformed(ActionEvent e)
	{
		filterHandler.refilter();
		filterContext.setBoolean("active", isSelected());
	}

}