org.eclipse.gef4.mvc.fx.ui.properties

Class FXAdvancedGradientPicker

java.lang.Object

org.eclipse.gef4.mvc.fx.ui.properties.FXAdvancedGradientPicker

All Implemented Interfaces:

IPropertyChangeNotifier

public class FXAdvancedGradientPicker
extends java.lang.Object
implements IPropertyChangeNotifier

A picker for multi-stop LinearGradients.

Constructor Summary

Constructors

Constructor and Description
FXAdvancedGradientPicker(Composite parent) Constructs a new FXAdvancedGradientPicker.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
protected static javafx.scene.paint.LinearGradient	createAdvancedLinearGradient(javafx.scene.paint.Color c1, javafx.scene.paint.Color c2, javafx.scene.paint.Color c3) Creates an "advanced" linear color gradient with 3 stops from the given colors.
protected Control	createControl(Composite parent) Creates the visualization for this FXAdvancedGradientPicker.
protected void	createStop(double offset) Creates a new spot for the given offset.
javafx.scene.paint.Paint	getAdvancedGradient() Returns the currently selected advanced gradient.
Control	getControl() Returns the Control that visualizes this FXAdvancedGradientPicker.
protected double	getNextOffset(int stopIndex) Computes the maximum offset for the given stop index.
protected double	getPrevOffset(int stopIndex) Computes the minimum offset for the given stop index.
protected java.util.List<javafx.scene.paint.Stop>	getStops() Returns a list of the Stops of the currently selected advanced gradient.
static boolean	isAdvancedGradient(javafx.scene.paint.Paint paint) Returns true if the given Paint is considered to be an "advanced" gradient.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
protected void	removeStop(int index) Removes the spot specified by the given index.
void	setAdvancedGradient(javafx.scene.paint.Paint advancedGradient) Sets the gradient managed by this gradient picker to the given value.
protected void	updateDirectionLine() Updates the direction line to display the current direction (specified by directionX and directionY).
protected void	updateGradient(java.util.List<javafx.scene.paint.Stop> newStops) Changes the currently selected advanced gradient to a new linear gradient that is constructed from the given list of Stops.
protected void	updateStop(int index, double offset, javafx.scene.paint.Color color) Sets the offset and color of the spot specified by the given index to the given values.

Methods inherited from class java.lang.Object

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

Constructor Detail

FXAdvancedGradientPicker

public FXAdvancedGradientPicker(Composite parent)

Constructs a new FXAdvancedGradientPicker.

Parameters:

parent - The parent Composite.

Method Detail

createAdvancedLinearGradient

protected static javafx.scene.paint.LinearGradient createAdvancedLinearGradient(javafx.scene.paint.Color c1,
                                                                                javafx.scene.paint.Color c2,
                                                                                javafx.scene.paint.Color c3)

Creates an "advanced" linear color gradient with 3 stops from the given colors.

Parameters:

c1 - The start color.

c2 - The middle color (t = 0.5).

c3 - The end color.

Returns:

An "advanced" LinearGradient from the given colors.

isAdvancedGradient

public static boolean isAdvancedGradient(javafx.scene.paint.Paint paint)

Returns true if the given Paint is considered to be an "advanced" gradient. Otherwise returns false. An advanced gradient can either be a linear gradient with at least 3 stops, or any radial gradient.

Parameters:

paint - The Paint in question.

Returns:

true if the given Paint is considered to be an "advanced" gradient, othwerise false.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface IPropertyChangeNotifier

createControl

protected Control createControl(Composite parent)

Creates the visualization for this FXAdvancedGradientPicker.

Parameters:

parent - The parent Composite.

Returns:

The Control that visualizes this FXAdvancedGradientPicker.

createStop

protected void createStop(double offset)

Creates a new spot for the given offset.

Parameters:

offset - The offset for the new spot.

getAdvancedGradient

public javafx.scene.paint.Paint getAdvancedGradient()

Returns the currently selected advanced gradient.

Returns:

The currently selected advanced gradient.

getControl

public Control getControl()

Returns the Control that visualizes this FXAdvancedGradientPicker.

Returns:

The Control that visualizes this FXAdvancedGradientPicker.

getNextOffset

protected double getNextOffset(int stopIndex)

Computes the maximum offset for the given stop index.

Parameters:

stopIndex - The index of the stop for which to compute the next offset.

Returns:

The maximum offset for the given stop index.

getPrevOffset

protected double getPrevOffset(int stopIndex)

Computes the minimum offset for the given stop index.

Parameters:

stopIndex - The index of the stop for which to compute the previous offset.

Returns:

The minimum offset for the given stop index.

getStops

protected java.util.List<javafx.scene.paint.Stop> getStops()

Returns a list of the Stops of the currently selected advanced gradient.

Returns:

A list of the Stops of the currently selected advanced gradient.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface IPropertyChangeNotifier

removeStop

protected void removeStop(int index)

Removes the spot specified by the given index.

Parameters:

index - The spot index.

setAdvancedGradient

public void setAdvancedGradient(javafx.scene.paint.Paint advancedGradient)

Sets the gradient managed by this gradient picker to the given value. Does also update the UI so that the new gradient can be manipulated.

Parameters:

advancedGradient - The new gradient.

updateDirectionLine

protected void updateDirectionLine()

Updates the direction line to display the current direction (specified by directionX and directionY).

updateGradient

protected void updateGradient(java.util.List<javafx.scene.paint.Stop> newStops)

Changes the currently selected advanced gradient to a new linear gradient that is constructed from the given list of Stops.

Parameters:

newStops - The list of Stops from which the newly selected advanced gradient is constructed.

updateStop

protected void updateStop(int index,
                          double offset,
                          javafx.scene.paint.Color color)

Sets the offset and color of the spot specified by the given index to the given values.

Parameters:

index - The index of the spot.

offset - The new offset for that spot.

color - The new color for that spot.