Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	PagingControlBase.FirstLastPageDisplayMode An enum listing the different ways the control will display or not display controls to quickly go to the first or the last page.
public static enum	PagingControlBase.MessageLabelStrategy A list of possible strategies for showing / hiding the message label.

Modifier and Type	Field and Description
private final ObjectProperty<HPos>	alignment
private final ListProperty<Integer>	availablePageSizes
private final ObjectProperty<PagingControlBase.FirstLastPageDisplayMode>	firstLastPageDisplayMode
private final ObjectProperty<Node>	firstPageDivider
private final StringProperty	firstPageText
private final ObjectProperty<Node>	lastPageDivider
private final StringProperty	lastPageText
private final IntegerProperty	maxPageIndicatorsCount
private final ObjectProperty<Callback<PagingControls, String>>	messageLabelProvider
private final ObjectProperty<PagingControlBase.MessageLabelStrategy>	messageLabelStrategy
private final StringProperty	nextPageText
private final IntegerProperty	page
pack-priv final ReadOnlyIntegerWrapper	pageCount
private final IntegerProperty	pageSize
private final StringProperty	pageSizeSelectorLabel
private final StringProperty	previousPageText
private final BooleanProperty	sameWidthPageButtons
private final BooleanProperty	showPageSizeSelector
private final BooleanProperty	showPreviousNextPageButton
private final IntegerProperty	totalItemCount

Constructor Summary

Access	Constructor and Description
public	PagingControlBase()

Method Summary

Modifier and Type	Method and Description
public final ObjectProperty<HPos>	Returns: the alignment / the position of the paging buttons alignmentProperty() The alignment property controls where in the view the paging buttons will appear: left, center, middle.
public final ListProperty<Integer>	Returns: a list of available page sizes availablePageSizesProperty() A list of available page sizes that will be shown by the page size selector.
public final ObjectProperty<PagingControlBase.FirstLastPageDisplayMode>	firstLastPageDisplayModeProperty()
public void	firstPage() Sets the page index to zero.
public final ObjectProperty<Node>	Returns: a node for separating the "first page" button, usually a label showing "..." firstPageDividerProperty() Stores the node that will be placed between the regular page buttons and the page button that represents the "first" page.
public final StringProperty	Returns: the text of the "first page" button firstPageTextProperty() The text that will be shown by the "first page" button.
public final HPos	getAlignment()
public final ObservableList<Integer>	getAvailablePageSizes()
public final PagingControlBase.FirstLastPageDisplayMode	getFirstLastPageDisplayMode()
public final Node	getFirstPageDivider()
public final String	getFirstPageText()
public final Node	getLastPageDivider()
public final String	getLastPageText()
public final int	getMaxPageIndicatorsCount()
public final Callback<PagingControls, String>	getMessageLabelProvider()
public final PagingControlBase.MessageLabelStrategy	getMessageLabelStrategy()
public final String	getNextPageText()
public final int	getPage()
public final int	getPageCount()
public final int	getPageSize()
public final String	getPageSizeSelectorLabel()
public final String	getPreviousPageText()
public final int	getTotalItemCount()
public final boolean	isSameWidthPageButtons()
public final boolean	isShowPageSizeSelector()
public final boolean	isShowPreviousNextPageButton()
public void	lastPage() Sets the page index to the page count minus one.
public final ObjectProperty<Node>	Returns: a node for separating the "last page" button, usually a label showing "..." lastPageDividerProperty() Stores the node that will be placed between the regular page buttons and the page button that represents the "last" page.
public final StringProperty	Returns: the text of the "last page" button lastPageTextProperty() The text that will be shown by the "last page" button.
public final IntegerProperty	Returns: the number of page buttons shown by the control maxPageIndicatorsCountProperty() The maximum number of page indicators / buttons that will be shown at any time by this control.
public final ObjectProperty<Callback<PagingControls, String>>	Returns: the message label provider messageLabelProviderProperty() A message label provider is used to customize the messages shown by the message label of this control, for example, "Showing items 11 to 20 of a total of 1000 items".
public final ObjectProperty<PagingControlBase.MessageLabelStrategy>	Returns: the strategy used to show or hide the message label messageLabelStrategyProperty() The message label strategy controls whether the message label will appear in certain situations, for example, when there are no items currently in the view that is being controlled by these pagination controls.
public void	nextPage() Increments the page index.
public final StringProperty	Returns: the text of the "next page" button nextPageTextProperty() The text that will be shown by the "next page" button.
public final ReadOnlyIntegerProperty	Returns: a read-only integer property storing the number of required pages pageCountProperty() A read-only property that stores the number of pages that are required for the given number of items and the given page size.
public final IntegerProperty	Returns: the number of the currently showing page pageProperty() The index of the currently showing page.
public final IntegerProperty	Returns: the number of items per page pageSizeProperty() The number of items shown per page of the control that is being controlled by the pagination control.
public final StringProperty	Returns: the label property for the page size selector pageSizeSelectorLabelProperty() The text / label shown in front of the page size selector control.
public void	previousPage() Decrements the page index.
public final StringProperty	Returns: the text of the "previous page" button previousPageTextProperty() The text that will be shown by the "previous page" button.
public final BooleanProperty	Returns: a flag to control the width of the page buttons sameWidthPageButtonsProperty() A flag used to signal whether the individual page buttons will all have the same width or if their width can be different based on the page number that they are showing (e.g. the button for page "1" would be substantially less wide than the button for page "999").
public final void	setAlignment(HPos alignment)
public final void	setAvailablePageSizes(ObservableList<Integer> availablePageSizes)
public final void	setFirstLastPageDisplayMode(PagingControlBase.FirstLastPageDisplayMode firstLastPageDisplayMode)
public final void	setFirstPageDivider(Node firstPageDivider)
public final void	setFirstPageText(String firstPageText)
public final void	setLastPageDivider(Node lastPageDivider)
public final void	setLastPageText(String lastPageText)
public final void	setMaxPageIndicatorsCount(int maxPageIndicatorsCount)
public final void	setMessageLabelProvider(Callback<PagingControls, String> messageLabelProvider)
public final void	setMessageLabelStrategy(PagingControlBase.MessageLabelStrategy messageLabelStrategy)
public final void	setNextPageText(String nextPageText)
public final void	setPage(int page)
public final void	setPageSize(int pageSize)
public final void	setPageSizeSelectorLabel(String pageSizeSelectorLabel)
public final void	setPreviousPageText(String previousPageText)
public final void	setSameWidthPageButtons(boolean sameWidthPageButtons)
public final void	setShowPageSizeSelector(boolean showPageSizeSelector)
public final void	setShowPreviousNextPageButton(boolean showPreviousNextPageButton)
public final void	setTotalItemCount(int totalItemCount)
public final BooleanProperty	Returns: a flag used to determine if the page size selector should be shown or not showPageSizeSelectorProperty() Determines if the control will show a selector UI for choosing different page sizes.
public final BooleanProperty	Returns: a boolean property to control the visibility of the previous / next buttons showPreviousNextPageButtonProperty() A flag used to determine whether the control will display arrow buttons to go to the next or the previous page.
public final IntegerProperty	Returns: the total number of items in the view totalItemCountProperty() The total number of items (rows) displayed by the control that utilizes this pagination control for paging.

Field Detail

alignment	back to summary
private final ObjectProperty<HPos> alignment

availablePageSizes	back to summary
private final ListProperty<Integer> availablePageSizes

firstLastPageDisplayMode	back to summary
private final ObjectProperty<PagingControlBase.FirstLastPageDisplayMode> firstLastPageDisplayMode

firstPageDivider	back to summary
private final ObjectProperty<Node> firstPageDivider

firstPageText	back to summary
private final StringProperty firstPageText

lastPageDivider	back to summary
private final ObjectProperty<Node> lastPageDivider

lastPageText	back to summary
private final StringProperty lastPageText

maxPageIndicatorsCount	back to summary
private final IntegerProperty maxPageIndicatorsCount

messageLabelProvider	back to summary
private final ObjectProperty<Callback<PagingControls, String>> messageLabelProvider

messageLabelStrategy	back to summary
private final ObjectProperty<PagingControlBase.MessageLabelStrategy> messageLabelStrategy

nextPageText	back to summary
private final StringProperty nextPageText

page	back to summary
private final IntegerProperty page

pageCount	back to summary
pack-priv final ReadOnlyIntegerWrapper pageCount

pageSize	back to summary
private final IntegerProperty pageSize

pageSizeSelectorLabel	back to summary
private final StringProperty pageSizeSelectorLabel

previousPageText	back to summary
private final StringProperty previousPageText

sameWidthPageButtons	back to summary
private final BooleanProperty sameWidthPageButtons

showPageSizeSelector	back to summary
private final BooleanProperty showPageSizeSelector

showPreviousNextPageButton	back to summary
private final BooleanProperty showPreviousNextPageButton

totalItemCount	back to summary
private final IntegerProperty totalItemCount

Constructor Detail

PagingControlBase	back to summary
public PagingControlBase()

Method Detail

alignmentProperty	back to summary
public final ObjectProperty<HPos> alignmentProperty() The alignment property controls where in the view the paging buttons will appear: left, center, middle. Returns:ObjectProperty<HPos> the alignment / the position of the paging buttons

alignmentProperty

back to summary

public final ObjectProperty<HPos> alignmentProperty()

The alignment property controls where in the view the paging buttons will appear: left, center, middle.

Returns:ObjectProperty<HPos>: the alignment / the position of the paging buttons

availablePageSizesProperty back to summary

availablePageSizesProperty	back to summary
public final ListProperty<Integer> availablePageSizesProperty() A list of available page sizes that will be shown by the page size selector. Returns:ListProperty<Integer> a list of available page sizes See Also `showPageSizeSelectorProperty()`, `pageSizeSelectorLabelProperty()`

public final ListProperty<Integer> availablePageSizesProperty()

A list of available page sizes that will be shown by the page size selector.

Returns:ListProperty<Integer>: a list of available page sizes
See Also: showPageSizeSelectorProperty(), pageSizeSelectorLabelProperty()

firstLastPageDisplayModeProperty	back to summary
public final ObjectProperty<PagingControlBase.FirstLastPageDisplayMode> firstLastPageDisplayModeProperty()

firstPage	back to summary
public void firstPage() Sets the page index to zero.

firstPageDividerProperty	back to summary
public final ObjectProperty<Node> firstPageDividerProperty() Stores the node that will be placed between the regular page buttons and the page button that represents the "first" page. This is usually a label showing "...". Returns:ObjectProperty<Node> a node for separating the "first page" button, usually a label showing "..."

firstPageDividerProperty

back to summary

public final ObjectProperty<Node> firstPageDividerProperty()

Stores the node that will be placed between the regular page buttons and the page button that represents the "first" page. This is usually a label showing "...".

Returns:ObjectProperty<Node>: a node for separating the "first page" button, usually a label showing "..."

firstPageTextProperty	back to summary
public final StringProperty firstPageTextProperty() The text that will be shown by the "first page" button. Returns:StringProperty the text of the "first page" button

firstPageTextProperty

back to summary

public final StringProperty firstPageTextProperty()

The text that will be shown by the "first page" button.

Returns:StringProperty: the text of the "first page" button

getAlignment	back to summary
public final HPos getAlignment()

getAvailablePageSizes	back to summary
public final ObservableList<Integer> getAvailablePageSizes()

getFirstLastPageDisplayMode	back to summary
public final PagingControlBase.FirstLastPageDisplayMode getFirstLastPageDisplayMode()

getFirstPageDivider	back to summary
public final Node getFirstPageDivider()

getFirstPageText	back to summary
public final String getFirstPageText()

getLastPageDivider	back to summary
public final Node getLastPageDivider()

getLastPageText	back to summary
public final String getLastPageText()

getMaxPageIndicatorsCount	back to summary
public final int getMaxPageIndicatorsCount()

getMessageLabelProvider	back to summary
public final Callback<PagingControls, String> getMessageLabelProvider()

getMessageLabelStrategy	back to summary
public final PagingControlBase.MessageLabelStrategy getMessageLabelStrategy()

getNextPageText	back to summary
public final String getNextPageText()

getPage	back to summary
public final int getPage()

getPageCount	back to summary
public final int getPageCount()

getPageSize	back to summary
public final int getPageSize()

getPageSizeSelectorLabel	back to summary
public final String getPageSizeSelectorLabel()

getPreviousPageText	back to summary
public final String getPreviousPageText()

getTotalItemCount	back to summary
public final int getTotalItemCount()

isSameWidthPageButtons	back to summary
public final boolean isSameWidthPageButtons()

isShowPageSizeSelector	back to summary
public final boolean isShowPageSizeSelector()

isShowPreviousNextPageButton	back to summary
public final boolean isShowPreviousNextPageButton()

lastPage back to summary

public void lastPage()

Sets the page index to the page count minus one.

See Also: pageProperty(), pageCountProperty()

lastPageDividerProperty

back to summary

public final ObjectProperty<Node> lastPageDividerProperty()

Stores the node that will be placed between the regular page buttons and the page button that represents the "last" page. This is usually a label showing "...".

Returns:ObjectProperty<Node>: a node for separating the "last page" button, usually a label showing "..."

lastPageTextProperty

back to summary

public final StringProperty lastPageTextProperty()

The text that will be shown by the "last page" button.

Returns:StringProperty: the text of the "last page" button

maxPageIndicatorsCountProperty

back to summary

public final IntegerProperty maxPageIndicatorsCountProperty()

The maximum number of page indicators / buttons that will be shown at any time by this control.

Returns:IntegerProperty: the number of page buttons shown by the control

messageLabelProviderProperty

back to summary

public final ObjectProperty<Callback<PagingControls, String>> messageLabelProviderProperty()

A message label provider is used to customize the messages shown by the message label of this control, for example, "Showing items 11 to 20 of a total of 1000 items".

Returns:ObjectProperty<Callback<PagingControls, String>>: the message label provider

messageLabelStrategyProperty

back to summary

public final ObjectProperty<PagingControlBase.MessageLabelStrategy> messageLabelStrategyProperty()

The message label strategy controls whether the message label will appear in certain situations, for example, when there are no items currently in the view that is being controlled by these pagination controls.

Returns:ObjectProperty<PagingControlBase.MessageLabelStrategy>: the strategy used to show or hide the message label

nextPage back to summary

public void nextPage()

Increments the page index.

See Also: pageProperty()

nextPageTextProperty

back to summary

public final StringProperty nextPageTextProperty()

The text that will be shown by the "next page" button.

Returns:StringProperty: the text of the "next page" button

pageCountProperty back to summary

public final ReadOnlyIntegerProperty pageCountProperty()

A read-only property that stores the number of pages that are required for the given number of items and the given page size.

Returns:ReadOnlyIntegerProperty: a read-only integer property storing the number of required pages
See Also: totalItemCountProperty(), pageSizeProperty()

pageProperty

back to summary

public final IntegerProperty pageProperty()

The index of the currently showing page.

Returns:IntegerProperty: the number of the currently showing page

pageSizeProperty

back to summary

public final IntegerProperty pageSizeProperty()

The number of items shown per page of the control that is being controlled by the pagination control.

Returns:IntegerProperty: the number of items per page

pageSizeSelectorLabelProperty back to summary

public final StringProperty pageSizeSelectorLabelProperty()

The text / label shown in front of the page size selector control.

Returns:StringProperty: the label property for the page size selector
See Also: showPageSizeSelectorProperty(), availablePageSizesProperty()

previousPage back to summary

public void previousPage()

Decrements the page index.

See Also: pageProperty()

previousPageTextProperty

back to summary

public final StringProperty previousPageTextProperty()

The text that will be shown by the "previous page" button.

Returns:StringProperty: the text of the "previous page" button

sameWidthPageButtonsProperty

back to summary

public final BooleanProperty sameWidthPageButtonsProperty()

A flag used to signal whether the individual page buttons will all have the same width or if their width can be different based on the page number that they are showing (e.g. the button for page "1" would be substantially less wide than the button for page "999").

Returns:BooleanProperty: a flag to control the width of the page buttons

setAlignment	back to summary
public final void setAlignment(HPos alignment)

setAvailablePageSizes	back to summary
public final void setAvailablePageSizes(ObservableList<Integer> availablePageSizes)

setFirstLastPageDisplayMode	back to summary
public final void setFirstLastPageDisplayMode(PagingControlBase.FirstLastPageDisplayMode firstLastPageDisplayMode)

setFirstPageDivider	back to summary
public final void setFirstPageDivider(Node firstPageDivider)

setFirstPageText	back to summary
public final void setFirstPageText(String firstPageText)

setLastPageDivider	back to summary
public final void setLastPageDivider(Node lastPageDivider)

setLastPageText	back to summary
public final void setLastPageText(String lastPageText)

setMaxPageIndicatorsCount	back to summary
public final void setMaxPageIndicatorsCount(int maxPageIndicatorsCount)

setMessageLabelProvider	back to summary
public final void setMessageLabelProvider(Callback<PagingControls, String> messageLabelProvider)

setMessageLabelStrategy	back to summary
public final void setMessageLabelStrategy(PagingControlBase.MessageLabelStrategy messageLabelStrategy)

setNextPageText	back to summary
public final void setNextPageText(String nextPageText)

setPage	back to summary
public final void setPage(int page)

setPageSize	back to summary
public final void setPageSize(int pageSize)

setPageSizeSelectorLabel	back to summary
public final void setPageSizeSelectorLabel(String pageSizeSelectorLabel)

setPreviousPageText	back to summary
public final void setPreviousPageText(String previousPageText)

setSameWidthPageButtons	back to summary
public final void setSameWidthPageButtons(boolean sameWidthPageButtons)

setShowPageSizeSelector	back to summary
public final void setShowPageSizeSelector(boolean showPageSizeSelector)

setShowPreviousNextPageButton	back to summary
public final void setShowPreviousNextPageButton(boolean showPreviousNextPageButton)

setTotalItemCount	back to summary
public final void setTotalItemCount(int totalItemCount)

showPageSizeSelectorProperty back to summary

public final BooleanProperty showPageSizeSelectorProperty()

Determines if the control will show a selector UI for choosing different page sizes.

Returns:BooleanProperty: a flag used to determine if the page size selector should be shown or not
See Also: availablePageSizesProperty(), pageSizeSelectorLabelProperty()

showPreviousNextPageButtonProperty

back to summary

public final BooleanProperty showPreviousNextPageButtonProperty()

A flag used to determine whether the control will display arrow buttons to go to the next or the previous page.

Returns:BooleanProperty: a boolean property to control the visibility of the previous / next buttons

totalItemCountProperty

back to summary

public final IntegerProperty totalItemCountProperty()

The total number of items (rows) displayed by the control that utilizes this pagination control for paging.

Returns:IntegerProperty: the total number of items in the view

com.dlsc.gemsfx.paging back to summary

public final Enum PagingControlBase.FirstLastPageDisplayMode

Class Inheritance

extends Enum<PagingControlBase.FirstLastPageDisplayMode>

java.lang.Object
java.lang.Enum
com.dlsc.gemsfx.paging.PagingControlBase.FirstLastPageDisplayMode

An enum listing the different ways the control will display or not display controls to quickly go to the first or the last page.

Field Summary

Modifier and Type	Field and Description
public static final PagingControlBase.FirstLastPageDisplayMode	HIDE Do not show controls for jumping to the first or last page.
public static final PagingControlBase.FirstLastPageDisplayMode	SHOW_ARROW_BUTTONS Show separate controls in front and after the page buttons to perform the jump.
public static final PagingControlBase.FirstLastPageDisplayMode	SHOW_PAGE_BUTTONS Show extra page buttons to perform the jump (1 ...

Constructor Summary

Access	Constructor and Description
private	FirstLastPageDisplayMode()

Method Summary

Modifier and Type	Method and Description
public static PagingControlBase.FirstLastPageDisplayMode	valueOf(String name)
public static PagingControlBase.FirstLastPageDisplayMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

HIDE	back to summary
public static final PagingControlBase.FirstLastPageDisplayMode HIDE Do not show controls for jumping to the first or last page.

SHOW_ARROW_BUTTONS	back to summary
public static final PagingControlBase.FirstLastPageDisplayMode SHOW_ARROW_BUTTONS Show separate controls in front and after the page buttons to perform the jump.

SHOW_PAGE_BUTTONS	back to summary
public static final PagingControlBase.FirstLastPageDisplayMode SHOW_PAGE_BUTTONS Show extra page buttons to perform the jump (1 ... 5 6 7 8 ... 20).

Constructor Detail

FirstLastPageDisplayMode	back to summary
private FirstLastPageDisplayMode()

Method Detail

valueOf	back to summary
public static PagingControlBase.FirstLastPageDisplayMode valueOf(String name)

values	back to summary
public static PagingControlBase.FirstLastPageDisplayMode[] values()

com.dlsc.gemsfx.paging back to summary

public final Enum PagingControlBase.MessageLabelStrategy

Class Inheritance

extends Enum<PagingControlBase.MessageLabelStrategy>

java.lang.Object
java.lang.Enum
com.dlsc.gemsfx.paging.PagingControlBase.MessageLabelStrategy

A list of possible strategies for showing / hiding the message label.

See Also: messageLabelStrategyProperty()

Field Summary

Modifier and Type	Field and Description
public static final PagingControlBase.MessageLabelStrategy	ALWAYS_SHOW Always show the message label, even when there are no items in the controlled view.
public static final PagingControlBase.MessageLabelStrategy	HIDE Always hide the message label.
public static final PagingControlBase.MessageLabelStrategy	SHOW_WHEN_NEEDED Show the message label when needed, usually when the total item count is larger than zero.

Constructor Summary

Access	Constructor and Description
private	MessageLabelStrategy()

Method Summary

Modifier and Type	Method and Description
public static PagingControlBase.MessageLabelStrategy	valueOf(String name)
public static PagingControlBase.MessageLabelStrategy[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALWAYS_SHOW	back to summary
public static final PagingControlBase.MessageLabelStrategy ALWAYS_SHOW Always show the message label, even when there are no items in the controlled view.

HIDE	back to summary
public static final PagingControlBase.MessageLabelStrategy HIDE Always hide the message label.

SHOW_WHEN_NEEDED	back to summary
public static final PagingControlBase.MessageLabelStrategy SHOW_WHEN_NEEDED Show the message label when needed, usually when the total item count is larger than zero.

Constructor Detail

MessageLabelStrategy	back to summary
private MessageLabelStrategy()

Method Detail

valueOf	back to summary
public static PagingControlBase.MessageLabelStrategy valueOf(String name)

values	back to summary
public static PagingControlBase.MessageLabelStrategy[] values()

public abstract Class PagingControlBase

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum PagingControlBase.FirstLastPageDisplayMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum PagingControlBase.MessageLabelStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail