Package io.deephaven.multiviewwidget.ui.util

Interface FilterPanel

All Superinterfaces:

Workspace

All Known Implementing Classes:

AutoFilterPanel, HierarchicalAutoFilterPanel, StaticFilterPanel

public interface FilterPanel
extends Workspace

A listenable panel that provides filters to apply to the base widget table.

Method Summary

Modifier and Type	Method	Description
void	addListener(FilterPanelListener listener)	Add a listener to this panel for changes in it's filter state.
@NotNull JComponent	getComponent()	Get the component to display the panel.
@Nullable String	getFilterName()
@NotNull Map<String,Set<Object>>	getFilters()	Get a map of Column to Filters for this panel.
boolean	maybeHandleOneClick(String column, Collection<String> items, OneClickListener.OneClickUpdateType type)
void	removeListener(FilterPanelListener listener)	Remove a listener from this panel.

Methods inherited from interface com.illumon.iris.gui.workspace.Workspace

getWorkspaceInfo, isGlobalSetting, setWorkspaceInfo

Method Details

getComponent

@NotNull
@NotNull JComponent getComponent()

Get the component to display the panel.

Returns:

the component.

getFilters

@NotNull
@NotNull Map<String,Set<Object>> getFilters()

Get a map of Column to Filters for this panel.

Returns:

the filters for this panel. Empty if there are none, never null.

getFilterName

@Nullable
@Nullable String getFilterName()

maybeHandleOneClick

boolean maybeHandleOneClick(String column,
 Collection<String> items,
 OneClickListener.OneClickUpdateType type)

addListener

void addListener(FilterPanelListener listener)

Add a listener to this panel for changes in it's filter state.

Parameters:

listener - the listener.

removeListener

void removeListener(FilterPanelListener listener)

Remove a listener from this panel.

Parameters:

listener - the listener