com.iamsoft.util.ui.javafx.guideline

Class GuideLine<T>

java.lang.Object

com.iamsoft.util.ui.javafx.guideline.GuideLine<T>

Type Parameters:

T - Axis' type.

Direct Known Subclasses:

HorizontalGuideLine, VerticalGuideLine

public abstract class GuideLine<T>
extends Object

If getMin() == getMax(), line not draggable.

Constructor Summary

Constructors

Constructor and Description
GuideLine(T pValue, javafx.scene.paint.Color pLineColor, javafx.scene.paint.Color pAboveColor, javafx.scene.paint.Color pBelowColor, javafx.geometry.Orientation pOrientation)
GuideLine(T pValue, javafx.geometry.Orientation pOrientation)

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ObjectProperty<javafx.scene.paint.Color>	aboveColorProperty()
javafx.beans.property.ObjectProperty<javafx.scene.shape.Rectangle>	aboveRectangleProperty()
javafx.beans.property.ObjectProperty<javafx.scene.shape.Rectangle>	belowRectangleProperty()
javafx.beans.property.ReadOnlyBooleanProperty	draggableProperty()
javafx.scene.paint.Color	getAboveColor()
javafx.scene.shape.Rectangle	getAboveRectangle()
static javafx.scene.layout.Region	getAncestorRegion(javafx.scene.Node pNode)
javafx.scene.paint.Color	getBelowColor()
javafx.scene.shape.Rectangle	getBelowRectangle()
GuideLineValueConverter<T>	getGuideLineValueConverter()
javafx.scene.shape.Line	getLine()
javafx.scene.paint.Color	getLineColor()
Double	getLinePosition()
T	getMax()
T	getMin()
BiFunction<javafx.scene.input.MouseEvent,javafx.geometry.Orientation,Double>	getMousePositionTransformer()
javafx.geometry.Orientation	getOrientation()
boolean	getPreserveLinePosition()
T	getValue()
javafx.beans.property.ObjectProperty<GuideLineValueConverter<T>>	guideLineValueConverterProperty()
boolean	isDraggable()
javafx.beans.property.ObjectProperty<javafx.scene.paint.Color>	lineColorProperty()
javafx.beans.property.ObjectProperty<Double>	linePositionProperty() Line position as a fraction of available space (i.e.
javafx.beans.property.ObjectProperty<javafx.scene.shape.Line>	lineProperty()
javafx.beans.property.ObjectProperty<javafx.scene.paint.Color>	lineStrokeProperty()
javafx.beans.property.ObjectProperty<T>	maxProperty() Max drag position.
javafx.beans.property.ObjectProperty<T>	minProperty() Min drag position.
javafx.beans.property.ObjectProperty<BiFunction<javafx.scene.input.MouseEvent,javafx.geometry.Orientation,Double>>	mousePositionTransformerProperty() Used by updateValue(MouseEvent) to transform mouse position before recalculating guide-line's value.
javafx.beans.property.BooleanProperty	preserveLinePositionProperty()
void	refresh()
void	setAboveColor(javafx.scene.paint.Color pAboveColor)
void	setAboveRectangle(javafx.scene.shape.Rectangle pAboveRectangle)
void	setBelowColor(javafx.scene.paint.Color pBelowColor)
void	setBelowRectangle(javafx.scene.shape.Rectangle pBelowRectangle)
void	setGuideLineValueConverter(GuideLineValueConverter<T> pConverter)
void	setLine(javafx.scene.shape.Line pLine)
void	setLineColor(javafx.scene.paint.Color pLineColor)
void	setLinePosition(Double pPosition)
void	setLineTransformer(BiFunction<javafx.geometry.Bounds,javafx.geometry.Orientation,javafx.geometry.Bounds> pTransformer)
void	setMax(T pMax)
void	setMin(T pMin)
void	setMousePositionTransformer(BiFunction<javafx.scene.input.MouseEvent,javafx.geometry.Orientation,Double> pTransformer)
void	setPreserveLinePosition(boolean pPreserve)
void	setRectangleTransformer(BiFunction<javafx.geometry.Bounds,javafx.geometry.VPos,javafx.geometry.Bounds> pTransformer)
void	setValue(T pValue)
void	toBack() Moves above/below rectangles to the back of its sibling nodes in terms of z-order.
static javafx.geometry.Bounds	transform(javafx.scene.Node pSrcNode, javafx.geometry.Bounds pBounds, javafx.scene.Node pDestNode)
static javafx.geometry.Point2D	transform(javafx.scene.Node pSrcNode, double pX, double pY, javafx.scene.Node pDestNode)
void	updateLine()
void	updateValue(javafx.scene.input.MouseEvent pEvent)
javafx.beans.property.ObjectProperty<T>	valueProperty() Value drag position.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuideLine

public GuideLine(T pValue,
                 javafx.geometry.Orientation pOrientation)

GuideLine

public GuideLine(T pValue,
                 javafx.scene.paint.Color pLineColor,
                 javafx.scene.paint.Color pAboveColor,
                 javafx.scene.paint.Color pBelowColor,
                 javafx.geometry.Orientation pOrientation)

Method Detail

lineColorProperty

public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> lineColorProperty()

getLineColor

public javafx.scene.paint.Color getLineColor()

setLineColor

public void setLineColor(javafx.scene.paint.Color pLineColor)

aboveColorProperty

public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> aboveColorProperty()

getAboveColor

public javafx.scene.paint.Color getAboveColor()

setAboveColor

public void setAboveColor(javafx.scene.paint.Color pAboveColor)

lineStrokeProperty

public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> lineStrokeProperty()

getBelowColor

public javafx.scene.paint.Color getBelowColor()

setBelowColor

public void setBelowColor(javafx.scene.paint.Color pBelowColor)

aboveRectangleProperty

public javafx.beans.property.ObjectProperty<javafx.scene.shape.Rectangle> aboveRectangleProperty()

getAboveRectangle

public javafx.scene.shape.Rectangle getAboveRectangle()

setAboveRectangle

public void setAboveRectangle(javafx.scene.shape.Rectangle pAboveRectangle)

belowRectangleProperty

public javafx.beans.property.ObjectProperty<javafx.scene.shape.Rectangle> belowRectangleProperty()

getBelowRectangle

public javafx.scene.shape.Rectangle getBelowRectangle()

setBelowRectangle

public void setBelowRectangle(javafx.scene.shape.Rectangle pBelowRectangle)

valueProperty

public javafx.beans.property.ObjectProperty<T> valueProperty()

Value drag position.

getValue

public T getValue()

setValue

public final void setValue(T pValue)

minProperty

public javafx.beans.property.ObjectProperty<T> minProperty()

Min drag position.

getMin

public T getMin()

setMin

public void setMin(T pMin)

maxProperty

public javafx.beans.property.ObjectProperty<T> maxProperty()

Max drag position.

getMax

public T getMax()

setMax

public void setMax(T pMax)

linePositionProperty

public javafx.beans.property.ObjectProperty<Double> linePositionProperty()

Line position as a fraction of available space (i.e. 0..1) or null if line is hidden.

getLinePosition

public Double getLinePosition()

setLinePosition

public final void setLinePosition(Double pPosition)

preserveLinePositionProperty

public javafx.beans.property.BooleanProperty preserveLinePositionProperty()

getPreserveLinePosition

public boolean getPreserveLinePosition()

setPreserveLinePosition

public void setPreserveLinePosition(boolean pPreserve)

mousePositionTransformerProperty

public javafx.beans.property.ObjectProperty<BiFunction<javafx.scene.input.MouseEvent,javafx.geometry.Orientation,Double>> mousePositionTransformerProperty()

Used by updateValue(MouseEvent) to transform mouse position before recalculating guide-line's value. Primary usage is for implementing 'Snap to' support on mouse over.

getMousePositionTransformer

public BiFunction<javafx.scene.input.MouseEvent,javafx.geometry.Orientation,Double> getMousePositionTransformer()

setMousePositionTransformer

public final void setMousePositionTransformer(BiFunction<javafx.scene.input.MouseEvent,javafx.geometry.Orientation,Double> pTransformer)

lineProperty

public javafx.beans.property.ObjectProperty<javafx.scene.shape.Line> lineProperty()

getLine

public javafx.scene.shape.Line getLine()

setLine

public void setLine(javafx.scene.shape.Line pLine)

draggableProperty

public javafx.beans.property.ReadOnlyBooleanProperty draggableProperty()

isDraggable

public boolean isDraggable()

guideLineValueConverterProperty

public javafx.beans.property.ObjectProperty<GuideLineValueConverter<T>> guideLineValueConverterProperty()

getGuideLineValueConverter

public GuideLineValueConverter<T> getGuideLineValueConverter()

setGuideLineValueConverter

public void setGuideLineValueConverter(GuideLineValueConverter<T> pConverter)

getOrientation

public javafx.geometry.Orientation getOrientation()

setLineTransformer

public void setLineTransformer(BiFunction<javafx.geometry.Bounds,javafx.geometry.Orientation,javafx.geometry.Bounds> pTransformer)

setRectangleTransformer

public void setRectangleTransformer(BiFunction<javafx.geometry.Bounds,javafx.geometry.VPos,javafx.geometry.Bounds> pTransformer)

updateValue

public void updateValue(javafx.scene.input.MouseEvent pEvent)

refresh

public void refresh()

updateLine

public void updateLine()

toBack

public void toBack()

Moves above/below rectangles to the back of its sibling nodes in terms of z-order.

getAncestorRegion

public static javafx.scene.layout.Region getAncestorRegion(javafx.scene.Node pNode)

transform

public static javafx.geometry.Point2D transform(javafx.scene.Node pSrcNode,
                                                double pX,
                                                double pY,
                                                javafx.scene.Node pDestNode)

transform

public static javafx.geometry.Bounds transform(javafx.scene.Node pSrcNode,
                                               javafx.geometry.Bounds pBounds,
                                               javafx.scene.Node pDestNode)