JavaFX 25 · javafx.scene.effect.Shadow · APIdia, the JavaDoc alternative

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.

Field Summary

Modifier and Type	Field and Description
private ObjectProperty<BlurType>	blurType The algorithm used to blur the shadow.
private boolean	changeIsLocal
private ObjectProperty<Color>	color The shadow `Color`.
private DoubleProperty	height The vertical size of the shadow blur kernel.
private ObjectProperty<Effect>	input The input for this `Effect`.
private DoubleProperty	radius The radius of the shadow blur kernel.
private DoubleProperty	width The horizontal size of the shadow blur kernel.

Constructor Summary

Access	Constructor and Description
public	Shadow() Creates a new instance of Shadow with default parameters.
public	Shadow(double the radius of the shadow blur kernel radius, Color the shadow `Color` color) Creates a new instance of Shadow with specified radius and color.
public	Shadow(BlurType the algorithm used to blur the shadow blurType, Color the shadow `Color` color, double the radius of the shadow blur kernel radius) Creates a new instance of Shadow with the specified blurType, color, radius.

Method Summary

Modifier and Type	Method and Description
public final ObjectProperty<BlurType>	blurTypeProperty()
pack-priv boolean	checkChainContains(Effect e) Implements abstract javafx.scene.effect.Effect.checkChainContains.
public final ObjectProperty<Color>	colorProperty()
pack-priv Effect	copy() Implements abstract javafx.scene.effect.Effect.copy.
pack-priv GeneralShadow	createPeer() Implements abstract javafx.scene.effect.Effect.createPeer.
public final BlurType	getBlurType()
private BlurType	getBlurTypeInternal()
pack-priv BaseBounds	getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor) Implements abstract javafx.scene.effect.Effect.getBounds. Returns bounds of given node with applied effect.
private float	getClampedHeight()
private float	getClampedWidth()
public final Color	getColor()
private Color	getColorInternal()
public final double	getHeight()
public final Effect	getInput()
public final double	getRadius()
public final double	getWidth()
public final DoubleProperty	heightProperty()
public final ObjectProperty<Effect>	inputProperty()
public final DoubleProperty	radiusProperty()
public final void	setBlurType(BlurType value)
public final void	setColor(Color value)
public final void	setHeight(double value)
public final void	setInput(Effect value)
public final void	setRadius(double value)
public final void	setWidth(double value)
pack-priv void	update() Implements abstract javafx.scene.effect.Effect.update.
private void	updateHeight(double value)
private void	updateRadius(double value)
private void	updateWidth(double value)
public final DoubleProperty	widthProperty()

Inherited from javafx.scene.effect.Effect:: containsCycles effectBoundsChanged getInputBounds getKernelSize getPeer getShadowBounds markDirty sync transformBounds

Field Detail

blurType	back to summary
private ObjectProperty<BlurType> 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

blurType

back to summary

private ObjectProperty<BlurType> 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

changeIsLocal	back to summary
private boolean changeIsLocal

color back to summary

color	back to summary
private ObjectProperty<Color> color The shadow `Color`. Min: n/a Max: n/a Default: Color.BLACK Identity: n/a Default Value BLACK

private ObjectProperty<Color> color

The shadow Color.

      Min: n/a
      Max: n/a
  Default: Color.BLACK
 Identity: n/a

Default Value: BLACK

height back to summary

height	back to summary
private DoubleProperty 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 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

private DoubleProperty 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 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

input back to summary

input	back to summary
private ObjectProperty<Effect> input The input for this `Effect`. If set to `null`, or left unspecified, a graphical image of the `Node` to which the `Effect` is attached will be used as the input. Default Value null

private ObjectProperty<Effect> input

The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.

Default Value: null

radius back to summary

radius	back to summary
private DoubleProperty 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 the `width` and `height` attributes to a value of `(2 * radius + 1)`. Min: 0.0 Max: 127.0 Default: 10.0 Identity: 0.0 Default Value 10.0

private DoubleProperty 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 the width and height attributes to a value of (2 * radius + 1).

      Min:   0.0
      Max: 127.0
  Default:  10.0
 Identity:   0.0

Default Value: 10.0

width back to summary

width	back to summary
private DoubleProperty 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 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

private DoubleProperty 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 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

Constructor Detail

Shadow	back to summary
public Shadow() Creates a new instance of Shadow with default parameters.

Shadow back to summary

Shadow	back to summary
public Shadow(double radius, Color color) Creates a new instance of Shadow with specified radius and color. Parameters radius:double the radius of the shadow blur kernel color:Color the shadow `Color` Since JavaFX 2.1

public Shadow(double radius, Color color)

Creates a new instance of Shadow with specified radius and color.

Parameters

radius:double: the radius of the shadow blur kernel
color:Color: the shadow Color

Since

JavaFX 2.1

Shadow back to summary

Shadow	back to summary
public Shadow(BlurType blurType, Color color, double radius) Creates a new instance of Shadow with the specified blurType, color, radius. Parameters blurType:BlurType the algorithm used to blur the shadow color:Color the shadow `Color` radius:double the radius of the shadow blur kernel Since JavaFX 2.1

public Shadow(BlurType blurType, Color color, double radius)

Creates a new instance of Shadow with the specified blurType, color, radius.

Parameters

blurType:BlurType: the algorithm used to blur the shadow
color:Color: the shadow Color
radius:double: the radius of the shadow blur kernel

Since

JavaFX 2.1

Method Detail

blurTypeProperty	back to summary
public final ObjectProperty<BlurType> blurTypeProperty()

checkChainContains	back to summary
pack-priv boolean checkChainContains(Effect e) Implements abstract javafx.scene.effect.Effect.checkChainContains. Annotations @Override

checkChainContains

back to summary

pack-priv boolean checkChainContains(Effect e)

Implements abstract javafx.scene.effect.Effect.checkChainContains.

Annotations

@Override

colorProperty	back to summary
public final ObjectProperty<Color> colorProperty()

copy	back to summary
pack-priv Effect copy() Implements abstract javafx.scene.effect.Effect.copy. Annotations @Override

copy

back to summary

pack-priv Effect copy()

Implements abstract javafx.scene.effect.Effect.copy.

Annotations

@Override

createPeer	back to summary
pack-priv GeneralShadow createPeer() Implements abstract javafx.scene.effect.Effect.createPeer. Annotations @Override

createPeer

back to summary

pack-priv GeneralShadow createPeer()

Implements abstract javafx.scene.effect.Effect.createPeer.

Annotations

@Override

getBlurType	back to summary
public final BlurType getBlurType()

getBlurTypeInternal	back to summary
private BlurType getBlurTypeInternal()

getBounds	back to summary
pack-priv BaseBounds getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor) Implements abstract javafx.scene.effect.Effect.getBounds. Doc from javafx.scene.effect.Effect.getBounds. Returns bounds of given node with applied effect. We never pass null in as a bounds. This method will NOT take a null bounds object. The returned value may be the same bounds object passed in, or it may be a new object. Annotations @Override

getBounds

back to summary

pack-priv BaseBounds getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor)

Implements abstract javafx.scene.effect.Effect.getBounds.

Doc from javafx.scene.effect.Effect.getBounds.

Returns bounds of given node with applied effect. We *never* pass null in as a bounds. This method will NOT take a null bounds object. The returned value may be the same bounds object passed in, or it may be a new object.

Annotations

@Override

getClampedHeight	back to summary
private float getClampedHeight()

getClampedWidth	back to summary
private float getClampedWidth()

getColor	back to summary
public final Color getColor()

getColorInternal	back to summary
private Color getColorInternal()

getHeight	back to summary
public final double getHeight()

getInput	back to summary
public final Effect getInput()

getRadius	back to summary
public final double getRadius()

getWidth	back to summary
public final double getWidth()

heightProperty	back to summary
public final DoubleProperty heightProperty()

inputProperty	back to summary
public final ObjectProperty<Effect> inputProperty()

radiusProperty	back to summary
public final DoubleProperty radiusProperty()

setBlurType	back to summary
public final void setBlurType(BlurType value)

setColor	back to summary
public final void setColor(Color value)

setHeight	back to summary
public final void setHeight(double value)

setInput	back to summary
public final void setInput(Effect value)

setRadius	back to summary
public final void setRadius(double value)

setWidth	back to summary
public final void setWidth(double value)

update	back to summary
pack-priv void update() Implements abstract javafx.scene.effect.Effect.update. Annotations @Override

update

back to summary

pack-priv void update()

Implements abstract javafx.scene.effect.Effect.update.

Annotations

@Override

updateHeight	back to summary
private void updateHeight(double value)

updateRadius	back to summary
private void updateRadius(double value)

updateWidth	back to summary
private void updateWidth(double value)

widthProperty	back to summary
public final DoubleProperty widthProperty()

public Class Shadow

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail