javafx.scene.effect

Class ColorInput

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 given Paint. This is equivalent to rendering a filled rectangle into an image and using an ImageInput effect, except that it is more convenient and potentially much more efficient.

Property Summary

Properties

Type	Property and Description
DoubleProperty	height Sets the height of the region to be flooded, relative to the local coordinate space of the content Node.
ObjectProperty<Paint>	paint The Paint used to flood the region.
DoubleProperty	width Sets the width of the region to be flooded, relative to the local coordinate space of the content Node.
DoubleProperty	x Sets the x location of the region to be flooded, relative to the local coordinate space of the content Node.
DoubleProperty	y Sets the y location of the region to be flooded, relative to the local coordinate space of the content Node.

Constructor Summary

Constructors

Constructor and Description
ColorInput()

Method Summary

Methods

Modifier and Type	Method and Description
double	getHeight() Sets the height of the region to be flooded, relative to the local coordinate space of the content Node.
Paint	getPaint() The Paint used to flood the region.
double	getWidth() Sets the width of the region to be flooded, relative to the local coordinate space of the content Node.
double	getX() Sets the x location of the region to be flooded, relative to the local coordinate space of the content Node.
double	getY() Sets the y location of the region to be flooded, relative to the local coordinate space of the content Node.
DoubleProperty	heightProperty() Sets the height of the region to be flooded, relative to the local coordinate space of the content Node.
ObjectProperty<Paint>	paintProperty() The Paint used to flood the region.
void	setHeight(double value) Sets the height of the region to be flooded, relative to the local coordinate space of the content Node.
void	setPaint(Paint value) The Paint used to flood the region.
void	setWidth(double value) Sets the width of the region to be flooded, relative to the local coordinate space of the content Node.
void	setX(double value) Sets the x location of the region to be flooded, relative to the local coordinate space of the content Node.
void	setY(double value) Sets the y location of the region to be flooded, relative to the local coordinate space of the content Node.
DoubleProperty	widthProperty() Sets the width of the region to be flooded, relative to the local coordinate space of the content Node.
DoubleProperty	xProperty() Sets the x location of the region to be flooded, relative to the local coordinate space of the content Node.
DoubleProperty	yProperty() Sets the y location of the region to be flooded, relative to the local coordinate space of the content Node.

Methods inherited from class java.lang.Object

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

Property Detail

paint

The Paint used to flood the region.

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

See Also:

getPaint(), setPaint(Paint)

x

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
 

See Also:

getX(), setX(double)

y

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
 

See Also:

getY(), setY(double)

width

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
 

See Also:

getWidth(), setWidth(double)

height

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
 

See Also:

getHeight(), setHeight(double)

Constructor Detail

ColorInput

public ColorInput()

Method Detail

setPaint

public final void setPaint(Paint value)

The Paint used to flood the region.

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

getPaint

public final Paint getPaint()

The Paint used to flood the region.

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

paintProperty

public final ObjectProperty<Paint> paintProperty()

The Paint used to flood the region.

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

See Also:

getPaint(), setPaint(Paint)

setX

public final void setX(double value)

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
 

getX

public final double getX()

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
 

xProperty

public final DoubleProperty xProperty()

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
 

See Also:

getX(), setX(double)

setY

public final void setY(double value)

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
 

getY

public final double getY()

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
 

yProperty

public final DoubleProperty yProperty()

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
 

See Also:

getY(), setY(double)

setWidth

public final void setWidth(double value)

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
 

getWidth

public final double getWidth()

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
 

widthProperty

public final DoubleProperty widthProperty()

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
 

See Also:

getWidth(), setWidth(double)

setHeight

public final void setHeight(double value)

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
 

getHeight

public final double getHeight()

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
 

heightProperty

public final DoubleProperty heightProperty()

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
 

See Also:

getHeight(), setHeight(double)