javafx.scene.effect

Class Shadow

java.lang.Object

javafx.scene.effect.Effect

javafx.scene.effect.Shadow

public class Shadow
extends Effect

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

Type	Property and Description
<any>	blurType The algorithm used to blur the shadow.
<any>	color The shadow Color.
DoubleProperty	height The vertical size of the shadow blur kernel.
<any>	input The input for this Effect.
DoubleProperty	radius The radius of the shadow blur kernel.
DoubleProperty	width The horizontal size of the shadow blur kernel.

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.effect.Effect

Effect.EffectInputChangeListener, Effect.EffectInputProperty

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	blurType The algorithm used to blur the shadow.
private boolean	changeIsLocal
private <any>	color The shadow Color.
private DoubleProperty	height The vertical size of the shadow blur kernel.
private <any>	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

Constructors

Constructor and Description
Shadow() Creates a new instance of Shadow with default parameters.
Shadow(BlurType blurType, Color color, double radius) Creates a new instance of Shadow with the specified blurType, color, radius.
Shadow(double radius, Color color) Creates a new instance of Shadow with specified radius and color.

Method Summary

Modifier and Type	Method and Description
<any>	blurTypeProperty() The algorithm used to blur the shadow.
(package private) boolean	checkChainContains(Effect e)
<any>	colorProperty() The shadow Color.
(package private) Effect	copy()
(package private) com.sun.scenario.effect.GeneralShadow	createPeer()
BlurType	getBlurType() Gets the value of the property blurType.
private BlurType	getBlurTypeInternal()
(package private) BaseBounds	getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor) Returns bounds of given node with applied effect.
private float	getClampedHeight()
private float	getClampedWidth()
Color	getColor() Gets the value of the property color.
private Color	getColorInternal()
double	getHeight() Gets the value of the property height.
Effect	getInput() Gets the value of the property input.
double	getRadius() Gets the value of the property radius.
double	getWidth() Gets the value of the property width.
DoubleProperty	heightProperty() The vertical size of the shadow blur kernel.
<any>	inputProperty() The input for this Effect.
DoubleProperty	radiusProperty() The radius of the shadow blur kernel.
void	setBlurType(BlurType value) Sets the value of the property blurType.
void	setColor(Color value) Sets the value of the property color.
void	setHeight(double value) Sets the value of the property height.
void	setInput(Effect value) Sets the value of the property input.
void	setRadius(double value) Sets the value of the property radius.
void	setWidth(double value) Sets the value of the property width.
(package private) void	update()
private void	updateHeight(double value)
private void	updateRadius(double value)
private void	updateWidth(double value)
DoubleProperty	widthProperty() The horizontal size of the shadow blur kernel.

Methods inherited from class javafx.scene.effect.Effect

containsCycles, effectBoundsChanged, getInputBounds, getKernelSize, getPeer, getShadowBounds, markDirty, sync, transformBounds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

input

public final <any> inputProperty

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.

See Also:

getInput(), setInput(Effect)

radius

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

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

See Also:

getRadius(), setRadius(double)

width

public final DoubleProperty 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 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
 

See Also:

getWidth(), setWidth(double)

height

public final DoubleProperty 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 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
 

See Also:

getHeight(), setHeight(double)

blurType

public final <any> blurTypeProperty

The algorithm used to blur the shadow.

       Min: n/a
       Max: n/a
   Default: BlurType.THREE_PASS_BOX
  Identity: n/a
 

See Also:

getBlurType(), setBlurType(BlurType)

color

public final <any> colorProperty

The shadow Color.

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

See Also:

getColor(), setColor(Color)

Field Detail

changeIsLocal

private boolean changeIsLocal

input

private <any> 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.

radius

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
 

width

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
 

height

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
 

blurType

private <any> blurType

The algorithm used to blur the shadow.

       Min: n/a
       Max: n/a
   Default: BlurType.THREE_PASS_BOX
  Identity: n/a
 

color

private <any> color

The shadow Color.

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

Constructor Detail

Shadow

public Shadow()

Creates a new instance of Shadow with default parameters.

Shadow

public Shadow(double radius,
              Color color)

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

Parameters:

radius - the radius of the shadow blur kernel

color - the shadow Color

Since:

JavaFX 2.1

Shadow

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

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

Parameters:

blurType - the algorithm used to blur the shadow

color - the shadow Color

radius - the radius of the shadow blur kernel

Since:

JavaFX 2.1

Method Detail

createPeer

com.sun.scenario.effect.GeneralShadow createPeer()

Specified by:

createPeer in class Effect

setInput

public final void setInput(Effect value)

Sets the value of the property input.

getInput

public final Effect getInput()

Gets the value of the property input.

inputProperty

public final <any> inputProperty()

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.

See Also:

getInput(), setInput(Effect)

checkChainContains

boolean checkChainContains(Effect e)

Specified by:

checkChainContains in class Effect

setRadius

public final void setRadius(double value)

Sets the value of the property radius.

getRadius

public final double getRadius()

Gets the value of the property radius.

radiusProperty

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

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

See Also:

getRadius(), setRadius(double)

updateRadius

private void updateRadius(double value)

setWidth

public final void setWidth(double value)

Sets the value of the property width.

getWidth

public final double getWidth()

Gets the value of the property width.

widthProperty

public final DoubleProperty 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 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
 

See Also:

getWidth(), setWidth(double)

updateWidth

private void updateWidth(double value)

setHeight

public final void setHeight(double value)

Sets the value of the property height.

getHeight

public final double getHeight()

Gets the value of the property height.

heightProperty

public final DoubleProperty 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 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
 

See Also:

getHeight(), setHeight(double)

updateHeight

private void updateHeight(double value)

setBlurType

public final void setBlurType(BlurType value)

Sets the value of the property blurType.

getBlurType

public final BlurType getBlurType()

Gets the value of the property blurType.

blurTypeProperty

public final <any> blurTypeProperty()

The algorithm used to blur the shadow.

       Min: n/a
       Max: n/a
   Default: BlurType.THREE_PASS_BOX
  Identity: n/a
 

See Also:

getBlurType(), setBlurType(BlurType)

setColor

public final void setColor(Color value)

Sets the value of the property color.

getColor

public final Color getColor()

Gets the value of the property color.

colorProperty

public final <any> colorProperty()

The shadow Color.

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

See Also:

getColor(), setColor(Color)

getClampedWidth

private float getClampedWidth()

getClampedHeight

private float getClampedHeight()

getColorInternal

private Color getColorInternal()

getBlurTypeInternal

private BlurType getBlurTypeInternal()

update

void update()

Specified by:

update in class Effect

getBounds

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

Description copied from class: Effect

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.

Specified by:

getBounds in class Effect

copy

Effect copy()

Specified by:

copy in class Effect