Package io.deephaven.multiviewwidget.impl

Class LeafViewBuilderImpl

java.lang.Object

io.deephaven.multiviewwidget.impl.LeafViewBuilderImpl

All Implemented Interfaces:

LeafViewBuilder, ViewFactory

@ScriptApi
public class LeafViewBuilderImpl
extends Object
implements LeafViewBuilder

Constructor Summary

Constructors

Constructor	Description
LeafViewBuilderImpl(WidgetBuilder widgetBuilder, String name, Table liveTable, Color tabColor)

Method Summary

Modifier and Type	Method	Description
@NotNull WidgetBuilder	getBuilder()	Get the parent builder in its current state.
@NotNull LeafViewBuilder	leafColumnOrder(@NotNull Collection<String> leafFrontCols)	Identifies columns which should be displayed toward the beginning of the resultant columns
@NotNull LeafViewBuilder	leafFormatColumns(@NotNull Collection<String> leafFormats)	Defines a number of column-level formats which will be applied to the resultant table.
@NotNull LeafViewBuilder	leafFormatColumnWhere(@NotNull String leafFormatCol, @NotNull String leafFormatCondition, @NotNull String leafFormatColor)	Defines a conditional columnar format.
@NotNull LeafViewBuilder	leafSortAscending(@NotNull Collection<String> leafSortCols)	Identifies columns used for sort-ordering of the resultant table
@NotNull LeafViewBuilder	leafSortDescending(@NotNull Collection<String> leafSortCols)	Identifies columns used for sort-ordering of the resultant table
@NotNull LeafViewBuilder	withTotals(boolean includeTotals)	Identifies if the view should include a totals row.

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.LeafViewBuilder

leafColumnOrder, leafFormatColumns, leafSortAscending, leafSortDescending

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

LeafViewBuilderImpl

public LeafViewBuilderImpl(WidgetBuilder widgetBuilder,
 String name,
 Table liveTable,
 Color tabColor)

Method Details

withTotals

@NotNull
public @NotNull LeafViewBuilder withTotals(boolean includeTotals)

Description copied from interface: LeafViewBuilder

Identifies if the view should include a totals row. This is 'true' by default.

Specified by:

withTotals in interface LeafViewBuilder

Parameters:

includeTotals - if the view should include totals.

Returns:

this PivotViewBuilder

leafColumnOrder

@NotNull
public @NotNull LeafViewBuilder leafColumnOrder(@NotNull
 @NotNull Collection<String> leafFrontCols)

Description copied from interface: LeafViewBuilder

Identifies columns which should be displayed toward the beginning of the resultant columns

Specified by:

leafColumnOrder in interface LeafViewBuilder

Parameters:

leafFrontCols - column name(s) which should be shown near the beginning of the resultant columns

Returns:

this LeafViewBuilder

leafSortAscending

@NotNull
public @NotNull LeafViewBuilder leafSortAscending(@NotNull
 @NotNull Collection<String> leafSortCols)

Description copied from interface: LeafViewBuilder

Identifies columns used for sort-ordering of the resultant table

Specified by:

leafSortAscending in interface LeafViewBuilder

Parameters:

leafSortCols - column name(s) which will identify the resultant sorting

Returns:

this LeafViewBuilder

leafSortDescending

@NotNull
public @NotNull LeafViewBuilder leafSortDescending(@NotNull
 @NotNull Collection<String> leafSortCols)

Description copied from interface: LeafViewBuilder

Identifies columns used for sort-ordering of the resultant table

Specified by:

leafSortDescending in interface LeafViewBuilder

Parameters:

leafSortCols - column name(s) which will identify the resultant sorting

Returns:

this LeafViewBuilder

leafFormatColumns

@NotNull
public @NotNull LeafViewBuilder leafFormatColumns(@NotNull
 @NotNull Collection<String> leafFormats)

Description copied from interface: LeafViewBuilder

Defines a number of column-level formats which will be applied to the resultant table. The formatting is identical to that defined by Table.formatColumns(String...)

Specified by:

leafFormatColumns in interface LeafViewBuilder

Parameters:

leafFormats - Columnar formatting to be applied to the resultant table

Returns:

this LeafViewBuilder

leafFormatColumnWhere

@NotNull
public @NotNull LeafViewBuilder leafFormatColumnWhere(@NotNull
 @NotNull String leafFormatCol,
 @NotNull
 @NotNull String leafFormatCondition,
 @NotNull
 @NotNull String leafFormatColor)

Description copied from interface: LeafViewBuilder

Defines a conditional columnar format. See Table.formatColumnWhere(String, String, String)

Specified by:

leafFormatColumnWhere in interface LeafViewBuilder

Parameters:

leafFormatCol - the columns which will have conditional formatting applied

leafFormatCondition - the condition used to identify if the color should be applied

leafFormatColor - the color to conditionally apply

Returns:

this LeafViewBuilder

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 ViewFactory

Returns:

the parent builder