Package de.esoco.process.ui.composite

Klasse UiPagingNavigation

java.lang.Object

org.obrel.core.RelatedObject

de.esoco.process.param.ParameterWrapper<List<org.obrel.core.RelationType<?>>,UiPagingNavigation>

de.esoco.process.ui.UiComponent<List<org.obrel.core.RelationType<?>>,UiPagingNavigation>

de.esoco.process.ui.UiContainer<UiPagingNavigation>

de.esoco.process.ui.UiComposite<UiPagingNavigation>

de.esoco.process.ui.composite.UiPagingNavigation

Alle implementierten Schnittstellen:

org.obrel.core.Relatable

public class UiPagingNavigation
extends UiComposite<UiPagingNavigation>

A composites that contains the components needed for the navigation through pages of data.

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen de.esoco.process.ui.UiContainer

UiContainer.UiContainerFragment

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final int[]	DEFAULT_PAGE_SIZES	A constant array of default page sizes that can be used for setPageSizes(int...).

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
UiPagingNavigation(UiContainer<?> parent, de.esoco.lib.property.Updatable navigationListener, int pageSize)	Creates a new instance.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
final int	getPageSize()	Returns the currently selected page size.
final int[]	getPageSizes()	Returns the page sizes that can be selected by the user.
final int	getPageStart()	Returns the index of the first element on the current page.
protected void	handleNavigation(UiIconSupplier action)	Performs navigation and notifies the navigation listener.
final void	setEmptyPageLabel(String emptyPageLabel)	Sets the label to be displayed if the current page is empty.
final void	setPageSize(int pageSize)	Sets the current page size and updates the display.
final void	setPageSizes(int... pageSizes)	Sets the page sizes that can be selected by the user.
final void	setPageStart(int pageStart)	Sets the index of the first element to display and updates the navigation display.
final void	setTotalSize(int size)	Sets the total size of data available and updates the navigation display.
void	update()	Updates the navigation display according to the current navigation position.

Von Klasse geerbte Methoden de.esoco.process.ui.UiContainer

applyProperties, attachTo, buildContent, builder, clear, componentAdded, componentListChanged, getComponents, getLayout, isBuilt, onClickInContainerArea, remove, toString

Von Klasse geerbte Methoden de.esoco.process.ui.UiComponent

cell, cell, getComponentStyleName, getImage, getParent, getRootView, getValueImpl, getView, height, icon, image, label, placeBefore, resid, setValueImpl, size, style, style, styleName, tooltip, visibleOn, width

Von Klasse geerbte Methoden de.esoco.process.param.ParameterWrapper

clear, disable, enable, fragment, get, getParam, has, hide, id, initiateDownload, isEnabled, isVisible, remove, set, set, set, setEnabled, setFragment, setParam, setParameterEventHandler, setParameterType, setVisible, show, type

Von Klasse geerbte Methoden org.obrel.core.RelatedObject

deleteRelation, get, getRelation, getRelations, notifyRelationListeners, readRelations, relationsEqual, relationsHashCode, relationsString, set, set, transform, writeRelations

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden org.obrel.core.Relatable

deleteRelation, deleteRelations, getAll, getOption, getRelationCount, getRelations, hasFlag, hasRelation, hasRelations, init, set, set, set, setOption, streamRelations

Felddetails

DEFAULT_PAGE_SIZES

public static final int[] DEFAULT_PAGE_SIZES

A constant array of default page sizes that can be used for setPageSizes(int...).

Konstruktordetails

UiPagingNavigation

public UiPagingNavigation(UiContainer<?> parent,
 de.esoco.lib.property.Updatable navigationListener,
 int pageSize)

Creates a new instance.

Parameter:

parent - The parent container

navigationListener - A listener for navigation events

pageSize - The initial page size

Methodendetails

getPageSize

public final int getPageSize()

Returns the currently selected page size.

Gibt zurück:

The current page size

getPageSizes

public final int[] getPageSizes()

Returns the page sizes that can be selected by the user.

Gibt zurück:

The array list sizes or NULL for none

getPageStart

public final int getPageStart()

Returns the index of the first element on the current page.

Gibt zurück:

The starting index of the current page

setEmptyPageLabel

public final void setEmptyPageLabel(String emptyPageLabel)

Sets the label to be displayed if the current page is empty.

Parameter:

emptyPageLabel - The new empty page label

setPageSize

public final void setPageSize(int pageSize)

Sets the current page size and updates the display. This will not fire an event to the page size change handler.

Parameter:

pageSize - The new page size

setPageSizes

public final void setPageSizes(int... pageSizes)

Sets the page sizes that can be selected by the user. If set to NULL no page size selection will be available.

Parameter:

pageSizes - The selectable page sizes or NULL to hide the page size selection

setPageStart

public final void setPageStart(int pageStart)

Sets the index of the first element to display and updates the navigation display. This will not fire an event to the page change handler.

Parameter:

pageStart - The new starting index of the current page

setTotalSize

public final void setTotalSize(int size)

Sets the total size of data available and updates the navigation display.

Parameter:

size - The new total data size

update

public void update()

Updates the navigation display according to the current navigation position.

Setzt außer Kraft:

update in Klasse UiComponent<List<org.obrel.core.RelationType<?>>,UiPagingNavigation>

handleNavigation

protected void handleNavigation(UiIconSupplier action)

Performs navigation and notifies the navigation listener.

Parameter:

action - The navigation action icon