Module MaterialFX

Package io.github.palexdev.materialfx.effects.ripple

Class RippleGenerator

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.Group

io.github.palexdev.materialfx.effects.ripple.RippleGenerator

All Implemented Interfaces:

Styleable, EventTarget

@Deprecated
public class RippleGenerator
extends Group

Deprecated.

Convenience class for creating highly customizable ripple effects.

Extends Group and sets the style class to "ripple-generator" for usage in CSS.

Property Summary

Properties

Type	Property	Description
StyleableBooleanProperty	animateBackground	Deprecated.
ObjectProperty<Duration>	inDuration	Deprecated.
ObjectProperty<Duration>	outDuration	Deprecated.
final StyleableObjectProperty<Paint>	rippleColor	Deprecated.
StyleableDoubleProperty	rippleRadius	Deprecated.

Properties inherited from class javafx.scene.Group

autoSizeChildren

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

Field Summary

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor	Description
RippleGenerator(Region region)	Deprecated.
RippleGenerator(Region region, DepthLevel shadowLevel)	Deprecated.
RippleGenerator(Region region, DepthLevel shadowLevel, RippleClipTypeFactory factory)	Deprecated.
RippleGenerator(Region region, RippleClipTypeFactory factory)	Deprecated.

Method Summary

Modifier and Type	Method	Description
StyleableBooleanProperty	animateBackgroundProperty()	Deprecated.
void	createRipple()	Deprecated. Creates a new Ripple at the specified coordinates.
List<CssMetaData<? extends Styleable,?>>	getCssMetaData()	Deprecated.
static List<CssMetaData<? extends Styleable,?>>	getGroupCssMetaDataList()	Deprecated.
Duration	getInDuration()	Deprecated. Gets the value of the property inDuration.
Duration	getOutDuration()	Deprecated. Gets the value of the property outDuration.
Paint	getRippleColor()	Deprecated. Gets the value of the property rippleColor.
double	getRippleRadius()	Deprecated. Gets the value of the property rippleRadius.
ObjectProperty<Duration>	inDurationProperty()	Deprecated.
boolean	isAnimateBackground()	Deprecated. Gets the value of the property animateBackground.
ObjectProperty<Duration>	outDurationProperty()	Deprecated.
final StyleableObjectProperty<Paint>	rippleColorProperty()	Deprecated.
StyleableDoubleProperty	rippleRadiusProperty()	Deprecated.
void	setAnimateBackground(boolean animateBackground)	Deprecated. Sets the value of the property animateBackground.
void	setGeneratorCenterX(double generatorCenterX)	Deprecated.
void	setGeneratorCenterY(double generatorCenterY)	Deprecated.
void	setInDuration(Duration inDuration)	Deprecated. Sets the value of the property inDuration.
void	setOutDuration(Duration outDuration)	Deprecated. Sets the value of the property outDuration.
void	setRippleClipTypeFactory(RippleClipTypeFactory rippleClipTypeFactory)	Deprecated.
void	setRippleColor(Paint rippleColor)	Deprecated. Sets the value of the property rippleColor.
void	setRippleRadius(double rippleRadius)	Deprecated. Sets the value of the property rippleRadius.

Methods inherited from class javafx.scene.Group

autoSizeChildrenProperty, getChildren, isAutoSizeChildren, layoutChildren, minHeight, minWidth, prefHeight, prefWidth, setAutoSizeChildren

Methods inherited from class javafx.scene.Parent

computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, 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, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClassCssMetaData, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, 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, isResizable, 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, maxHeight, maxWidth, 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, resize, 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 Details

rippleColor

public final StyleableObjectProperty<Paint> rippleColorProperty

See Also:

• getRippleColor()
• setRippleColor(Paint)

rippleRadius

public StyleableDoubleProperty rippleRadiusProperty

See Also:

• getRippleRadius()
• setRippleRadius(double)

animateBackground

public StyleableBooleanProperty animateBackgroundProperty

See Also:

• isAnimateBackground()
• setAnimateBackground(boolean)

inDuration

public ObjectProperty<Duration> inDurationProperty

See Also:

• getInDuration()
• setInDuration(Duration)

outDuration

public ObjectProperty<Duration> outDurationProperty

See Also:

• getOutDuration()
• setOutDuration(Duration)

Constructor Details

RippleGenerator

public RippleGenerator(Region region)

Deprecated.

RippleGenerator

public RippleGenerator(Region region,
 DepthLevel shadowLevel)

Deprecated.

RippleGenerator

public RippleGenerator(Region region,
 RippleClipTypeFactory factory)

Deprecated.

RippleGenerator

public RippleGenerator(Region region,
 DepthLevel shadowLevel,
 RippleClipTypeFactory factory)

Deprecated.

Method Details

createRipple

public void createRipple()

Deprecated.

Creates a new Ripple at the specified coordinates.

Each Ripple is a new instance, this allows multiple ripples to be generated at the same time.

setGeneratorCenterX

public void setGeneratorCenterX(double generatorCenterX)

Deprecated.

setGeneratorCenterY

public void setGeneratorCenterY(double generatorCenterY)

Deprecated.

setRippleClipTypeFactory

public void setRippleClipTypeFactory(RippleClipTypeFactory rippleClipTypeFactory)

Deprecated.

getRippleColor

public Paint getRippleColor()

Deprecated.

Gets the value of the property rippleColor.

Property description:

rippleColorProperty

public final StyleableObjectProperty<Paint> rippleColorProperty()

Deprecated.

See Also:

• getRippleColor()
• setRippleColor(Paint)

setRippleColor

public void setRippleColor(Paint rippleColor)

Deprecated.

Sets the value of the property rippleColor.

Property description:

getRippleRadius

public double getRippleRadius()

Deprecated.

Gets the value of the property rippleRadius.

Property description:

rippleRadiusProperty

public StyleableDoubleProperty rippleRadiusProperty()

Deprecated.

See Also:

• getRippleRadius()
• setRippleRadius(double)

setRippleRadius

public void setRippleRadius(double rippleRadius)

Deprecated.

Sets the value of the property rippleRadius.

Property description:

isAnimateBackground

public boolean isAnimateBackground()

Deprecated.

Gets the value of the property animateBackground.

Property description:

animateBackgroundProperty

public StyleableBooleanProperty animateBackgroundProperty()

Deprecated.

See Also:

• isAnimateBackground()
• setAnimateBackground(boolean)

setAnimateBackground

public void setAnimateBackground(boolean animateBackground)

Deprecated.

Sets the value of the property animateBackground.

Property description:

getInDuration

public Duration getInDuration()

Deprecated.

Gets the value of the property inDuration.

Property description:

inDurationProperty

public ObjectProperty<Duration> inDurationProperty()

Deprecated.

See Also:

• getInDuration()
• setInDuration(Duration)

setInDuration

public void setInDuration(Duration inDuration)

Deprecated.

Sets the value of the property inDuration.

Property description:

getOutDuration

public Duration getOutDuration()

Deprecated.

Gets the value of the property outDuration.

Property description:

outDurationProperty

public ObjectProperty<Duration> outDurationProperty()

Deprecated.

See Also:

• getOutDuration()
• setOutDuration(Duration)

setOutDuration

public void setOutDuration(Duration outDuration)

Deprecated.

Sets the value of the property outDuration.

Property description:

getGroupCssMetaDataList

public static List<CssMetaData<? extends Styleable,?>> getGroupCssMetaDataList()

Deprecated.

getCssMetaData

public List<CssMetaData<? extends Styleable,?>> getCssMetaData()

Deprecated.

Specified by:

getCssMetaData in interface Styleable

Overrides:

getCssMetaData in class Node