javafx.scene.effect

Class SepiaTone

java.lang.Object

javafx.scene.effect.Effect

javafx.scene.effect.SepiaTone

public class SepiaTone
extends Effect

A filter that produces a sepia tone effect, similar to antique photographs.

Example:

 SepiaTone sepiaTone = new SepiaTone();
 sepiaTone.setLevel(0.7);

 Image image = new Image("boat.jpg");
 ImageView imageView = new ImageView(image);
 imageView.setFitWidth(200);
 imageView.setPreserveRatio(true);
 imageView.setEffect(sepiaTone);
 

The code above applied on this image:

produces the following:

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
<any>	input The input for this Effect.
DoubleProperty	level The level value, which controls the intensity of the sepia effect.

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.effect.Effect

Effect.EffectInputChangeListener, Effect.EffectInputProperty

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	input The input for this Effect.
private DoubleProperty	level The level value, which controls the intensity of the sepia effect.

Constructor Summary

Constructors

Constructor and Description
SepiaTone() Creates a new instance of SepiaTone with default parameters.
SepiaTone(double level) Creates a new instance of SepiaTone with the specified level.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	checkChainContains(Effect e)
(package private) Effect	copy()
(package private) com.sun.scenario.effect.SepiaTone	createPeer()
(package private) BaseBounds	getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor) Returns bounds of given node with applied effect.
Effect	getInput() Gets the value of the property input.
double	getLevel() Gets the value of the property level.
<any>	inputProperty() The input for this Effect.
DoubleProperty	levelProperty() The level value, which controls the intensity of the sepia effect.
void	setInput(Effect value) Sets the value of the property input.
void	setLevel(double value) Sets the value of the property level.
(package private) void	update()

Methods inherited from class javafx.scene.effect.Effect

containsCycles, effectBoundsChanged, getInputBounds, getKernelSize, getPeer, getShadowBounds, markDirty, sync, transformBounds

Methods inherited from class java.lang.Object

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

Property Detail

input

public final <any> 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)

level

public final DoubleProperty levelProperty

The level value, which controls the intensity of the sepia effect.

       Min: 0.0f
       Max: 1.0f
   Default: 1.0f
  Identity: 0.0f
 

See Also:

getLevel(), setLevel(double)

Field Detail

input

private <any> 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.

level

private DoubleProperty level

The level value, which controls the intensity of the sepia effect.

       Min: 0.0f
       Max: 1.0f
   Default: 1.0f
  Identity: 0.0f
 

Constructor Detail

SepiaTone

public SepiaTone()

Creates a new instance of SepiaTone with default parameters.

SepiaTone

public SepiaTone(double level)

Creates a new instance of SepiaTone with the specified level.

Parameters:

level - the level value, which controls the intensity of the effect

Since:

JavaFX 2.1

Method Detail

createPeer

com.sun.scenario.effect.SepiaTone createPeer()

Specified by:

createPeer in class Effect

setInput

public final void setInput(Effect value)

Sets the value of the property input.

getInput

public final Effect getInput()

Gets the value of the property input.

inputProperty

public final <any> 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)

checkChainContains

boolean checkChainContains(Effect e)

Specified by:

checkChainContains in class Effect

setLevel

public final void setLevel(double value)

Sets the value of the property level.

getLevel

public final double getLevel()

Gets the value of the property level.

levelProperty

public final DoubleProperty levelProperty()

The level value, which controls the intensity of the sepia effect.

       Min: 0.0f
       Max: 1.0f
   Default: 1.0f
  Identity: 0.0f
 

See Also:

getLevel(), setLevel(double)

update

void update()

Specified by:

update in class Effect

getBounds

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

Description copied from class: Effect

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.

Specified by:

getBounds in class Effect

copy

Effect copy()

Specified by:

copy in class Effect