Module com.gluonhq.charm.glisten
Class RefreshIndicator
- java.lang.Object
-
- javafx.scene.Node
-
- javafx.scene.Parent
-
- javafx.scene.layout.Region
-
- javafx.scene.control.Control
-
- com.gluonhq.impl.charm.glisten.control.RefreshIndicator
-
- All Implemented Interfaces:
Styleable
,EventTarget
,Skinnable
public class RefreshIndicator extends Control
RefreshIndicator is mostly used along with "Swipe to refresh" functionality. The refresh indicator appears only in conjunction with a refresh gesture or action. Syncing displays aProgressIndicator
instead of a refresh indicator.The refresh indicator has two modes :
- PULLING - Shows the pull progress. This is the default mode.
- REFRESHING - Shows the sync progress and uses a
ProgressIndicator
to show the progress. Can use either a determinate or an indeterminateProgressIndicator
.
The radius of the arc of the refresh indicator can be handled by the radius property.
This first example creates a refresh indicator in pull mode and with pull progress as 0.5:
import com.gluonhq.impl.charm.glisten.control.RefreshIndicator; RefreshIndicator refreshIndicator = new RefreshIndicator(); refreshIndicator.setPullProgress(0.5);
For setting a color to the refresh indicator, the style "-fx-color" can be used as shown in the example below:
import com.gluonhq.impl.charm.glisten.control.RefreshIndicator; RefreshIndicator refreshIndicator = new RefreshIndicator(); refreshIndicator.setStyle("-fx-color: red;");
- Since:
- 2.3.0
-
-
Property Summary
Properties Type Property Description ObjectProperty<RefreshIndicator.Mode>
mode
TheRefreshIndicator.Mode
of the refresh indicator.DoubleProperty
progress
The actual progress of the ProgressIndicator.DoubleProperty
pullProgress
The actual pull progress of the RefreshIndicator.StyleableDoubleProperty
radius
The radius of the RefreshIndicator's arc.-
Properties inherited from class javafx.scene.control.Control
contextMenu, skin, tooltip
-
Properties inherited from class javafx.scene.layout.Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width
-
Properties inherited from class javafx.scene.Parent
needsLayout
-
Properties inherited from class javafx.scene.Node
accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RefreshIndicator.Mode
Enumeration that specifies the current mode of the RefreshIndicator.
-
Field Summary
-
Fields inherited from class javafx.scene.layout.Region
USE_COMPUTED_SIZE, USE_PREF_SIZE
-
Fields inherited from class javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT
-
-
Constructor Summary
Constructors Constructor Description RefreshIndicator()
Creates a RefreshIndicator with default radius as 12
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Skin<?>
createDefaultSkin()
static List<CssMetaData<? extends Styleable,?>>
getClassCssMetaData()
List<CssMetaData<? extends Styleable,?>>
getControlCssMetaData()
RefreshIndicator.Mode
getMode()
Gets the value of the property mode.double
getProgress()
Gets the value of the property progress.double
getPullProgress()
Gets the value of the property pullProgress.double
getRadius()
Gets the value of the property radius.ObjectProperty<RefreshIndicator.Mode>
modeProperty()
TheRefreshIndicator.Mode
of the refresh indicator.DoubleProperty
progressProperty()
The actual progress of the ProgressIndicator.DoubleProperty
pullProgressProperty()
The actual pull progress of the RefreshIndicator.StyleableDoubleProperty
radiusProperty()
The radius of the RefreshIndicator's arc.void
setMode(RefreshIndicator.Mode value)
Sets the value of the property mode.void
setProgress(double value)
Sets the value of the property progress.void
setPullProgress(double pullProgress)
Sets the value of the property pullProgress.void
setRadius(double value)
Sets the value of the property radius.-
Methods inherited from class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty
-
Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
-
Methods inherited from class javafx.scene.Parent
getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds
-
Methods inherited from class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface javafx.css.Styleable
getStyleableNode
-
-
-
-
Property Detail
-
progress
public final DoubleProperty progressProperty
The actual progress of the ProgressIndicator. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%.- See Also:
getProgress()
,setProgress(double)
-
pullProgress
public DoubleProperty pullProgressProperty
The actual pull progress of the RefreshIndicator. The value increases from 0 to 1 when the pull is undergoing. A value 1 means that the mode will be changed from PULLING to REFRESHING. i.e. the sync process will start and the refresh arc will be replaced by a progress indicator.- See Also:
getPullProgress()
,setPullProgress(double)
-
mode
public final ObjectProperty<RefreshIndicator.Mode> modeProperty
TheRefreshIndicator.Mode
of the refresh indicator. By default it is set toRefreshIndicator.Mode.PULLING
.- See Also:
getMode()
,setMode(RefreshIndicator.Mode)
-
radius
public final StyleableDoubleProperty radiusProperty
The radius of the RefreshIndicator's arc.Default value is 12.
- See Also:
getRadius()
,setRadius(double)
-
-
Method Detail
-
setProgress
public final void setProgress(double value)
Sets the value of the property progress.- Property description:
- The actual progress of the ProgressIndicator. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%.
-
getProgress
public final double getProgress()
Gets the value of the property progress.- Property description:
- The actual progress of the ProgressIndicator. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%.
-
progressProperty
public final DoubleProperty progressProperty()
The actual progress of the ProgressIndicator. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%.- See Also:
getProgress()
,setProgress(double)
-
getPullProgress
public double getPullProgress()
Gets the value of the property pullProgress.- Property description:
- The actual pull progress of the RefreshIndicator. The value increases from 0 to 1 when the pull is undergoing. A value 1 means that the mode will be changed from PULLING to REFRESHING. i.e. the sync process will start and the refresh arc will be replaced by a progress indicator.
-
pullProgressProperty
public DoubleProperty pullProgressProperty()
The actual pull progress of the RefreshIndicator. The value increases from 0 to 1 when the pull is undergoing. A value 1 means that the mode will be changed from PULLING to REFRESHING. i.e. the sync process will start and the refresh arc will be replaced by a progress indicator.- See Also:
getPullProgress()
,setPullProgress(double)
-
setPullProgress
public void setPullProgress(double pullProgress)
Sets the value of the property pullProgress.- Property description:
- The actual pull progress of the RefreshIndicator. The value increases from 0 to 1 when the pull is undergoing. A value 1 means that the mode will be changed from PULLING to REFRESHING. i.e. the sync process will start and the refresh arc will be replaced by a progress indicator.
-
getMode
public final RefreshIndicator.Mode getMode()
Gets the value of the property mode.- Property description:
- The
RefreshIndicator.Mode
of the refresh indicator. By default it is set toRefreshIndicator.Mode.PULLING
.
-
setMode
public final void setMode(RefreshIndicator.Mode value)
Sets the value of the property mode.- Property description:
- The
RefreshIndicator.Mode
of the refresh indicator. By default it is set toRefreshIndicator.Mode.PULLING
.
-
modeProperty
public final ObjectProperty<RefreshIndicator.Mode> modeProperty()
TheRefreshIndicator.Mode
of the refresh indicator. By default it is set toRefreshIndicator.Mode.PULLING
.- See Also:
getMode()
,setMode(RefreshIndicator.Mode)
-
createDefaultSkin
protected Skin<?> createDefaultSkin()
- Overrides:
createDefaultSkin
in classControl
-
setRadius
public final void setRadius(double value)
Sets the value of the property radius.- Property description:
- The radius of the RefreshIndicator's arc.
Default value is 12.
-
getRadius
public final double getRadius()
Gets the value of the property radius.- Property description:
- The radius of the RefreshIndicator's arc.
Default value is 12.
-
radiusProperty
public final StyleableDoubleProperty radiusProperty()
The radius of the RefreshIndicator's arc.Default value is 12.
- See Also:
getRadius()
,setRadius(double)
-
getClassCssMetaData
public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()
- Returns:
- The CssMetaData associated with this class, which may include the CssMetaData of its super classes.
- Since:
- JavaFX 8.0
-
getControlCssMetaData
public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData()
- Overrides:
getControlCssMetaData
in classControl
- Since:
- JavaFX 8.0
-
-