com.haulmont.cuba.gui.components

Interface RowsCount

All Superinterfaces:

Component, Component.BelongToFrame

public interface RowsCount
extends Component.BelongToFrame

Component that makes a data binding to load data by pages. Usually used with Table or DataGrid.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RowsCount.BeforeRefreshEvent Event that is fired before refreshing the datasource when the user clicks next, previous, etc.
static interface	RowsCount.BeforeRefreshListener Deprecated. Use Consumer with RowsCount.BeforeRefreshEvent instead.
static interface	RowsCount.RowsCountTarget
static class	RowsCount.State

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addBeforeRefreshListener(java.util.function.Consumer<RowsCount.BeforeRefreshEvent> listener)
CollectionDatasource	getDatasource() Deprecated. assign RowsCount.RowsCountTarget instead.
ListComponent	getOwner() Deprecated.
RowsCount.RowsCountTarget	getRowsCountTarget()
java.util.function.Function<DataLoadContext,java.lang.Long>	getTotalCountDelegate()
void	removeBeforeRefreshListener(java.util.function.Consumer<RowsCount.BeforeRefreshEvent> listener)
void	setDatasource(CollectionDatasource datasource) Deprecated. assign RowsCount.RowsCountTarget instead.
void	setOwner(ListComponent owner) Deprecated. Use setRowsCountTarget(RowsCountTarget) instead.
void	setRowsCountTarget(RowsCount.RowsCountTarget target)
void	setTotalCountDelegate(java.util.function.Function<DataLoadContext,java.lang.Long> delegate) Sets delegate which is used to get the total number of rows when user clicks "total count" or "last page".

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getDatasource

@Deprecated
CollectionDatasource getDatasource()

Deprecated. assign RowsCount.RowsCountTarget instead.

setDatasource

@Deprecated
void setDatasource(CollectionDatasource datasource)

Deprecated. assign RowsCount.RowsCountTarget instead.

getOwner

@Deprecated
ListComponent getOwner()

Deprecated.

Returns:

a component that displays data from the same datasource, usually a Table. Can be null.

setOwner

@Deprecated
void setOwner(ListComponent owner)

Deprecated. Use setRowsCountTarget(RowsCountTarget) instead.

getRowsCountTarget

RowsCount.RowsCountTarget getRowsCountTarget()

Returns:

a component that displays data, usually a Table. Can be null.

setRowsCountTarget

void setRowsCountTarget(RowsCount.RowsCountTarget target)

getTotalCountDelegate

java.util.function.Function<DataLoadContext,java.lang.Long> getTotalCountDelegate()

Returns:

delegate which is used to get the total number of rows when user clicks "total count" or "last page".

setTotalCountDelegate

void setTotalCountDelegate(java.util.function.Function<DataLoadContext,java.lang.Long> delegate)

Sets delegate which is used to get the total number of rows when user clicks "total count" or "last page".

addBeforeRefreshListener

void addBeforeRefreshListener(java.util.function.Consumer<RowsCount.BeforeRefreshEvent> listener)

removeBeforeRefreshListener

void removeBeforeRefreshListener(java.util.function.Consumer<RowsCount.BeforeRefreshEvent> listener)