java.lang.Object
com.iamsoft.util.ui.javafx.guideline.GuideLine<T>
- Type Parameters:
T
- Axis' type.
- Direct Known Subclasses:
HorizontalGuideLine
,VerticalGuideLine
-
Property Summary
PropertiesTypePropertyDescriptionjavafx.beans.property.ObjectProperty<javafx.scene.paint.Color>
javafx.beans.property.ObjectProperty<javafx.scene.shape.Rectangle>
javafx.beans.property.ObjectProperty<javafx.scene.shape.Rectangle>
javafx.beans.property.ReadOnlyBooleanProperty
javafx.beans.property.ObjectProperty<GuideLineValueConverter<T>>
javafx.beans.property.ObjectProperty<javafx.scene.paint.Color>
javafx.beans.property.ObjectProperty<Double>
Line position as a fraction of available space (i.e.javafx.beans.property.ObjectProperty<javafx.scene.shape.Line>
javafx.beans.property.ObjectProperty<javafx.scene.paint.Color>
javafx.beans.property.ObjectProperty<T>
Max drag position.javafx.beans.property.ObjectProperty<T>
Min drag position.javafx.beans.property.ObjectProperty<BiFunction<javafx.scene.input.MouseEvent,
javafx.geometry.Orientation, Double>> Used by updateValue(MouseEvent) to transform mouse position before recalculating guide-line's value.javafx.beans.property.BooleanProperty
javafx.beans.property.ObjectProperty<T>
Value drag position. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionjavafx.beans.property.ObjectProperty<javafx.scene.paint.Color>
javafx.beans.property.ObjectProperty<javafx.scene.shape.Rectangle>
javafx.beans.property.ObjectProperty<javafx.scene.shape.Rectangle>
javafx.beans.property.ReadOnlyBooleanProperty
javafx.scene.paint.Color
Gets the value of the property aboveColor.javafx.scene.shape.Rectangle
Gets the value of the property aboveRectangle.static javafx.scene.layout.Region
getAncestorRegion
(javafx.scene.Node pNode) javafx.scene.paint.Color
javafx.scene.shape.Rectangle
Gets the value of the property belowRectangle.Gets the value of the property guideLineValueConverter.javafx.scene.shape.Line
getLine()
Gets the value of the property line.javafx.scene.paint.Color
Gets the value of the property lineColor.Gets the value of the property linePosition.getMax()
Gets the value of the property max.getMin()
Gets the value of the property min.BiFunction<javafx.scene.input.MouseEvent,
javafx.geometry.Orientation, Double> Gets the value of the property mousePositionTransformer.javafx.geometry.Orientation
boolean
Gets the value of the property preserveLinePosition.getValue()
Gets the value of the property value.javafx.beans.property.ObjectProperty<GuideLineValueConverter<T>>
boolean
Gets the value of the property draggable.javafx.beans.property.ObjectProperty<javafx.scene.paint.Color>
javafx.beans.property.ObjectProperty<Double>
Line position as a fraction of available space (i.e.javafx.beans.property.ObjectProperty<javafx.scene.shape.Line>
javafx.beans.property.ObjectProperty<javafx.scene.paint.Color>
javafx.beans.property.ObjectProperty<T>
Max drag position.javafx.beans.property.ObjectProperty<T>
Min drag position.javafx.beans.property.ObjectProperty<BiFunction<javafx.scene.input.MouseEvent,
javafx.geometry.Orientation, Double>> Used by updateValue(MouseEvent) to transform mouse position before recalculating guide-line's value.javafx.beans.property.BooleanProperty
void
refresh()
void
setAboveColor
(javafx.scene.paint.Color pAboveColor) Sets the value of the property aboveColor.void
setAboveRectangle
(javafx.scene.shape.Rectangle pAboveRectangle) Sets the value of the property aboveRectangle.void
setBelowColor
(javafx.scene.paint.Color pBelowColor) void
setBelowRectangle
(javafx.scene.shape.Rectangle pBelowRectangle) Sets the value of the property belowRectangle.void
setGuideLineValueConverter
(GuideLineValueConverter<T> pConverter) Sets the value of the property guideLineValueConverter.void
setLine
(javafx.scene.shape.Line pLine) Sets the value of the property line.void
setLineColor
(javafx.scene.paint.Color pLineColor) Sets the value of the property lineColor.final void
setLinePosition
(Double pPosition) Sets the value of the property linePosition.void
setLineTransformer
(BiFunction<javafx.geometry.Bounds, javafx.geometry.Orientation, javafx.geometry.Bounds> pTransformer) void
Sets the value of the property max.void
Sets the value of the property min.final void
setMousePositionTransformer
(BiFunction<javafx.scene.input.MouseEvent, javafx.geometry.Orientation, Double> pTransformer) Sets the value of the property mousePositionTransformer.void
setPreserveLinePosition
(boolean pPreserve) Sets the value of the property preserveLinePosition.void
setRectangleTransformer
(BiFunction<javafx.geometry.Bounds, javafx.geometry.VPos, javafx.geometry.Bounds> pTransformer) final void
Sets the value of the property value.void
toBack()
Moves above/below rectangles to the back of its sibling nodes in terms of z-order.static javafx.geometry.Point2D
transform
(javafx.scene.Node pSrcNode, double pX, double pY, javafx.scene.Node pDestNode) static javafx.geometry.Bounds
transform
(javafx.scene.Node pSrcNode, javafx.geometry.Bounds pBounds, javafx.scene.Node pDestNode) void
void
updateValue
(javafx.scene.input.MouseEvent pEvent) javafx.beans.property.ObjectProperty<T>
Value drag position.
-
Property Details
-
lineColor
public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> lineColorProperty- See Also:
-
aboveColor
public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> aboveColorProperty- See Also:
-
lineStroke
public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> lineStrokeProperty -
aboveRectangle
public javafx.beans.property.ObjectProperty<javafx.scene.shape.Rectangle> aboveRectangleProperty -
belowRectangle
public javafx.beans.property.ObjectProperty<javafx.scene.shape.Rectangle> belowRectangleProperty -
value
Value drag position.- See Also:
-
min
Min drag position. -
max
Max drag position. -
linePosition
Line position as a fraction of available space (i.e. 0..1) or null if line is hidden.- See Also:
-
preserveLinePosition
public javafx.beans.property.BooleanProperty preserveLinePositionProperty -
mousePositionTransformer
public javafx.beans.property.ObjectProperty<BiFunction<javafx.scene.input.MouseEvent,javafx.geometry.Orientation, mousePositionTransformerPropertyDouble>> 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. -
line
public javafx.beans.property.ObjectProperty<javafx.scene.shape.Line> lineProperty- See Also:
-
draggable
public javafx.beans.property.ReadOnlyBooleanProperty draggableProperty- See Also:
-
guideLineValueConverter
public javafx.beans.property.ObjectProperty<GuideLineValueConverter<T>> guideLineValueConverterProperty
-
-
Constructor Details
-
GuideLine
-
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 Details
-
lineColorProperty
public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> lineColorProperty()- See Also:
-
getLineColor
public javafx.scene.paint.Color getLineColor()Gets the value of the property lineColor.- Property description:
-
setLineColor
public void setLineColor(javafx.scene.paint.Color pLineColor) Sets the value of the property lineColor.- Property description:
-
aboveColorProperty
public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> aboveColorProperty()- See Also:
-
getAboveColor
public javafx.scene.paint.Color getAboveColor()Gets the value of the property aboveColor.- Property description:
-
setAboveColor
public void setAboveColor(javafx.scene.paint.Color pAboveColor) Sets the value of the property aboveColor.- Property description:
-
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()Gets the value of the property aboveRectangle.- Property description:
-
setAboveRectangle
public void setAboveRectangle(javafx.scene.shape.Rectangle pAboveRectangle) Sets the value of the property aboveRectangle.- Property description:
-
belowRectangleProperty
public javafx.beans.property.ObjectProperty<javafx.scene.shape.Rectangle> belowRectangleProperty() -
getBelowRectangle
public javafx.scene.shape.Rectangle getBelowRectangle()Gets the value of the property belowRectangle.- Property description:
-
setBelowRectangle
public void setBelowRectangle(javafx.scene.shape.Rectangle pBelowRectangle) Sets the value of the property belowRectangle.- Property description:
-
valueProperty
Value drag position.- See Also:
-
getValue
Gets the value of the property value.- Property description:
- Value drag position.
-
setValue
Sets the value of the property value.- Property description:
- Value drag position.
-
minProperty
Min drag position. -
getMin
Gets the value of the property min.- Property description:
- Min drag position.
-
setMin
Sets the value of the property min.- Property description:
- Min drag position.
-
maxProperty
Max drag position. -
getMax
Gets the value of the property max.- Property description:
- Max drag position.
-
setMax
Sets the value of the property max.- Property description:
- Max drag position.
-
linePositionProperty
Line position as a fraction of available space (i.e. 0..1) or null if line is hidden.- See Also:
-
getLinePosition
Gets the value of the property linePosition.- Property description:
- Line position as a fraction of available space (i.e. 0..1) or null if line is hidden.
-
setLinePosition
Sets the value of the property linePosition.- Property description:
- Line position as a fraction of available space (i.e. 0..1) or null if line is hidden.
-
preserveLinePositionProperty
public javafx.beans.property.BooleanProperty preserveLinePositionProperty() -
getPreserveLinePosition
public boolean getPreserveLinePosition()Gets the value of the property preserveLinePosition.- Property description:
-
setPreserveLinePosition
public void setPreserveLinePosition(boolean pPreserve) Sets the value of the property preserveLinePosition.- Property description:
-
mousePositionTransformerProperty
public javafx.beans.property.ObjectProperty<BiFunction<javafx.scene.input.MouseEvent,javafx.geometry.Orientation, mousePositionTransformerProperty()Double>> 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, getMousePositionTransformer()Double> Gets the value of the property mousePositionTransformer.- Property description:
- 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.
-
setMousePositionTransformer
public final void setMousePositionTransformer(BiFunction<javafx.scene.input.MouseEvent, javafx.geometry.Orientation, Double> pTransformer) Sets the value of the property mousePositionTransformer.- Property description:
- 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.
-
lineProperty
public javafx.beans.property.ObjectProperty<javafx.scene.shape.Line> lineProperty()- See Also:
-
getLine
public javafx.scene.shape.Line getLine()Gets the value of the property line.- Property description:
-
setLine
public void setLine(javafx.scene.shape.Line pLine) Sets the value of the property line.- Property description:
-
draggableProperty
public javafx.beans.property.ReadOnlyBooleanProperty draggableProperty()- See Also:
-
isDraggable
public boolean isDraggable()Gets the value of the property draggable.- Property description:
-
guideLineValueConverterProperty
public javafx.beans.property.ObjectProperty<GuideLineValueConverter<T>> guideLineValueConverterProperty() -
getGuideLineValueConverter
Gets the value of the property guideLineValueConverter.- Property description:
-
setGuideLineValueConverter
Sets the value of the property guideLineValueConverter.- Property description:
-
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)
-