- java.lang.Object
-
- javafx.scene.effect.Effect
-
- javafx.scene.effect.ColorInput
-
public class ColorInput extends Effect
An effect that renders a rectangular region that is filled ("flooded") with the givenPaint. This is equivalent to rendering a filled rectangle into an image and using anImageInputeffect, except that it is more convenient and potentially much more efficient.- Since:
- JavaFX 2.0
-
-
Property Summary
Properties Type Property Description DoublePropertyheightSets the height of the region to be flooded, relative to the local coordinate space of the contentNode.ObjectProperty<Paint>paintThePaintused to flood the region.DoublePropertywidthSets the width of the region to be flooded, relative to the local coordinate space of the contentNode.DoublePropertyxSets the x location of the region to be flooded, relative to the local coordinate space of the contentNode.DoublePropertyySets the y location of the region to be flooded, relative to the local coordinate space of the contentNode.
-
Constructor Summary
Constructors Constructor Description ColorInput()Creates a new instance of ColorInput with default parameters.ColorInput(double x, double y, double width, double height, Paint paint)Creates a new instance of ColorInput with the specified x, y, width, height, and paint.
-
Method Summary
Modifier and Type Method Description doublegetHeight()Gets the value of the property height.PaintgetPaint()Gets the value of the property paint.doublegetWidth()Gets the value of the property width.doublegetX()Gets the value of the property x.doublegetY()Gets the value of the property y.DoublePropertyheightProperty()Sets the height of the region to be flooded, relative to the local coordinate space of the contentNode.ObjectProperty<Paint>paintProperty()ThePaintused to flood the region.voidsetHeight(double value)Sets the value of the property height.voidsetPaint(Paint value)Sets the value of the property paint.voidsetWidth(double value)Sets the value of the property width.voidsetX(double value)Sets the value of the property x.voidsetY(double value)Sets the value of the property y.DoublePropertywidthProperty()Sets the width of the region to be flooded, relative to the local coordinate space of the contentNode.DoublePropertyxProperty()Sets the x location of the region to be flooded, relative to the local coordinate space of the contentNode.DoublePropertyyProperty()Sets the y location of the region to be flooded, relative to the local coordinate space of the contentNode.
-
-
-
Property Detail
-
paint
public final ObjectProperty<Paint> paintProperty
ThePaintused to flood the region.Min: n/a Max: n/a Default: Color.RED Identity: n/a- Default value:
- RED
- See Also:
getPaint(),setPaint(Paint)
-
x
public final DoubleProperty xProperty
Sets the x location of the region to be flooded, relative to the local coordinate space of the contentNode.Min: n/a Max: n/a Default: 0.0 Identity: 0.0- Default value:
- 0.0
- See Also:
getX(),setX(double)
-
y
public final DoubleProperty yProperty
Sets the y location of the region to be flooded, relative to the local coordinate space of the contentNode.Min: n/a Max: n/a Default: 0.0 Identity: 0.0- Default value:
- 0.0
- See Also:
getY(),setY(double)
-
width
public final DoubleProperty widthProperty
Sets the width of the region to be flooded, relative to the local coordinate space of the contentNode.Min: n/a Max: n/a Default: 0.0 Identity: 0.0- Default value:
- 0.0
- See Also:
getWidth(),setWidth(double)
-
height
public final DoubleProperty heightProperty
Sets the height of the region to be flooded, relative to the local coordinate space of the contentNode.Min: n/a Max: n/a Default: 0.0 Identity: 0.0- Default value:
- 0.0
- See Also:
getHeight(),setHeight(double)
-
-
Constructor Detail
-
ColorInput
public ColorInput()
Creates a new instance of ColorInput with default parameters.
-
ColorInput
public ColorInput(double x, double y, double width, double height, Paint paint)Creates a new instance of ColorInput with the specified x, y, width, height, and paint.- Parameters:
x- the x location of the region to be floodedy- the y location of the region to be floodedwidth- the width of the region to be floodedheight- the height of the region to be floodedpaint- thePaintused to flood the region- Since:
- JavaFX 2.1
-
-
Method Detail
-
setPaint
public final void setPaint(Paint value)
Sets the value of the property paint.- Property description:
- The
Paintused to flood the region.Min: n/a Max: n/a Default: Color.RED Identity: n/a - Default value:
- RED
-
getPaint
public final Paint getPaint()
Gets the value of the property paint.- Property description:
- The
Paintused to flood the region.Min: n/a Max: n/a Default: Color.RED Identity: n/a - Default value:
- RED
-
paintProperty
public final ObjectProperty<Paint> paintProperty()
ThePaintused to flood the region.Min: n/a Max: n/a Default: Color.RED Identity: n/a- Default value:
- RED
- See Also:
getPaint(),setPaint(Paint)
-
setX
public final void setX(double value)
Sets the value of the property x.- Property description:
- Sets the x location of the region to be flooded, relative to the
local coordinate space of the content
Node.Min: n/a Max: n/a Default: 0.0 Identity: 0.0 - Default value:
- 0.0
-
getX
public final double getX()
Gets the value of the property x.- Property description:
- Sets the x location of the region to be flooded, relative to the
local coordinate space of the content
Node.Min: n/a Max: n/a Default: 0.0 Identity: 0.0 - Default value:
- 0.0
-
xProperty
public final DoubleProperty xProperty()
Sets the x location of the region to be flooded, relative to the local coordinate space of the contentNode.Min: n/a Max: n/a Default: 0.0 Identity: 0.0- Default value:
- 0.0
- See Also:
getX(),setX(double)
-
setY
public final void setY(double value)
Sets the value of the property y.- Property description:
- Sets the y location of the region to be flooded, relative to the
local coordinate space of the content
Node.Min: n/a Max: n/a Default: 0.0 Identity: 0.0 - Default value:
- 0.0
-
getY
public final double getY()
Gets the value of the property y.- Property description:
- Sets the y location of the region to be flooded, relative to the
local coordinate space of the content
Node.Min: n/a Max: n/a Default: 0.0 Identity: 0.0 - Default value:
- 0.0
-
yProperty
public final DoubleProperty yProperty()
Sets the y location of the region to be flooded, relative to the local coordinate space of the contentNode.Min: n/a Max: n/a Default: 0.0 Identity: 0.0- Default value:
- 0.0
- See Also:
getY(),setY(double)
-
setWidth
public final void setWidth(double value)
Sets the value of the property width.- Property description:
- Sets the width of the region to be flooded, relative to the
local coordinate space of the content
Node.Min: n/a Max: n/a Default: 0.0 Identity: 0.0 - Default value:
- 0.0
-
getWidth
public final double getWidth()
Gets the value of the property width.- Property description:
- Sets the width of the region to be flooded, relative to the
local coordinate space of the content
Node.Min: n/a Max: n/a Default: 0.0 Identity: 0.0 - Default value:
- 0.0
-
widthProperty
public final DoubleProperty widthProperty()
Sets the width of the region to be flooded, relative to the local coordinate space of the contentNode.Min: n/a Max: n/a Default: 0.0 Identity: 0.0- Default value:
- 0.0
- See Also:
getWidth(),setWidth(double)
-
setHeight
public final void setHeight(double value)
Sets the value of the property height.- Property description:
- Sets the height of the region to be flooded, relative to the
local coordinate space of the content
Node.Min: n/a Max: n/a Default: 0.0 Identity: 0.0 - Default value:
- 0.0
-
getHeight
public final double getHeight()
Gets the value of the property height.- Property description:
- Sets the height of the region to be flooded, relative to the
local coordinate space of the content
Node.Min: n/a Max: n/a Default: 0.0 Identity: 0.0 - Default value:
- 0.0
-
heightProperty
public final DoubleProperty heightProperty()
Sets the height of the region to be flooded, relative to the local coordinate space of the contentNode.Min: n/a Max: n/a Default: 0.0 Identity: 0.0- Default value:
- 0.0
- See Also:
getHeight(),setHeight(double)
-
-