org.ujorm.tools.web.table

Class GridBuilder<D>

java.lang.Object

org.ujorm.tools.web.table.GridBuilder<D>

Direct Known Subclasses:

GridBuilderOld

public class GridBuilder<D>
extends Object

Build a content of a HTML page for a sortable data grid.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ColumnModel<D,?>>	columns Columns
protected GridBuilderConfig	config Table builder config

Constructor Summary

Constructors

Constructor and Description
GridBuilder(GridBuilderConfig config)
GridBuilder(HtmlConfig config)
GridBuilder(CharSequence title)

Method Summary

Modifier and Type	Method and Description
<V> GridBuilder<D>	add(Function<D,V> column)
<V> GridBuilder<D>	add(Function<D,V> column, CharSequence title)
<V> GridBuilder<D>	add(Function<D,V> column, CharSequence title, HttpParameter param)
<V> GridBuilder<D>	add(Function<D,V> column, Injector title)
<V> GridBuilder<D>	add(Function<D,V> column, Injector title, HttpParameter param)
GridBuilder<D>	addColumn(Column<D> column, CharSequence title)
GridBuilder<D>	addColumn(Column<D> column, Injector title)
protected <V> GridBuilder<D>	addInternal(Function<D,V> column, CharSequence title, HttpParameter param)
GridBuilder<D>	addOrder(CharSequence title) Add new column for a row counting
void	build(ApiElement parent, ColumnModel sortedColumn, Function<GridBuilder<D>,Stream<D>> resource) Build the HTML page including a table
void	build(ApiElement parent, Function<GridBuilder<D>,Stream<D>> resource) Build the HTML page including a table
ColumnModel<D,?>	getColumn(int index) Get column model by index
Stream<ColumnModel<D,?>>	getColumns() Returns all table columns in a stream
int	getColumnSize() Returns a count of columns
ColumnModel<D,?>	getSortedColumn() Get sorted column or a stub of the sorted column was not found
boolean	isSortable() Returns the true in case the table is sortable.
boolean	isSortableCalculated() Calculate if the table has an sortable column
protected void	printTable(Element parent, Function<GridBuilder<D>,Stream<D>> resource) Print table
protected void	setSort(ColumnModel sort) Mark a column as sorted
<V> GridBuilder<D>	sortable() Add a sortable indicator to the last column model
<V> GridBuilder<D>	sortable(boolean ascending) Add a sortable indicator to the last column model
<V> GridBuilder<D>	sortable(Direction direction) Add a sortable indicator to the last column model

Methods inherited from class java.lang.Object

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

Field Detail

columns

protected final List<ColumnModel<D,?>> columns

Columns

config

protected final GridBuilderConfig config

Table builder config

Constructor Detail

GridBuilder

public GridBuilder(@Nonnull
                   CharSequence title)

GridBuilder

public GridBuilder(@Nonnull
                   HtmlConfig config)

GridBuilder

public GridBuilder(@Nonnull
                   GridBuilderConfig config)

Method Detail

add

@Nonnull
public <V> GridBuilder<D> add(Function<D,V> column)

add

@Nonnull
public <V> GridBuilder<D> add(Function<D,V> column,
                                       CharSequence title)

add

@Nonnull
public <V> GridBuilder<D> add(Function<D,V> column,
                                       Injector title)

add

@Nonnull
public <V> GridBuilder<D> add(Function<D,V> column,
                                       CharSequence title,
                                       @Nullable
                                       HttpParameter param)

add

@Nonnull
public <V> GridBuilder<D> add(Function<D,V> column,
                                       Injector title,
                                       @Nullable
                                       HttpParameter param)

addColumn

@Nonnull
public GridBuilder<D> addColumn(@Nonnull
                                         Column<D> column,
                                         @Nonnull
                                         CharSequence title)

addColumn

@Nonnull
public GridBuilder<D> addColumn(@Nonnull
                                         Column<D> column,
                                         @Nonnull
                                         Injector title)

addOrder

@Nonnull
public GridBuilder<D> addOrder(@Nonnull
                                        CharSequence title)

Add new column for a row counting

addInternal

@Nonnull
protected <V> GridBuilder<D> addInternal(@Nonnull
                                                  Function<D,V> column,
                                                  @Nonnull
                                                  CharSequence title,
                                                  @Nullable
                                                  HttpParameter param)

getColumn

public ColumnModel<D,?> getColumn(int index)

Get column model by index

getColumnSize

public int getColumnSize()

Returns a count of columns

sortable

@Nonnull
public <V> GridBuilder<D> sortable()

Add a sortable indicator to the last column model

Returns:

sortable

@Nonnull
public <V> GridBuilder<D> sortable(@Nullable
                                            boolean ascending)

Add a sortable indicator to the last column model

Parameters:

ascending - Ascending or descending direction of the sort

Returns:

sortable

@Nonnull
public <V> GridBuilder<D> sortable(@Nonnull
                                            Direction direction)

Add a sortable indicator to the last column model

Parameters:

direction - The null value shows an unused sorting action.

Returns:

getSortedColumn

@Nonnull
public ColumnModel<D,?> getSortedColumn()

Get sorted column or a stub of the sorted column was not found

build

public void build(@Nonnull
                  ApiElement parent,
                  @Nonnull
                  Function<GridBuilder<D>,Stream<D>> resource)

Build the HTML page including a table

build

public void build(@Nonnull
                  ApiElement parent,
                  @Nonnull
                  ColumnModel sortedColumn,
                  @Nonnull
                  Function<GridBuilder<D>,Stream<D>> resource)

Build the HTML page including a table

setSort

protected void setSort(@Nonnull
                       ColumnModel sort)

Mark a column as sorted

printTable

protected void printTable(@Nonnull
                          Element parent,
                          @Nonnull
                          Function<GridBuilder<D>,Stream<D>> resource)

Print table

Parameters:

parent - If a name of the element is a "table" or an empty text then do not create new table element.

resource - Data source

isSortable

public final boolean isSortable()

Returns the true in case the table is sortable. NOTE: Calculated result is cached, call the method on a final model only!

isSortableCalculated

public boolean isSortableCalculated()

Calculate if the table has an sortable column

getColumns

public Stream<ColumnModel<D,?>> getColumns()

Returns all table columns in a stream