APIdia Launch Partner
Top Description Fields Constructors Methods
javafx.scene.effect

public Class ColorInput

extends Effect
Class Inheritance
Imports
javafx.beans.property.DoubleProperty, .DoublePropertyBase, .ObjectProperty, .ObjectPropertyBase, javafx.scene.Node, javafx.scene.paint.Color, .Paint, com.sun.javafx.effect.EffectDirtyBits, com.sun.javafx.geom.BaseBounds, .RectBounds, com.sun.javafx.geom.transform.BaseTransform, com.sun.javafx.scene.BoundsAccessor, com.sun.javafx.tk.Toolkit
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.
Since
JavaFX 2.0

Field Summary

Modifier and TypeField and Description
private DoubleProperty
height

Sets the height of the region to be flooded, relative to the local coordinate space of the content Node.

private ObjectProperty<Paint>
paint

The Paint used to flood the region.

private DoubleProperty
width

Sets the width of the region to be flooded, relative to the local coordinate space of the content Node.

private DoubleProperty
x

Sets the x location of the region to be flooded, relative to the local coordinate space of the content Node.

private DoubleProperty
y

Sets the y location of the region to be flooded, relative to the local coordinate space of the content Node.

Constructor Summary

AccessConstructor and Description
public
ColorInput()

Creates a new instance of ColorInput with default parameters.

public
ColorInput(double
the x location of the region to be flooded
x, double
the y location of the region to be flooded
y, double
the width of the region to be flooded
width, double
the height of the region to be flooded
height, Paint
the Paint used to flood the region
paint)

Creates a new instance of ColorInput with the specified x, y, width, height, and paint.

Method Summary

Modifier and TypeMethod and Description
pack-priv boolean
checkChainContains(Effect e)

Implements abstract javafx.scene.effect.Effect.checkChainContains.

pack-priv Effect
copy()

Implements abstract javafx.scene.effect.Effect.copy.

pack-priv Flood
createPeer()

Implements abstract javafx.scene.effect.Effect.createPeer.

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

Implements abstract javafx.scene.effect.Effect.getBounds.

Returns bounds of given node with applied effect.

public final double
getHeight()

public final Paint
getPaint()

private Paint
getPaintInternal()

public final double
getWidth()

public final double
getX()

public final double
getY()

public final DoubleProperty
heightProperty()

public final ObjectProperty<Paint>
paintProperty()

public final void
setHeight(double value)

public final void
setPaint(Paint value)

public final void
setWidth(double value)

public final void
setX(double value)

public final void
setY(double value)

pack-priv void
update()

Implements abstract javafx.scene.effect.Effect.update.

public final DoubleProperty
widthProperty()

public final DoubleProperty
xProperty()

public final DoubleProperty
yProperty()

Inherited from javafx.scene.effect.Effect:
containsCycleseffectBoundsChangedgetInputBoundsgetKernelSizegetPeergetShadowBoundsmarkDirtysynctransformBounds

Field Detail

heightback to summary
private DoubleProperty 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
Default Value
0.0
paintback to summary
private ObjectProperty<Paint> paint

The Paint used to flood the region. 

      Min: n/a
      Max: n/a
  Default: Color.RED
 Identity: n/a
Default Value
RED
widthback to summary
private DoubleProperty 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
Default Value
0.0
xback to summary
private DoubleProperty 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
Default Value
0.0
yback to summary
private DoubleProperty 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
Default Value
0.0

Constructor Detail

ColorInputback to summary
public ColorInput()

Creates a new instance of ColorInput with default parameters.

ColorInputback to summary
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:double

the x location of the region to be flooded

y:double

the y location of the region to be flooded

width:double

the width of the region to be flooded

height:double

the height of the region to be flooded

paint:Paint

the Paint used to flood the region

Since
JavaFX 2.1

Method Detail

checkChainContainsback to summary
pack-priv boolean checkChainContains(Effect e)

Implements abstract javafx.scene.effect.Effect.checkChainContains.

Annotations
@Override
copyback to summary
pack-priv Effect copy()

Implements abstract javafx.scene.effect.Effect.copy.

Annotations
@Override
createPeerback to summary
pack-priv Flood createPeer()

Implements abstract javafx.scene.effect.Effect.createPeer.

Annotations
@Override
getBoundsback to summary
pack-priv BaseBounds getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor)

Implements abstract javafx.scene.effect.Effect.getBounds.

Doc from javafx.scene.effect.Effect.getBounds.

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.

Annotations
@Override
getHeightback to summary
public final double getHeight()
getPaintback to summary
public final Paint getPaint()
getPaintInternalback to summary
private Paint getPaintInternal()
getWidthback to summary
public final double getWidth()
getXback to summary
public final double getX()
getYback to summary
public final double getY()
heightPropertyback to summary
public final DoubleProperty heightProperty()
paintPropertyback to summary
public final ObjectProperty<Paint> paintProperty()
setHeightback to summary
public final void setHeight(double value)
setPaintback to summary
public final void setPaint(Paint value)
setWidthback to summary
public final void setWidth(double value)
setXback to summary
public final void setX(double value)
setYback to summary
public final void setY(double value)
updateback to summary
pack-priv void update()

Implements abstract javafx.scene.effect.Effect.update.

Annotations
@Override
widthPropertyback to summary
public final DoubleProperty widthProperty()
xPropertyback to summary
public final DoubleProperty xProperty()
yPropertyback to summary
public final DoubleProperty yProperty()