com.vaadin.addon.spreadsheet

Class ItemFilter

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractSingleComponentContainer

com.vaadin.ui.Panel

com.vaadin.addon.spreadsheet.ItemFilter

All Implemented Interfaces:

SpreadsheetFilter, com.vaadin.event.Action.Container, com.vaadin.event.Action.Notifier, com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SerializableEventListener, com.vaadin.server.ClientConnector, com.vaadin.server.Scrollable, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.LegacyComponent, com.vaadin.ui.SingleComponentContainer, Serializable, Iterable<com.vaadin.ui.Component>, EventListener

public class ItemFilter
extends com.vaadin.ui.Panel
implements SpreadsheetFilter

A simple filter for spreadsheet filtering table, filtering cell values with checkboxes.

Has a check box for selecting all items (cell values), and one check box per unique cell value that can be found within the cells of the table column.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Field Summary

Fields inherited from class com.vaadin.ui.Panel

actionManager

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
ItemFilter(org.apache.poi.ss.util.CellRangeAddress filterRange, Spreadsheet spreadsheet, PopupButton popupButton, SpreadsheetFilterTable filterTable) Constructs a new item filter for the given spreadsheet, filtering range, pop-up button and filtering table.

Method Summary

Modifier and Type	Method and Description
void	clearFilter() Clear the filtering options.
protected Set<String>	getAllValues() Gets all of the unique values for this filter column.
Set<Integer>	getFilteredRows() Returns the rows that should be filtered by this filter.
protected Set<String>	getVisibleValues() Gets the currently NOT filtered cell values.
protected void	initAllItemsCheckbox() Creates the "Select All" filter component.
protected void	initComponents() Create all components of the ItemFilter.
protected void	initLayouts() Creates the base layout for the filter components.
protected void	initOptions() Creates the filter selection component.
protected void	initPopupButtonListeners() Initializes pop-up close listener for verifying that filter selections match with what is currently shown.
protected void	updateFilteredItems(Collection<String> visibleValues) Updates the filtered rows to reflect the new filtered values.
void	updateOptions() Updates the filtering options based on the values within the column.

Methods inherited from class com.vaadin.ui.Panel

addAction, addActionHandler, addClickListener, changeVariables, focus, getActionManager, getCustomAttributes, getScrollLeft, getScrollTop, getState, getState, getTabIndex, paintContent, readDesign, removeAction, removeActionHandler, removeAllActionHandlers, removeClickListener, setCaption, setScrollLeft, setScrollTop, setTabIndex, writeDesign

Methods inherited from class com.vaadin.ui.AbstractSingleComponentContainer

addComponentAttachListener, addComponentDetachListener, fireComponentAttachEvent, fireComponentDetachEvent, getComponentCount, getContent, iterator, readDesignChildren, removeComponentAttachListener, removeComponentDetachListener, removeFromParent, setContent, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ItemFilter

public ItemFilter(org.apache.poi.ss.util.CellRangeAddress filterRange,
                  Spreadsheet spreadsheet,
                  PopupButton popupButton,
                  SpreadsheetFilterTable filterTable)

Constructs a new item filter for the given spreadsheet, filtering range, pop-up button and filtering table.

Parameters:

filterRange - Range of cells to filter

spreadsheet - Target Spreadsheet

popupButton - Pop-up button to insert the filter components in

filterTable - Target SpreadsheetFilterTable

Method Detail

initComponents

protected void initComponents()

Create all components of the ItemFilter.

initLayouts

protected void initLayouts()

Creates the base layout for the filter components.

initPopupButtonListeners

protected void initPopupButtonListeners()

Initializes pop-up close listener for verifying that filter selections match with what is currently shown.

initAllItemsCheckbox

protected void initAllItemsCheckbox()

Creates the "Select All" filter component.

initOptions

protected void initOptions()

Creates the filter selection component.

updateOptions

public void updateOptions()

Updates the filtering options based on the values within the column.

getVisibleValues

protected Set<String> getVisibleValues()

Gets the currently NOT filtered cell values.

Returns:

All unique values currently visible (= not filtered) within this column

getAllValues

protected Set<String> getAllValues()

Gets all of the unique values for this filter column.

Returns:

All unique values within this column

updateFilteredItems

protected void updateFilteredItems(Collection<String> visibleValues)

Updates the filtered rows to reflect the new filtered values.

Parameters:

visibleValues - the values that are NOT filtered

getFilteredRows

public Set<Integer> getFilteredRows()

Description copied from interface: SpreadsheetFilter

Returns the rows that should be filtered by this filter. In other words the returned set of rows will be hidden from the table.

Specified by:

getFilteredRows in interface SpreadsheetFilter

Returns:

Row indexes of the filtered rows, 0-based

clearFilter

public void clearFilter()

Description copied from interface: SpreadsheetFilter

Clear the filtering options. After this method the SpreadsheetFilter.getFilteredRows() for this filter should return an empty set.

Specified by:

clearFilter in interface SpreadsheetFilter