org.dominokit.domino.ui.pagination

Class BasePagination<T extends BasePagination<T>>

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLElement,T>

org.dominokit.domino.ui.pagination.BasePagination<T>

Type Parameters:

T - the type of the pagination

All Implemented Interfaces:

HasPagination, DominoStyle<elemental2.dom.HTMLElement,T,T>, HasChildren<T>, HasWavesElement, IsCollapsible<T>, IsReadOnly<T>, org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>

Direct Known Subclasses:

AdvancedPagination, ScrollingPagination, SimplePagination

public abstract class BasePagination<T extends BasePagination<T>>
extends BaseDominoElement<elemental2.dom.HTMLElement,T>
implements HasPagination

Base implementation for pagination

Nested Class Summary

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.pagination.HasPagination

HasPagination.PageChangedCallBack

Field Summary

Fields

Modifier and Type	Field and Description
protected DominoElement<? extends elemental2.dom.HTMLElement>	activePage
protected List<DominoElement<? extends elemental2.dom.HTMLElement>>	allPages
protected DominoElement<elemental2.dom.HTMLElement>	element
protected int	index
protected boolean	markActivePage
protected DominoElement<? extends elemental2.dom.HTMLElement>	nextElement
protected HasPagination.PageChangedCallBack	pageChangedCallBack
protected int	pagesCount
protected DominoElement<elemental2.dom.HTMLUListElement>	pagesElement
protected int	pageSize
protected DominoElement<? extends elemental2.dom.HTMLElement>	prevElement
protected String	size
protected int	totalCount

Constructor Summary

Constructors

Constructor and Description
BasePagination()

Method Summary

Modifier and Type	Method and Description
int	activePage()
elemental2.dom.HTMLElement	element()
int	getPagesCount()
int	getPageSize()
int	getTotalCount()
T	gotoFirst() Go to the first page
T	gotoFirst(boolean silent) Go to the first page with boolean for notifying listeners or not
T	gotoLast() Go to the last page
T	gotoLast(boolean silent) Go to the last page with boolean for notifying listeners or not
T	gotoPage(int page) Go to a specific page number
T	gotoPage(int page, boolean silent) Go to a specific page number with boolean for notifying listeners or not
T	large() Sets the size to large
T	markActivePage() Marks the current page as active
protected abstract void	moveToPage(int page, boolean silent)
T	nextPage() Go to the next page of the current page
T	nextPage(boolean silent) Go to the next page of the current page with boolean for notifying listeners or not
T	onPageChanged(HasPagination.PageChangedCallBack pageChangedCallBack) Adds listener that will be called when a page is changed
T	previousPage() Go to the previous page of the current page
T	previousPage(boolean silent) Go to the previous page of the current page with boolean for notifying listeners or not
T	setMarkActivePage(boolean markActivePage) A boolean to mark the active page automatically
T	setPageSize(int pageSize) Sets the page size
T	small() Sets the size to small
HasPagination	updatePages(int pages) Updates the number of pages for this pagination
HasPagination	updatePages(int pages, int pageSize) Updates the number of pages and the page size for this pagination
HasPagination	updatePagesByTotalCount(int totalCount) Updates the number of pages by providing the total number of items, the calculation will be based on the page size
HasPagination	updatePagesByTotalCount(int totalCount, boolean silent) Updates the number of pages by providing the total number of items, the calculation will be based on the page size
HasPagination	updatePagesByTotalCount(int totalCount, int pageSize) Updates the number of pages by providing the total number of items and the page size
HasPagination	updatePagesByTotalCount(int totalCount, int pageSize, boolean silent) Updates the number of pages by providing the total number of items and the page size

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.pagination.HasPagination

updatePages, updatePages

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Field Detail

pagesElement

protected DominoElement<elemental2.dom.HTMLUListElement> pagesElement

element

protected DominoElement<elemental2.dom.HTMLElement> element

activePage

protected DominoElement<? extends elemental2.dom.HTMLElement> activePage

prevElement

protected DominoElement<? extends elemental2.dom.HTMLElement> prevElement

nextElement

protected DominoElement<? extends elemental2.dom.HTMLElement> nextElement

allPages

protected List<DominoElement<? extends elemental2.dom.HTMLElement>> allPages

pageChangedCallBack

protected HasPagination.PageChangedCallBack pageChangedCallBack

size

protected String size

index

protected int index

markActivePage

protected boolean markActivePage

pagesCount

protected int pagesCount

pageSize

protected int pageSize

totalCount

protected int totalCount

Constructor Detail

BasePagination

public BasePagination()

Method Detail

updatePagesByTotalCount

public HasPagination updatePagesByTotalCount(int totalCount)

Updates the number of pages by providing the total number of items, the calculation will be based on the page size

Specified by:

updatePagesByTotalCount in interface HasPagination

Parameters:

totalCount - the total number of items

Returns:

same instance

updatePagesByTotalCount

public HasPagination updatePagesByTotalCount(int totalCount,
                                             boolean silent)

Updates the number of pages by providing the total number of items, the calculation will be based on the page size

Specified by:

updatePagesByTotalCount in interface HasPagination

Parameters:

totalCount - the total number of items

silent - boolean flag to switch triggering the callback on/off for this call

Returns:

same instance

updatePagesByTotalCount

public HasPagination updatePagesByTotalCount(int totalCount,
                                             int pageSize)

Updates the number of pages by providing the total number of items and the page size

Specified by:

updatePagesByTotalCount in interface HasPagination

Parameters:

totalCount - the total number of items

pageSize - the new page size

Returns:

same instance

updatePagesByTotalCount

public HasPagination updatePagesByTotalCount(int totalCount,
                                             int pageSize,
                                             boolean silent)

Updates the number of pages by providing the total number of items and the page size

Specified by:

updatePagesByTotalCount in interface HasPagination

Parameters:

totalCount - the total number of items

pageSize - the new page size

silent - boolean flag to switch triggering the callback on/off for this call

Returns:

same instance

updatePages

public HasPagination updatePages(int pages)

Description copied from interface: HasPagination

Updates the number of pages for this pagination

Specified by:

updatePages in interface HasPagination

Parameters:

pages - the new number of pages

Returns:

same instance

updatePages

public HasPagination updatePages(int pages,
                                 int pageSize)

Description copied from interface: HasPagination

Updates the number of pages and the page size for this pagination

Specified by:

updatePages in interface HasPagination

Parameters:

pages - the new number of pages

pageSize - the new page size

Returns:

same instance

gotoPage

public T gotoPage(int page)

Go to a specific page number

Specified by:

gotoPage in interface HasPagination

Parameters:

page - the number of the page

Returns:

same instance

gotoPage

public T gotoPage(int page,
                  boolean silent)

Go to a specific page number with boolean for notifying listeners or not

Specified by:

gotoPage in interface HasPagination

Parameters:

page - the number of the page

silent - true to not notifying listeners

Returns:

same instance

nextPage

public T nextPage()

Go to the next page of the current page

Specified by:

nextPage in interface HasPagination

Returns:

same instance

previousPage

public T previousPage()

Go to the previous page of the current page

Specified by:

previousPage in interface HasPagination

Returns:

same instance

nextPage

public T nextPage(boolean silent)

Go to the next page of the current page with boolean for notifying listeners or not

Specified by:

nextPage in interface HasPagination

Parameters:

silent - true to not notifying listeners

Returns:

same instance

previousPage

public T previousPage(boolean silent)

Go to the previous page of the current page with boolean for notifying listeners or not

Specified by:

previousPage in interface HasPagination

Parameters:

silent - true to not notifying listeners

Returns:

same instance

gotoFirst

public T gotoFirst()

Go to the first page

Specified by:

gotoFirst in interface HasPagination

Returns:

same instance

gotoLast

public T gotoLast()

Go to the last page

Specified by:

gotoLast in interface HasPagination

Returns:

same instance

gotoFirst

public T gotoFirst(boolean silent)

Go to the first page with boolean for notifying listeners or not

Specified by:

gotoFirst in interface HasPagination

Parameters:

silent - true to not notifying listeners

Returns:

same instance

gotoLast

public T gotoLast(boolean silent)

Go to the last page with boolean for notifying listeners or not

Specified by:

gotoLast in interface HasPagination

Parameters:

silent - true to not notifying listeners

Returns:

same instance

markActivePage

public T markActivePage()

Marks the current page as active

Specified by:

markActivePage in interface HasPagination

Returns:

same instance

setMarkActivePage

public T setMarkActivePage(boolean markActivePage)

A boolean to mark the active page automatically

Parameters:

markActivePage - true to mark the active page automatically, false otherwise

Returns:

same instance

onPageChanged

public T onPageChanged(HasPagination.PageChangedCallBack pageChangedCallBack)

Adds listener that will be called when a page is changed

Specified by:

onPageChanged in interface HasPagination

Parameters:

pageChangedCallBack - A HasPagination.PageChangedCallBack

Returns:

same instance

large

public T large()

Sets the size to large

Returns:

same instance

small

public T small()

Sets the size to small

Returns:

same instance

getTotalCount

public int getTotalCount()

Specified by:

getTotalCount in interface HasPagination

Returns:

the total number of items

setPageSize

public T setPageSize(int pageSize)

Sets the page size

Specified by:

setPageSize in interface HasPagination

Parameters:

pageSize - the page size

Returns:

same instance

getPageSize

public int getPageSize()

Specified by:

getPageSize in interface HasPagination

Returns:

the page size

activePage

public int activePage()

Specified by:

activePage in interface HasPagination

Returns:

the active page number

getPagesCount

public int getPagesCount()

Specified by:

getPagesCount in interface HasPagination

Returns:

the total number of pages

moveToPage

protected abstract void moveToPage(int page,
                                   boolean silent)

element

public elemental2.dom.HTMLElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLElement,T extends BasePagination<T>>

Returns:

the HTML element of type E which is the root element of the component