Package io.deephaven.multiviewwidget.impl.filter

Class StaticFilterBuilderImpl

java.lang.Object

io.deephaven.multiviewwidget.impl.filter.StaticFilterBuilderImpl

All Implemented Interfaces:

FilterViewFactory, StaticFilterBuilder, ViewFactory

public class StaticFilterBuilderImpl
extends Object
implements StaticFilterBuilder

Constructor Summary

Constructors

Constructor	Description
StaticFilterBuilderImpl(@NotNull WidgetBuilder parentBuilder, @NotNull String name)

Method Summary

Modifier and Type	Method	Description
@NotNull FilterItemBuilder	addFilter(@NotNull String name)	Create a filter with the specified name.
@NotNull StaticFilterBuilder	addFilterItem(@NotNull CheckboxFilterComponent item)	Add a CheckboxFilterComponent created via a FilterItemBuilder to the currently active GroupFilterComponent.
@NotNull StaticFilterBuilder	addSpacer(@NotNull Layout orientation)	Add a spacer widget to visually separate items.
@NotNull StaticFilterBuilder	endGroup()	Complete a filter group.
@NotNull WidgetBuilder	getBuilder()	Get the parent builder in its current state.
@NotNull StaticFilterBuilder	getFilterBuilder()	Get the parent StaticFilterBuilder to add more clauses.
@NotNull StaticFilterBuilder	group(@Nullable String name, @NotNull Layout orientation)	Add a named group to the top of the group stack.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.multiviewwidget.builder.filter.FilterViewFactory

addSpacer, group, group, group

Methods inherited from interface io.deephaven.multiviewwidget.builder.ViewFactory

addAggView, addAggView, addGlobalFilter, addGlobalFilter, addLeafView, addLeafView, addPivotView, addPivotView, addPivotView, addPivotView, addPivotView, addPivotView, addPivotView, addPivotView, addPlotView, addPlotView, addPlotView, addPlotView, addRollupView, addRollupView, addStaticFilter, build, collapseGlobalFilter, collapseGlobalFilter, globalFilterBucket, globalFilterBucket

Constructor Details

StaticFilterBuilderImpl

public StaticFilterBuilderImpl(@NotNull
 @NotNull WidgetBuilder parentBuilder,
 @NotNull
 @NotNull String name)

Method Details

getBuilder

@NotNull
public @NotNull WidgetBuilder getBuilder()

Description copied from interface: ViewFactory

Get the parent builder in its current state. May be used to store intermediary states of the builder in order to separate widget-creation into multiple distinct sections

Specified by:

getBuilder in interface FilterViewFactory

Specified by:

getBuilder in interface ViewFactory

Returns:

the parent builder

getFilterBuilder

@NotNull
public @NotNull StaticFilterBuilder getFilterBuilder()

Description copied from interface: FilterViewFactory

Get the parent StaticFilterBuilder to add more clauses.

Specified by:

getFilterBuilder in interface FilterViewFactory

Returns:

the parent builder

group

@NotNull
public @NotNull StaticFilterBuilder group(@Nullable
 @Nullable String name,
 @NotNull
 @NotNull Layout orientation)

Description copied from interface: FilterViewFactory

Add a named group to the top of the group stack. The panel will be rendered with a border containing the name. Items will be laid out as specified. Subsequent calls to FilterViewFactory.addFilter(String) will add to this group.

Specified by:

group in interface FilterViewFactory

Returns:

this StaticFilterBuilder

endGroup

@NotNull
public @NotNull StaticFilterBuilder endGroup()

Description copied from interface: FilterViewFactory

Complete a filter group. The group will be added to the panel and popped from the current stack. Subsequent invocations of other methods will apply to the previous group, or the root group if there were none.

Specified by:

endGroup in interface FilterViewFactory

Returns:

this StaticFilterBuilder

addSpacer

@NotNull
public @NotNull StaticFilterBuilder addSpacer(@NotNull
 @NotNull Layout orientation)

Description copied from interface: FilterViewFactory

Add a spacer widget to visually separate items.

Specified by:

addSpacer in interface FilterViewFactory

Parameters:

orientation - the orientation of the spacer.

Returns:

this StaticFilterBuilder

addFilterItem

@NotNull
public @NotNull StaticFilterBuilder addFilterItem(@NotNull
 @NotNull CheckboxFilterComponent item)

Description copied from interface: StaticFilterBuilder

Add a CheckboxFilterComponent created via a FilterItemBuilder to the currently active GroupFilterComponent. Note: This methods is not intended for customer use.

Specified by:

addFilterItem in interface StaticFilterBuilder

Parameters:

item - the item to add.

Returns:

this StaticFilterBuilder

addFilter

@NotNull
public @NotNull FilterItemBuilder addFilter(@NotNull
 @NotNull String name)

Description copied from interface: FilterViewFactory

Create a filter with the specified name.

Specified by:

addFilter in interface FilterViewFactory

Parameters:

name - the name

Returns:

a new FilterItemBuilder to define the filter