Top Description Fields Constructors Methods
com.dlsc.gemsfx.paging

public Class PagingControls

extends PagingControlBase
Class Inheritance
Imports
com.dlsc.gemsfx.skins.PagingControlsSkin, javafx.beans.property.ReadOnlyBooleanProperty, .ReadOnlyBooleanWrapper, javafx.collections.MapChangeListener, javafx.scene.control.Skin, javafx.scene.input.MouseEvent, java.util.Objects

A control for navigating paged information, for example, a paged database table view.

Field Summary

Modifier and TypeField and Description
private static final String
private final ReadOnlyBooleanWrapper
Inherited from com.dlsc.gemsfx.paging.PagingControlBase:
pageCount

Constructor Summary

AccessConstructor and Description
public
PagingControls()

Constructs a new instance.

Method Summary

Modifier and TypeMethod and Description
protected Skin<?>
createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control.

public String
getUserAgentStylesheet()

Overrides javafx.scene.layout.Region.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.

public final boolean
public final ReadOnlyBooleanProperty

Returns:

true if the controls should be shown to the user
neededProperty
()

This property can be used to determine if the paging controls should be shown in the UI or not.

Inherited from com.dlsc.gemsfx.paging.PagingControlBase:
alignmentPropertyavailablePageSizesPropertyfirstLastPageDisplayModePropertyfirstPagefirstPageDividerPropertyfirstPageTextPropertygetAlignmentgetAvailablePageSizesgetFirstLastPageDisplayModegetFirstPageDividergetFirstPageTextgetLastPageDividergetLastPageTextgetMaxPageIndicatorsCountgetMessageLabelProvidergetMessageLabelStrategygetNextPageTextgetPagegetPageCountgetPageSizegetPageSizeSelectorLabelgetPreviousPageTextgetTotalItemCountisSameWidthPageButtonsisShowPageSizeSelectorisShowPreviousNextPageButtonlastPagelastPageDividerPropertylastPageTextPropertymaxPageIndicatorsCountPropertymessageLabelProviderPropertymessageLabelStrategyPropertynextPagenextPageTextPropertypageCountPropertypagePropertypageSizePropertypageSizeSelectorLabelPropertypreviousPagepreviousPageTextPropertysameWidthPageButtonsPropertysetAlignmentsetAvailablePageSizessetFirstLastPageDisplayModesetFirstPageDividersetFirstPageTextsetLastPageDividersetLastPageTextsetMaxPageIndicatorsCountsetMessageLabelProvidersetMessageLabelStrategysetNextPageTextsetPagesetPageSizesetPageSizeSelectorLabelsetPreviousPageTextsetSameWidthPageButtonssetShowPageSizeSelectorsetShowPreviousNextPageButtonsetTotalItemCountshowPageSizeSelectorPropertyshowPreviousNextPageButtonPropertytotalItemCountProperty

Field Detail

DEFAULT_STYLE_CLASSback to summary
private static final String DEFAULT_STYLE_CLASS
neededback to summary
private final ReadOnlyBooleanWrapper needed

Constructor Detail

PagingControlsback to summary
public PagingControls()

Constructs a new instance.

Method Detail

createDefaultSkinback to summary
protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Annotations
@Override
getUserAgentStylesheetback to summary
public String getUserAgentStylesheet()

Overrides javafx.scene.layout.Region.getUserAgentStylesheet.

Doc from javafx.scene.layout.Region.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls.

The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath.

Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called.



package com.example.javafx.app;

import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class MyApp extends Application {

    @Override public void start(Stage stage) {
        Scene scene = new Scene(new Group());
        scene.getStylesheets().add("/com/example/javafx/app/mystyles.css");
        stage.setScene(scene);
        stage.show();
    }

    public static void main(String[] args) {
        launch(args);
    }
}
For additional information about using CSS with the scene graph, see the CSS Reference Guide.
Annotations
@Override
isNeededback to summary
public final boolean isNeeded()
neededPropertyback to summary
public final ReadOnlyBooleanProperty neededProperty()

This property can be used to determine if the paging controls should be shown in the UI or not. The controls are only needed if the user needs to be able to navigate to different pages. This might not be the case if the view only shows a limited number of items AND the "page size" selector does not contain any values that would create more than one page to show.

Returns:ReadOnlyBooleanProperty

true if the controls should be shown to the user