java.lang.Object
javafx.scene.effect.Effect
javafx.scene.effect.Shadow
An effect which creates a monochrome duplicate of an input with
blurry edges.
This effect is primarily used along with its default black color for
purposes of combining it with the original to create a shadow.
It can also be used with a light color and combined with an original
to create a glow effect.
The
DropShadow
effect is a utility effect which automatically
combines this Shadow
effect with an original graphic for ease
of adding a shadow to an existing scene graph Node
with a
single effect.- Since:
- JavaFX 2.0
-
Property Summary
TypePropertyDescriptionfinal ObjectProperty<BlurType>
The algorithm used to blur the shadow.final ObjectProperty<Color>
The shadowColor
.final DoubleProperty
The vertical size of the shadow blur kernel.final ObjectProperty<Effect>
The input for thisEffect
.final DoubleProperty
The radius of the shadow blur kernel.final DoubleProperty
The horizontal size of the shadow blur kernel. -
Constructor Summary
ConstructorDescriptionShadow()
Creates a new instance of Shadow with default parameters.Creates a new instance of Shadow with specified radius and color.Creates a new instance of Shadow with the specified blurType, color, radius. -
Method Summary
Modifier and TypeMethodDescriptionfinal ObjectProperty<BlurType>
The algorithm used to blur the shadow.final ObjectProperty<Color>
The shadowColor
.final BlurType
Gets the value of theblurType
property.final Color
getColor()
Gets the value of thecolor
property.final double
Gets the value of theheight
property.final Effect
getInput()
Gets the value of theinput
property.final double
Gets the value of theradius
property.final double
getWidth()
Gets the value of thewidth
property.final DoubleProperty
The vertical size of the shadow blur kernel.final ObjectProperty<Effect>
The input for thisEffect
.final DoubleProperty
The radius of the shadow blur kernel.final void
setBlurType
(BlurType value) Sets the value of theblurType
property.final void
Sets the value of thecolor
property.final void
setHeight
(double value) Sets the value of theheight
property.final void
Sets the value of theinput
property.final void
setRadius
(double value) Sets the value of theradius
property.final void
setWidth
(double value) Sets the value of thewidth
property.final DoubleProperty
The horizontal size of the shadow blur kernel.
-
Property Details
-
input
The input for thisEffect
. If set tonull
, or left unspecified, a graphical image of theNode
to which theEffect
is attached will be used as the input.- Default value:
- null
- See Also:
-
radius
The radius of the shadow blur kernel. This attribute controls the distance that the shadow is spread to each side of the source pixels. Setting the radius is equivalent to setting both thewidth
andheight
attributes to a value of(2 * radius + 1)
.Min: 0.0 Max: 127.0 Default: 10.0 Identity: 0.0
- Default value:
- 10.0
- See Also:
-
width
The horizontal size of the shadow blur kernel. This attribute controls the horizontal size of the total area over which the shadow of a single pixel is distributed by the blur algorithm. Values less than1.0
are not distributed beyond the original pixel and so have no blurring effect on the shadow.Min: 0.0 Max: 255.0 Default: 21.0 Identity: <1.0
- Default value:
- 21.0
- See Also:
-
height
The vertical size of the shadow blur kernel. This attribute controls the vertical size of the total area over which the shadow of a single pixel is distributed by the blur algorithm. Values less than1.0
are not distributed beyond the original pixel and so have no blurring effect on the shadow.Min: 0.0 Max: 255.0 Default: 21.0 Identity: <1.0
- Default value:
- 21.0
- See Also:
-
blurType
The algorithm used to blur the shadow.Min: n/a Max: n/a Default: BlurType.THREE_PASS_BOX Identity: n/a
- Default value:
- THREE_PASS_BOX
- See Also:
-
color
The shadowColor
.Min: n/a Max: n/a Default: Color.BLACK Identity: n/a
- Default value:
- BLACK
- See Also:
-
-
Constructor Details
-
Shadow
public Shadow()Creates a new instance of Shadow with default parameters. -
Shadow
Creates a new instance of Shadow with specified radius and color.- Parameters:
radius
- the radius of the shadow blur kernelcolor
- the shadowColor
- Since:
- JavaFX 2.1
-
Shadow
Creates a new instance of Shadow with the specified blurType, color, radius.- Parameters:
blurType
- the algorithm used to blur the shadowcolor
- the shadowColor
radius
- the radius of the shadow blur kernel- Since:
- JavaFX 2.1
-
-
Method Details
-
setInput
Sets the value of theinput
property.- Property description:
- The input for this
Effect
. If set tonull
, or left unspecified, a graphical image of theNode
to which theEffect
is attached will be used as the input. - Default value:
- null
- Parameters:
value
- the value for theinput
property- See Also:
-
getInput
Gets the value of theinput
property.- Property description:
- The input for this
Effect
. If set tonull
, or left unspecified, a graphical image of theNode
to which theEffect
is attached will be used as the input. - Default value:
- null
- Returns:
- the value of the
input
property - See Also:
-
inputProperty
The input for thisEffect
. If set tonull
, or left unspecified, a graphical image of theNode
to which theEffect
is attached will be used as the input.- Default value:
- null
- Returns:
- the
input
property - See Also:
-
setRadius
public final void setRadius(double value) Sets the value of theradius
property.- Property description:
- The radius of the shadow blur kernel.
This attribute controls the distance that the shadow is spread
to each side of the source pixels.
Setting the radius is equivalent to setting both the
width
andheight
attributes to a value of(2 * radius + 1)
.Min: 0.0 Max: 127.0 Default: 10.0 Identity: 0.0
- Default value:
- 10.0
- Parameters:
value
- the value for theradius
property- See Also:
-
getRadius
public final double getRadius()Gets the value of theradius
property.- Property description:
- The radius of the shadow blur kernel.
This attribute controls the distance that the shadow is spread
to each side of the source pixels.
Setting the radius is equivalent to setting both the
width
andheight
attributes to a value of(2 * radius + 1)
.Min: 0.0 Max: 127.0 Default: 10.0 Identity: 0.0
- Default value:
- 10.0
- Returns:
- the value of the
radius
property - See Also:
-
radiusProperty
The radius of the shadow blur kernel. This attribute controls the distance that the shadow is spread to each side of the source pixels. Setting the radius is equivalent to setting both thewidth
andheight
attributes to a value of(2 * radius + 1)
.Min: 0.0 Max: 127.0 Default: 10.0 Identity: 0.0
- Default value:
- 10.0
- Returns:
- the
radius
property - See Also:
-
setWidth
public final void setWidth(double value) Sets the value of thewidth
property.- Property description:
- The horizontal size of the shadow blur kernel.
This attribute controls the horizontal size of the total area over
which the shadow of a single pixel is distributed by the blur algorithm.
Values less than
1.0
are not distributed beyond the original pixel and so have no blurring effect on the shadow.Min: 0.0 Max: 255.0 Default: 21.0 Identity: <1.0
- Default value:
- 21.0
- Parameters:
value
- the value for thewidth
property- See Also:
-
getWidth
public final double getWidth()Gets the value of thewidth
property.- Property description:
- The horizontal size of the shadow blur kernel.
This attribute controls the horizontal size of the total area over
which the shadow of a single pixel is distributed by the blur algorithm.
Values less than
1.0
are not distributed beyond the original pixel and so have no blurring effect on the shadow.Min: 0.0 Max: 255.0 Default: 21.0 Identity: <1.0
- Default value:
- 21.0
- Returns:
- the value of the
width
property - See Also:
-
widthProperty
The horizontal size of the shadow blur kernel. This attribute controls the horizontal size of the total area over which the shadow of a single pixel is distributed by the blur algorithm. Values less than1.0
are not distributed beyond the original pixel and so have no blurring effect on the shadow.Min: 0.0 Max: 255.0 Default: 21.0 Identity: <1.0
- Default value:
- 21.0
- Returns:
- the
width
property - See Also:
-
setHeight
public final void setHeight(double value) Sets the value of theheight
property.- Property description:
- The vertical size of the shadow blur kernel.
This attribute controls the vertical size of the total area over
which the shadow of a single pixel is distributed by the blur algorithm.
Values less than
1.0
are not distributed beyond the original pixel and so have no blurring effect on the shadow.Min: 0.0 Max: 255.0 Default: 21.0 Identity: <1.0
- Default value:
- 21.0
- Parameters:
value
- the value for theheight
property- See Also:
-
getHeight
public final double getHeight()Gets the value of theheight
property.- Property description:
- The vertical size of the shadow blur kernel.
This attribute controls the vertical size of the total area over
which the shadow of a single pixel is distributed by the blur algorithm.
Values less than
1.0
are not distributed beyond the original pixel and so have no blurring effect on the shadow.Min: 0.0 Max: 255.0 Default: 21.0 Identity: <1.0
- Default value:
- 21.0
- Returns:
- the value of the
height
property - See Also:
-
heightProperty
The vertical size of the shadow blur kernel. This attribute controls the vertical size of the total area over which the shadow of a single pixel is distributed by the blur algorithm. Values less than1.0
are not distributed beyond the original pixel and so have no blurring effect on the shadow.Min: 0.0 Max: 255.0 Default: 21.0 Identity: <1.0
- Default value:
- 21.0
- Returns:
- the
height
property - See Also:
-
setBlurType
Sets the value of theblurType
property.- Property description:
- The algorithm used to blur the shadow.
Min: n/a Max: n/a Default: BlurType.THREE_PASS_BOX Identity: n/a
- Default value:
- THREE_PASS_BOX
- Parameters:
value
- the value for theblurType
property- See Also:
-
getBlurType
Gets the value of theblurType
property.- Property description:
- The algorithm used to blur the shadow.
Min: n/a Max: n/a Default: BlurType.THREE_PASS_BOX Identity: n/a
- Default value:
- THREE_PASS_BOX
- Returns:
- the value of the
blurType
property - See Also:
-
blurTypeProperty
The algorithm used to blur the shadow.Min: n/a Max: n/a Default: BlurType.THREE_PASS_BOX Identity: n/a
- Default value:
- THREE_PASS_BOX
- Returns:
- the
blurType
property - See Also:
-
setColor
Sets the value of thecolor
property.- Property description:
- The shadow
Color
.Min: n/a Max: n/a Default: Color.BLACK Identity: n/a
- Default value:
- BLACK
- Parameters:
value
- the value for thecolor
property- See Also:
-
getColor
Gets the value of thecolor
property.- Property description:
- The shadow
Color
.Min: n/a Max: n/a Default: Color.BLACK Identity: n/a
- Default value:
- BLACK
- Returns:
- the value of the
color
property - See Also:
-
colorProperty
The shadowColor
.Min: n/a Max: n/a Default: Color.BLACK Identity: n/a
- Default value:
- BLACK
- Returns:
- the
color
property - See Also:
-