org.ujorm.tools.web.table

Interface GridBuilderConfig<D>

All Known Subinterfaces:

ReportBuilderConfig<D>

All Known Implementing Classes:

ReportBuilderConfigImpl

public interface 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(ServletRequest, ServletResponse, 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 GridBuilderConfig	of(@NotNull HtmlConfig config) Returns a default implementation

Method Detail

getConfig

@NotNull
@NotNull HtmlConfig getConfig()

getCssLink

@NotNull
@NotNull String getCssLink()

getJavascriptLink

@NotNull
@NotNull String getJavascriptLink()

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

getIdleDelay

@NotNull
@NotNull Duration getIdleDelay()

getAjaxRequestParam

@NotNull
@NotNull HttpParameter getAjaxRequestParam()

getSortRequestParam

@NotNull
@NotNull HttpParameter getSortRequestParam()

getAjaxReadyMessage

@NotNull
@NotNull CharSequence getAjaxReadyMessage()

getFormId

@NotNull
@NotNull String getFormId()

getControlCss

@NotNull
@NotNull String getControlCss()

getSubtitleCss

@NotNull
@NotNull String getSubtitleCss()

getTableSelector

@NotNull
@NotNull CharSequence getTableSelector()

getTableCssClass

@NotNull
@NotNull List<CharSequence> getTableCssClass()

getSortable

@NotNull
@NotNull CharSequence getSortable()

getSortableAsc

@NotNull
@NotNull CharSequence getSortableAsc()

getSortableDesc

@NotNull
@NotNull CharSequence getSortableDesc()

getSortableBoth

@NotNull
@NotNull CharSequence getSortableBoth()

isEmbeddedIcons

boolean isEmbeddedIcons()

Use inner icons for sortable images

getCssWriter

BiConsumer<Element,Boolean> getCssWriter()

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

getSortableDirection

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

Get a CSS direction style

getInnerSortableImageToStream

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

Get a CSS direction style

getInnerSortableImage

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

Get a CSS direction style

of

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

Returns a default implementation