org.gradle.gradleplugin.userinterface.swing.generic.filter

Class AbstractFilterEditorPanel

java.lang.Object

org.gradle.gradleplugin.userinterface.swing.generic.filter.AbstractFilterEditorPanel

public abstract class AbstractFilterEditorPanel
extends Object

This panel displays something that is filtered. Its really just a list with show/hide buttons. You populate it with whatever you like (in String form).

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractFilterEditorPanel.StateHolder Just a holder for 2 variables.

Constructor Summary

Constructors

Constructor and Description
AbstractFilterEditorPanel()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	determineShowHideEnabledState(AbstractFilterEditorPanel.StateHolder stateHolder, List<String> selectedObjects) This determines the state of the show hide buttons.
void	enableAppropriately()
JComponent	getComponent()
protected List<String>	getSelectedValues()
protected abstract void	hideSelected(List<String> selection)
protected abstract boolean	isAllowed(String item) Implement this to determine if this item is filtered or not.
void	populate(List<String> items)
protected abstract void	showSelected(List<String> selection)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractFilterEditorPanel

public AbstractFilterEditorPanel()

Method Detail

getComponent

public JComponent getComponent()

isAllowed

protected abstract boolean isAllowed(String item)

Implement this to determine if this item is filtered or not. This is used by the list to indicate if this item is filtered or not.

Parameters:

item - the item in question

Returns:

true if its filtered, false if not.

enableAppropriately

public void enableAppropriately()

determineShowHideEnabledState

protected void determineShowHideEnabledState(AbstractFilterEditorPanel.StateHolder stateHolder,
                                 List<String> selectedObjects)

This determines the state of the show hide buttons. We only want to enable one if its appropriate. Because we have to handle multiple selection, we look for both hidden and shown items. We stop as soon as we find both or we're done with the list.

Parameters:

stateHolder - where we store our state.

selectedObjects - the objects to search.

getSelectedValues

protected List<String> getSelectedValues()

hideSelected

protected abstract void hideSelected(List<String> selection)

showSelected

protected abstract void showSelected(List<String> selection)

populate

public void populate(List<String> items)