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

Method Detail

getConfig

@NotNull
@NotNull HtmlConfig getConfig()

Specified by:

getConfig in interface GridBuilderConfig<D>

getCssLink

@NotNull
@NotNull String getCssLink()

Specified by:

getCssLink in interface GridBuilderConfig<D>

getJavascriptLink

@NotNull
@NotNull String getJavascriptLink()

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

Specified by:

getJavascriptLink in interface GridBuilderConfig<D>

getIdleDelay

@NotNull
@NotNull Duration getIdleDelay()

Specified by:

getIdleDelay in interface GridBuilderConfig<D>

getAjaxRequestParam

@NotNull
@NotNull HttpParameter getAjaxRequestParam()

Specified by:

getAjaxRequestParam in interface GridBuilderConfig<D>

getSortRequestParam

@NotNull
@NotNull HttpParameter getSortRequestParam()

Specified by:

getSortRequestParam in interface GridBuilderConfig<D>

getAjaxReadyMessage

@NotNull
@NotNull CharSequence getAjaxReadyMessage()

Specified by:

getAjaxReadyMessage in interface GridBuilderConfig<D>

getFormId

@NotNull
@NotNull String getFormId()

Specified by:

getFormId in interface GridBuilderConfig<D>

getControlCss

@NotNull
@NotNull String getControlCss()

Specified by:

getControlCss in interface GridBuilderConfig<D>

getSubtitleCss

@NotNull
@NotNull String getSubtitleCss()

Specified by:

getSubtitleCss in interface GridBuilderConfig<D>

getTableSelector

@NotNull
@NotNull CharSequence getTableSelector()

Specified by:

getTableSelector in interface GridBuilderConfig<D>

getTableCssClass

@NotNull
@NotNull List<CharSequence> getTableCssClass()

Specified by:

getTableCssClass in interface GridBuilderConfig<D>

getSortable

@NotNull
@NotNull CharSequence getSortable()

Specified by:

getSortable in interface GridBuilderConfig<D>

getSortableAsc

@NotNull
@NotNull CharSequence getSortableAsc()

Specified by:

getSortableAsc in interface GridBuilderConfig<D>

getSortableDesc

@NotNull
@NotNull CharSequence getSortableDesc()

Specified by:

getSortableDesc in interface GridBuilderConfig<D>

getSortableBoth

@NotNull
@NotNull 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

@NotNull
default @NotNull CharSequence getSortableDirection(@NotNull
                                                            @NotNull Direction direction)

Get a CSS direction style

Specified by:

getSortableDirection in interface GridBuilderConfig<D>

getInnerSortableImageToStream

@Nullable
default @Nullable InputStream getInnerSortableImageToStream(@NotNull
                                                                      @NotNull Direction direction)

Get a CSS direction style

Specified by:

getInnerSortableImageToStream in interface GridBuilderConfig<D>

getInnerSortableImage

@NotNull
default @NotNull String getInnerSortableImage(@NotNull
                                                       @NotNull Direction direction)

Get a CSS direction style

Specified by:

getInnerSortableImage in interface GridBuilderConfig<D>

of

@NotNull
static @NotNull ReportBuilderConfigImpl of(@NotNull
                                                    @NotNull HtmlConfig config)

Returns a default implementation

Specified by:

of in interface GridBuilderConfig<D>