< prev index next >
modules/javafx.controls/src/main/java/javafx/scene/control/Pagination.java
Print this page
@@ -165,10 +165,11 @@
*/
public final void setMaxPageIndicatorCount(int value) { maxPageIndicatorCountProperty().set(value); }
/**
* Returns the maximum number of page indicators.
+ * @return the maximum number of page indicators
*/
public final int getMaxPageIndicatorCount() {
return maxPageIndicatorCount == null ? DEFAULT_MAX_PAGE_INDICATOR_COUNT : maxPageIndicatorCount.get();
}
@@ -177,10 +178,11 @@
* The maximum number of pages indicators will remain unchanged if the value is less than 1
* or greater than the {@link #pageCount}. The number of page indicators will be
* reduced to fit the control if the {@code maxPageIndicatorCount} cannot fit.
*
* The default is 10 page indicators.
+ * @return the maximum number of page indicators to use for this pagination control
*/
public final IntegerProperty maxPageIndicatorCountProperty() {
if (maxPageIndicatorCount == null) {
maxPageIndicatorCount = new StyleableIntegerProperty(DEFAULT_MAX_PAGE_INDICATOR_COUNT) {
@@ -231,19 +233,21 @@
*/
public final void setPageCount(int value) { pageCount.set(value); }
/**
* Returns the number of pages.
+ * @return the number of pages
*/
public final int getPageCount() { return pageCount.get(); }
/**
* The number of pages for this pagination control. This
* value must be greater than or equal to 1. {@link #INDETERMINATE}
* should be used as the page count if the total number of pages is unknown.
*
* The default is an {@link #INDETERMINATE} number of pages.
+ * @return the number of pages for this pagination control
*/
public final IntegerProperty pageCountProperty() { return pageCount; }
private final IntegerProperty currentPageIndex = new SimpleIntegerProperty(this, "currentPageIndex", 0) {
@Override protected void invalidated() {
@@ -268,10 +272,11 @@
*/
public final void setCurrentPageIndex(int value) { currentPageIndex.set(value); }
/**
* Returns the current page index.
+ * @return the current page index
*/
public final int getCurrentPageIndex() { return currentPageIndex.get(); }
/**
* The current page index to display for this pagination control. The first page will be
@@ -283,23 +288,26 @@
* Because the page indicators set the current page index, the currentPageIndex property permits only
* bidirectional binding.
* The {@link javafx.beans.property.IntegerProperty#bind(javafx.beans.value.ObservableValue) bind} method
* throws an UnsupportedOperationException.
* </p>
+ * @return the current page index property
*/
public final IntegerProperty currentPageIndexProperty() { return currentPageIndex; }
private ObjectProperty<Callback<Integer, Node>> pageFactory =
new SimpleObjectProperty<Callback<Integer, Node>>(this, "pageFactory");
/**
* Sets the page factory callback function.
+ * @param value the page factory callback function
*/
public final void setPageFactory(Callback<Integer, Node> value) { pageFactory.set(value); }
/**
* Returns the page factory callback function.
+ * @return the page factory callback function
*/
public final Callback<Integer, Node> getPageFactory() {return pageFactory.get(); }
/**
* The pageFactory callback function that is called when a page has been
@@ -309,10 +317,11 @@
* control. The callback function should load and return the contents the page index.
* Null should be returned if the page index does not exist. The currentPageIndex
* will not change when null is returned.
*
* The default is null if there is no page factory set.
+ * @return the page factory property
*/
public final ObjectProperty<Callback<Integer, Node>> pageFactoryProperty() { return pageFactory; }
/***************************************************************************
< prev index next >