InnerShadow (Java FX 2.0)

java.lang.Object
- javafx.scene.effect.Effect
- - javafx.scene.effect.InnerShadow

public class InnerShadow
extends Effect

A high-level effect that renders a shadow inside the edges of the given content with the specified color, radius, and offset.

import javafx.scene.*;
import javafx.scene.text.*;
import javafx.scene.paint.*;
import javafx.scene.effect.*;

InnerShadow is = new InnerShadow();
is.setOffsetX(4.0);
is.setOffsetY(4.0);

Text t = new Text();
t.setEffect(is);
t.setX(20);
t.setY(100);
t.setText("InnerShadow");
t.setFill(Color.YELLOW);
t.setFont(Font.font(null, FontWeight.BOLD, 80));

Property Summary

Properties
Type	Property and Description
`ObjectProperty<BlurType>`	`blurType` The algorithm used to blur the shadow.
`DoubleProperty`	`choke` The choke of the shadow.
`ObjectProperty<Color>`	`color` The shadow `Color`.
`DoubleProperty`	`height` The vertical size of the shadow blur kernel.
`ObjectProperty<Effect>`	`input` The input for this `Effect`.
`DoubleProperty`	`offsetX` The shadow offset in the x direction, in pixels.
`DoubleProperty`	`offsetY` The shadow offset in the y direction, in pixels.
`DoubleProperty`	`radius` The radius of the shadow blur kernel.
`DoubleProperty`	`width` The horizontal size of the shadow blur kernel.

Constructor Summary

Constructors
Constructor and Description
`InnerShadow()` Creates a new instance of InnerShadow with default parameters.
`InnerShadow(double radius, Color color)` Creates a new instance of InnerShadow with specified radius and color.
`InnerShadow(double radius, double offsetX, double offsetY, Color color)` Creates a new instance of InnerShadow with specified radius, offsetX, offsetY and color.

Method Summary

Methods
Modifier and Type	Method and Description
`ObjectProperty<BlurType>`	`blurTypeProperty()` The algorithm used to blur the shadow.
`DoubleProperty`	`chokeProperty()` The choke of the shadow.
`ObjectProperty<Color>`	`colorProperty()` The shadow `Color`.
`BlurType`	`getBlurType()` The algorithm used to blur the shadow.
`double`	`getChoke()` The choke of the shadow.
`Color`	`getColor()` The shadow `Color`.
`double`	`getHeight()` The vertical size of the shadow blur kernel.
`Effect`	`getInput()` The input for this `Effect`.
`double`	`getOffsetX()` The shadow offset in the x direction, in pixels.
`double`	`getOffsetY()` The shadow offset in the y direction, in pixels.
`double`	`getRadius()` The radius of the shadow blur kernel.
`double`	`getWidth()` The horizontal size of the shadow blur kernel.
`DoubleProperty`	`heightProperty()` The vertical size of the shadow blur kernel.
`ObjectProperty<Effect>`	`inputProperty()` The input for this `Effect`.
`DoubleProperty`	`offsetXProperty()` The shadow offset in the x direction, in pixels.
`DoubleProperty`	`offsetYProperty()` The shadow offset in the y direction, in pixels.
`DoubleProperty`	`radiusProperty()` The radius of the shadow blur kernel.
`void`	`setBlurType(BlurType value)` The algorithm used to blur the shadow.
`void`	`setChoke(double value)` The choke of the shadow.
`void`	`setColor(Color value)` The shadow `Color`.
`void`	`setHeight(double value)` The vertical size of the shadow blur kernel.
`void`	`setInput(Effect value)` The input for this `Effect`.
`void`	`setOffsetX(double value)` The shadow offset in the x direction, in pixels.
`void`	`setOffsetY(double value)` The shadow offset in the y direction, in pixels.
`void`	`setRadius(double value)` The radius of the shadow blur kernel.
`void`	`setWidth(double value)` The horizontal size of the shadow blur kernel.
`DoubleProperty`	`widthProperty()` The horizontal size of the shadow blur kernel.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - 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.
    
    See Also:
    getInput(), setInput(Effect)
  - 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
 
```
    See Also:
    getRadius(), setRadius(double)
  - 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
 
```
    See Also:
    getWidth(), setWidth(double)
  - 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
 
```
    See Also:
    getHeight(), setHeight(double)
  - blurType
    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)
  - choke
    The choke of the shadow. The choke is the portion of the radius where the contribution of the source material will be 100%. The remaining portion of the radius will have a contribution controlled by the blur kernel. A choke of 0.0 will result in a distribution of the shadow determined entirely by the blur algorithm. A choke of 1.0 will result in a solid growth inward of the shadow from the edges to the limit of the radius with a very sharp cutoff to transparency inside the radius.
```
       Min: 0.0
       Max: 1.0
   Default: 0.0
  Identity: 0.0
 
```
    See Also:
    getChoke(), setChoke(double)
  - color
    The shadow Color.
```
       Min: n/a
       Max: n/a
   Default: Color.BLACK
  Identity: n/a
 
```
    See Also:
    getColor(), setColor(Color)
  - offsetX
    The shadow offset in the x direction, in pixels.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
    See Also:
    getOffsetX(), setOffsetX(double)
  - offsetY
    The shadow offset in the y direction, in pixels.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
    See Also:
    getOffsetY(), setOffsetY(double)
- Constructor Detail
  - InnerShadow
```
public InnerShadow()
```
    Creates a new instance of InnerShadow with default parameters.
  - InnerShadow
```
public InnerShadow(double radius,
           Color color)
```
    Creates a new instance of InnerShadow with specified radius and color.
    
    Parameters:
    radius - the radius of the shadow blur kernel
    color - the shadow Color
  - InnerShadow
```
public InnerShadow(double radius,
           double offsetX,
           double offsetY,
           Color color)
```
    Creates a new instance of InnerShadow with specified radius, offsetX, offsetY and color.
    
    Parameters:
    radius - the radius of the shadow blur kernel
    offsetX - the horizontal size of the shadow blur kernel
    offsetY - the horizontal size of the shadow blur kernel
    color - the shadow Color
- Method Detail
  - setInput
```
public final void setInput(Effect value)
```
    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.
  - getInput
```
public final Effect getInput()
```
    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.
  - inputProperty
```
public final ObjectProperty<Effect> 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)
  - setRadius
```
public final void setRadius(double value)
```
    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
 
```
  - getRadius
```
public final double getRadius()
```
    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
 
```
  - 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)
  - setWidth
```
public final void setWidth(double value)
```
    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
 
```
  - getWidth
```
public final double getWidth()
```
    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
 
```
  - 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)
  - setHeight
```
public final void setHeight(double value)
```
    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
 
```
  - getHeight
```
public final double getHeight()
```
    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
 
```
  - 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)
  - setBlurType
```
public final void setBlurType(BlurType value)
```
    The algorithm used to blur the shadow.
```
       Min: n/a
       Max: n/a
   Default: BlurType.THREE_PASS_BOX
  Identity: n/a
 
```
  - getBlurType
```
public final BlurType getBlurType()
```
    The algorithm used to blur the shadow.
```
       Min: n/a
       Max: n/a
   Default: BlurType.THREE_PASS_BOX
  Identity: n/a
 
```
  - blurTypeProperty
```
public final ObjectProperty<BlurType> 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)
  - setChoke
```
public final void setChoke(double value)
```
    The choke of the shadow. The choke is the portion of the radius where the contribution of the source material will be 100%. The remaining portion of the radius will have a contribution controlled by the blur kernel. A choke of 0.0 will result in a distribution of the shadow determined entirely by the blur algorithm. A choke of 1.0 will result in a solid growth inward of the shadow from the edges to the limit of the radius with a very sharp cutoff to transparency inside the radius.
```
       Min: 0.0
       Max: 1.0
   Default: 0.0
  Identity: 0.0
 
```
  - getChoke
```
public final double getChoke()
```
    The choke of the shadow. The choke is the portion of the radius where the contribution of the source material will be 100%. The remaining portion of the radius will have a contribution controlled by the blur kernel. A choke of 0.0 will result in a distribution of the shadow determined entirely by the blur algorithm. A choke of 1.0 will result in a solid growth inward of the shadow from the edges to the limit of the radius with a very sharp cutoff to transparency inside the radius.
```
       Min: 0.0
       Max: 1.0
   Default: 0.0
  Identity: 0.0
 
```
  - chokeProperty
```
public final DoubleProperty chokeProperty()
```
    The choke of the shadow. The choke is the portion of the radius where the contribution of the source material will be 100%. The remaining portion of the radius will have a contribution controlled by the blur kernel. A choke of 0.0 will result in a distribution of the shadow determined entirely by the blur algorithm. A choke of 1.0 will result in a solid growth inward of the shadow from the edges to the limit of the radius with a very sharp cutoff to transparency inside the radius.
```
       Min: 0.0
       Max: 1.0
   Default: 0.0
  Identity: 0.0
 
```
    See Also:
    getChoke(), setChoke(double)
  - setColor
```
public final void setColor(Color value)
```
    The shadow Color.
```
       Min: n/a
       Max: n/a
   Default: Color.BLACK
  Identity: n/a
 
```
  - getColor
```
public final Color getColor()
```
    The shadow Color.
```
       Min: n/a
       Max: n/a
   Default: Color.BLACK
  Identity: n/a
 
```
  - colorProperty
```
public final ObjectProperty<Color> colorProperty()
```
    The shadow Color.
```
       Min: n/a
       Max: n/a
   Default: Color.BLACK
  Identity: n/a
 
```
    See Also:
    getColor(), setColor(Color)
  - setOffsetX
```
public final void setOffsetX(double value)
```
    The shadow offset in the x direction, in pixels.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
  - getOffsetX
```
public final double getOffsetX()
```
    The shadow offset in the x direction, in pixels.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
  - offsetXProperty
```
public final DoubleProperty offsetXProperty()
```
    The shadow offset in the x direction, in pixels.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
    See Also:
    getOffsetX(), setOffsetX(double)
  - setOffsetY
```
public final void setOffsetY(double value)
```
    The shadow offset in the y direction, in pixels.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
  - getOffsetY
```
public final double getOffsetY()
```
    The shadow offset in the y direction, in pixels.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
  - offsetYProperty
```
public final DoubleProperty offsetYProperty()
```
    The shadow offset in the y direction, in pixels.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
    See Also:
    getOffsetY(), setOffsetY(double)

Class InnerShadow

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

input

radius

width

height

blurType

choke

color

offsetX

offsetY

Constructor Detail

InnerShadow

InnerShadow

InnerShadow

Method Detail

setInput

getInput

inputProperty

setRadius

getRadius

radiusProperty

setWidth

getWidth

widthProperty

setHeight

getHeight

heightProperty

setBlurType

getBlurType

blurTypeProperty

setChoke

getChoke

chokeProperty

setColor

getColor

colorProperty

setOffsetX

getOffsetX

offsetXProperty

setOffsetY

getOffsetY

offsetYProperty