class: DropShadow

[13:7] extends: FxObj

Wraps JavaFX DropShadow, an effect that renders a shadow beneath a node, with configurable color, blur radius, X and Y offset, and spread. The radius controls how soft the shadow edges are, the offset shifts the shadow position relative to the node, and spread controls how much of the radius is filled with solid color before blurring. Apply it to any node via the node's setEffect() method.

Methods

DropShadow ()

Creates a new DropShadow effect with default settings.
setRadius (double R)

Sets the blur radius of the shadow, controlling how soft the shadow edges appear.
- @p R is a double with the radius in pixels; larger values produce softer edges.
- @r this object
getRadius ()

Returns the current blur radius of the shadow.
- @r A double with the radius in pixels.
radiusProperty ()

Returns the DoubleProperty backing the radius value.
- @r An AJO wrapping javafx.beans.property.DoubleProperty.
setOffsetX (double X)

Sets the horizontal offset of the shadow relative to the source node.
- @p X is a double with the X offset in pixels; positive shifts the shadow right.
- @r this object
getOffsetX ()

Returns the horizontal offset of the shadow relative to the source node.
- @r A double with the X offset in pixels.
offsetXProperty ()

Returns the DoubleProperty backing the X offset value.
- @r An AJO wrapping javafx.beans.property.DoubleProperty.
setOffsetY (double Y)

Sets the vertical offset of the shadow relative to the source node.
- @p Y is a double with the Y offset in pixels; positive shifts the shadow down.
- @r this object
getOffsetY ()

Returns the vertical offset of the shadow relative to the source node.
- @r A double with the Y offset in pixels.
offsetYProperty ()

Returns the DoubleProperty backing the Y offset value.
- @r An AJO wrapping javafx.beans.property.DoubleProperty.
setColor (object ColorObj)

Sets the color of the shadow.
- @p ColorObj is a Color object specifying the shadow color.
- @r this object
getColor ()

Returns the current shadow color.
- @r An AJO wrapping javafx.scene.paint.Color.
colorProperty ()

Returns the ObjectProperty backing the shadow color.
- @r An AJO wrapping javafx.beans.property.ObjectProperty.
setSpread (double S)

Sets the spread of the shadow, controlling how much of the radius is filled with solid color.
- @p S is a double in the range 0.0 to 1.0; higher values produce a harder shadow edge.
- @r this object
getSpread ()

Returns the current spread value.
- @r A double in the range 0.0 to 1.0.
spreadProperty ()

Returns the DoubleProperty backing the spread value.
- @r An AJO wrapping javafx.beans.property.DoubleProperty.
setWidth (double W)

Sets the horizontal width of the shadow effect region in pixels.
- @p W is a double with the width in pixels.
- @r this object
getWidth ()

Returns the horizontal width of the shadow effect region.
- @r A double with the width in pixels.
widthProperty ()

Returns the DoubleProperty backing the width value.
- @r An AJO wrapping javafx.beans.property.DoubleProperty.
setHeight (double H)

Sets the vertical height of the shadow effect region in pixels.
- @p H is a double with the height in pixels.
- @r this object
getHeight ()

Returns the vertical height of the shadow effect region.
- @r A double with the height in pixels.
heightProperty ()

Returns the DoubleProperty backing the height value.
- @r An AJO wrapping javafx.beans.property.DoubleProperty.
setBlurType (string Type)

Sets the blur algorithm applied to the shadow.
- @p Type is a string: ONE_PASS_BOX, TWO_PASS_BOX, THREE_PASS_BOX, or GAUSSIAN.
- @r this object
getBlurType ()

Returns the current blur type.
- @r An AJO wrapping javafx.scene.effect.BlurType.
blurTypeProperty ()

Returns the ObjectProperty backing the blur type.
- @r An AJO wrapping javafx.beans.property.ObjectProperty.
setInput (object Input)

Sets the input effect that this DropShadow is chained to. When null the effect operates on the node directly.
- @p Input is an Effect wrapper (e.g. another Bloom, BoxBlur, etc.) or null.
- @r this object
getInput ()

Returns the input effect chained to this DropShadow.
- @r An AJO wrapping javafx.scene.effect.Effect, or null if none is set.
inputProperty ()

Returns the ObjectProperty backing the input effect reference.
- @r An AJO wrapping javafx.beans.property.ObjectProperty.