java.lang.Object
javafx.scene.effect.Effect
javafx.scene.effect.InnerShadow
A high-level effect that renders a shadow inside the edges of the
given content with the specified color, radius, and offset.
Example:
InnerShadow innerShadow = new InnerShadow();
innerShadow.setOffsetX(4);
innerShadow.setOffsetY(4);
innerShadow.setColor(Color.web("0x3b596d"));
Text text = new Text();
text.setEffect(innerShadow);
text.setX(20);
text.setY(100);
text.setText("InnerShadow");
text.setFill(Color.ALICEBLUE);
text.setFont(Font.font(null, FontWeight.BOLD, 50));
The code above produces the following:
- Since:
- JavaFX 2.0
-
Property Summary
TypePropertyDescriptionfinal ObjectProperty<BlurType>
The algorithm used to blur the shadow.final DoubleProperty
The choke of 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 shadow offset in the x direction, in pixels.final DoubleProperty
The shadow offset in the y direction, in pixels.final DoubleProperty
The radius of the shadow blur kernel.final DoubleProperty
The horizontal size of the shadow blur kernel. -
Constructor Summary
ConstructorDescriptionCreates a new instance of InnerShadow with default parameters.InnerShadow
(double radius, double offsetX, double offsetY, Color color) Creates a new instance of InnerShadow with specified radius, offsetX, offsetY and color.InnerShadow
(double radius, Color color) Creates a new instance of InnerShadow with specified radius and color.InnerShadow
(BlurType blurType, Color color, double radius, double choke, double offsetX, double offsetY) Creates a new instance of InnerShadow with the specified blurType, color, radius, spread, offsetX and offsetY. -
Method Summary
Modifier and TypeMethodDescriptionfinal ObjectProperty<BlurType>
The algorithm used to blur the shadow.final DoubleProperty
The choke of the shadow.final ObjectProperty<Color>
The shadowColor
.final BlurType
Gets the value of the property blurType.final double
getChoke()
Gets the value of the property choke.final Color
getColor()
Gets the value of the property color.final double
Gets the value of the property height.final Effect
getInput()
Gets the value of the property input.final double
Gets the value of the property offsetX.final double
Gets the value of the property offsetY.final double
Gets the value of the property radius.final double
getWidth()
Gets the value of the property width.final DoubleProperty
The vertical size of the shadow blur kernel.final ObjectProperty<Effect>
The input for thisEffect
.final DoubleProperty
The shadow offset in the x direction, in pixels.final DoubleProperty
The shadow offset in the y direction, in pixels.final DoubleProperty
The radius of the shadow blur kernel.final void
setBlurType
(BlurType value) Sets the value of the property blurType.final void
setChoke
(double value) Sets the value of the property choke.final void
Sets the value of the property color.final void
setHeight
(double value) Sets the value of the property height.final void
Sets the value of the property input.final void
setOffsetX
(double value) Sets the value of the property offsetX.final void
setOffsetY
(double value) Sets the value of the property offsetY.final void
setRadius
(double value) Sets the value of the property radius.final void
setWidth
(double value) Sets the value of the property width.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:
-
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 of0.0
will result in a distribution of the shadow determined entirely by the blur algorithm. A choke of1.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
- Default value:
- 0.0
- See Also:
-
color
The shadowColor
.Min: n/a Max: n/a Default: Color.BLACK Identity: n/a
- Default value:
- BLACK
- See Also:
-
offsetX
The shadow offset in the x direction, in pixels.Min: n/a Max: n/a Default: 0.0 Identity: 0.0
- Default value:
- 0.0
- See Also:
-
offsetY
The shadow offset in the y direction, in pixels.Min: n/a Max: n/a Default: 0.0 Identity: 0.0
- Default value:
- 0.0
- See Also:
-
-
Constructor Details
-
InnerShadow
public InnerShadow()Creates a new instance of InnerShadow with default parameters. -
InnerShadow
Creates a new instance of InnerShadow with specified radius and color.- Parameters:
radius
- the radius of the shadow blur kernelcolor
- the shadowColor
-
InnerShadow
Creates a new instance of InnerShadow with specified radius, offsetX, offsetY and color.- Parameters:
radius
- the radius of the shadow blur kerneloffsetX
- the shadow offset in the x directionoffsetY
- the shadow offset in the y directioncolor
- the shadowColor
-
InnerShadow
public InnerShadow(BlurType blurType, Color color, double radius, double choke, double offsetX, double offsetY) Creates a new instance of InnerShadow with the specified blurType, color, radius, spread, offsetX and offsetY.- Parameters:
blurType
- the algorithm used to blur the shadowcolor
- the shadowColor
radius
- the radius of the shadow blur kernelchoke
- the portion of the radius where the contribution of the source material will be 100%offsetX
- the shadow offset in the x directionoffsetY
- the shadow offset in the y direction- Since:
- JavaFX 2.1
-
-
Method Details
-
setInput
Sets the value of the property input.- 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
-
getInput
Gets the value of the property input.- 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
-
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
- See Also:
-
setRadius
public final void setRadius(double value) Sets the value of the property radius.- 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
-
getRadius
public final double getRadius()Gets the value of the property radius.- 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
-
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
- See Also:
-
setWidth
public final void setWidth(double value) Sets the value of the property width.- 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
-
getWidth
public final double getWidth()Gets the value of the property width.- 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
-
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
- See Also:
-
setHeight
public final void setHeight(double value) Sets the value of the property height.- 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
-
getHeight
public final double getHeight()Gets the value of the property height.- 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
-
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
- See Also:
-
setBlurType
Sets the value of the property blurType.- 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
-
getBlurType
Gets the value of the property blurType.- 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
-
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
- See Also:
-
setChoke
public final void setChoke(double value) Sets the value of the property choke.- Property description:
- 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 of1.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
- Default value:
- 0.0
-
getChoke
public final double getChoke()Gets the value of the property choke.- Property description:
- 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 of1.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
- Default value:
- 0.0
-
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 of0.0
will result in a distribution of the shadow determined entirely by the blur algorithm. A choke of1.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
- Default value:
- 0.0
- See Also:
-
setColor
Sets the value of the property color.- Property description:
- The shadow
Color
.Min: n/a Max: n/a Default: Color.BLACK Identity: n/a
- Default value:
- BLACK
-
getColor
Gets the value of the property color.- Property description:
- The shadow
Color
.Min: n/a Max: n/a Default: Color.BLACK Identity: n/a
- Default value:
- BLACK
-
colorProperty
The shadowColor
.Min: n/a Max: n/a Default: Color.BLACK Identity: n/a
- Default value:
- BLACK
- See Also:
-
setOffsetX
public final void setOffsetX(double value) Sets the value of the property offsetX.- Property description:
- The shadow offset in the x direction, in pixels.
Min: n/a Max: n/a Default: 0.0 Identity: 0.0
- Default value:
- 0.0
-
getOffsetX
public final double getOffsetX()Gets the value of the property offsetX.- Property description:
- The shadow offset in the x direction, in pixels.
Min: n/a Max: n/a Default: 0.0 Identity: 0.0
- Default value:
- 0.0
-
offsetXProperty
The shadow offset in the x direction, in pixels.Min: n/a Max: n/a Default: 0.0 Identity: 0.0
- Default value:
- 0.0
- See Also:
-
setOffsetY
public final void setOffsetY(double value) Sets the value of the property offsetY.- Property description:
- The shadow offset in the y direction, in pixels.
Min: n/a Max: n/a Default: 0.0 Identity: 0.0
- Default value:
- 0.0
-
getOffsetY
public final double getOffsetY()Gets the value of the property offsetY.- Property description:
- The shadow offset in the y direction, in pixels.
Min: n/a Max: n/a Default: 0.0 Identity: 0.0
- Default value:
- 0.0
-
offsetYProperty
The shadow offset in the y direction, in pixels.Min: n/a Max: n/a Default: 0.0 Identity: 0.0
- Default value:
- 0.0
- See Also:
-