org.ujorm.tools.web.report

Interface ReportBuilderConfig<D>

All Superinterfaces:

GridBuilderConfig<D>

All Known Implementing Classes:

ReportBuilderConfigImpl

public interface ReportBuilderConfig<D>
extends GridBuilderConfig<D>

A HTML page builder for table based an AJAX.

Usage

  TableBuilder.of("Hotel Report")
          .add(Hotel::getName, "Hotel", NAME)
          .add(Hotel::getCity, "City", CITY)
          .add(Hotel::getStreet, "Street")
          .build(httpServletRequest, httpServletResponse, resource);
 

Method Summary

Modifier and Type	Method and Description
CharSequence	getAjaxReadyMessage()
HttpParameter	getAjaxRequestParam()
HtmlConfig	getConfig()
String	getControlCss()
String	getCssLink()
BiConsumer<Element,Boolean>	getCssWriter() Inline CSS writer where the first method is an Element and the seconnd one is a sortable
String	getFormId()
Duration	getIdleDelay()
default String	getInnerSortableImage(Direction direction) Get a CSS direction style
default InputStream	getInnerSortableImageToStream(Direction direction) Get a CSS direction style
String	getJavascriptLink() Link to an external Javascript library where a no-library returns an empty String
CharSequence	getSortable()
CharSequence	getSortableAsc()
CharSequence	getSortableBoth()
CharSequence	getSortableDesc()
default CharSequence	getSortableDirection(Direction direction) Get a CSS direction style
HttpParameter	getSortRequestParam()
String	getSubtitleCss()
List<CharSequence>	getTableCssClass()
CharSequence	getTableSelector()
boolean	isEmbeddedIcons() Use inner icons for sortable images
static ReportBuilderConfigImpl	of(HtmlConfig config) Returns a default implementation

Method Detail

getConfig

@Nonnull
HtmlConfig getConfig()

Specified by:

getConfig in interface GridBuilderConfig<D>

getCssLink

@Nonnull
String getCssLink()

Specified by:

getCssLink in interface GridBuilderConfig<D>

getJavascriptLink

@Nonnull
String getJavascriptLink()

Link to an external Javascript library where a no-library returns an empty String

Specified by:

getJavascriptLink in interface GridBuilderConfig<D>

getIdleDelay

@Nonnull
Duration getIdleDelay()

Specified by:

getIdleDelay in interface GridBuilderConfig<D>

getAjaxRequestParam

@Nonnull
HttpParameter getAjaxRequestParam()

Specified by:

getAjaxRequestParam in interface GridBuilderConfig<D>

getSortRequestParam

@Nonnull
HttpParameter getSortRequestParam()

Specified by:

getSortRequestParam in interface GridBuilderConfig<D>

getAjaxReadyMessage

@Nonnull
CharSequence getAjaxReadyMessage()

Specified by:

getAjaxReadyMessage in interface GridBuilderConfig<D>

getFormId

@Nonnull
String getFormId()

Specified by:

getFormId in interface GridBuilderConfig<D>

getControlCss

@Nonnull
String getControlCss()

Specified by:

getControlCss in interface GridBuilderConfig<D>

getSubtitleCss

@Nonnull
String getSubtitleCss()

Specified by:

getSubtitleCss in interface GridBuilderConfig<D>

getTableSelector

@Nonnull
CharSequence getTableSelector()

Specified by:

getTableSelector in interface GridBuilderConfig<D>

getTableCssClass

@Nonnull
List<CharSequence> getTableCssClass()

Specified by:

getTableCssClass in interface GridBuilderConfig<D>

getSortable

@Nonnull
CharSequence getSortable()

Specified by:

getSortable in interface GridBuilderConfig<D>

getSortableAsc

@Nonnull
CharSequence getSortableAsc()

Specified by:

getSortableAsc in interface GridBuilderConfig<D>

getSortableDesc

@Nonnull
CharSequence getSortableDesc()

Specified by:

getSortableDesc in interface GridBuilderConfig<D>

getSortableBoth

@Nonnull
CharSequence getSortableBoth()

Specified by:

getSortableBoth in interface GridBuilderConfig<D>

isEmbeddedIcons

boolean isEmbeddedIcons()

Use inner icons for sortable images

Specified by:

isEmbeddedIcons in interface GridBuilderConfig<D>

getCssWriter

BiConsumer<Element,Boolean> getCssWriter()

Inline CSS writer where the first method is an Element and the seconnd one is a sortable

Specified by:

getCssWriter in interface GridBuilderConfig<D>

getSortableDirection

@Nonnull
default CharSequence getSortableDirection(@Nonnull
                                                   Direction direction)

Get a CSS direction style

Specified by:

getSortableDirection in interface GridBuilderConfig<D>

getInnerSortableImageToStream

@Nullable
default InputStream getInnerSortableImageToStream(@Nonnull
                                                            Direction direction)

Get a CSS direction style

Specified by:

getInnerSortableImageToStream in interface GridBuilderConfig<D>

getInnerSortableImage

@Nonnull
default String getInnerSortableImage(@Nonnull
                                              Direction direction)

Get a CSS direction style

Specified by:

getInnerSortableImage in interface GridBuilderConfig<D>

of

@Nonnull
static ReportBuilderConfigImpl of(@Nonnull
                                           HtmlConfig config)

Returns a default implementation

Specified by:

of in interface GridBuilderConfig<D>