Module org.refcodes.graphical.ext.javafx
Package org.refcodes.graphical.ext.javafx

Class FxLabelDecorator

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
javafx.scene.layout.StackPane
org.refcodes.graphical.ext.javafx.FxLabelDecorator
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, org.refcodes.mixin.TextAccessor, org.refcodes.mixin.TextAccessor.TextBuilder<FxLabelDecorator>, org.refcodes.mixin.TextAccessor.TextMutator, org.refcodes.mixin.TextAccessor.TextProperty, org.refcodes.textual.FontNameAccessor, org.refcodes.textual.FontNameAccessor.FontNameBuilder<FxLabelDecorator>, org.refcodes.textual.FontNameAccessor.FontNameMutator, org.refcodes.textual.FontNameAccessor.FontNameProperty, org.refcodes.textual.HorizAlignTextModeAccessor, org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<FxLabelDecorator>, org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeMutator, org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeProperty, org.refcodes.textual.VertAlignTextModeAccessor, org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeBuilder<FxLabelDecorator>, org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeMutator, org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeProperty
public class FxLabelDecorator extends javafx.scene.layout.StackPane implements org.refcodes.mixin.TextAccessor.TextProperty, org.refcodes.mixin.TextAccessor.TextBuilder<FxLabelDecorator>, org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeProperty, org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<FxLabelDecorator>, org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeProperty, org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeBuilder<FxLabelDecorator>, org.refcodes.textual.FontNameAccessor.FontNameProperty, org.refcodes.textual.FontNameAccessor.FontNameBuilder<FxLabelDecorator>
Implementation of the FxLabelDecorator interface. Possible extension (idea): Provide means to set cell width and height manually and make them images then scale accordingly!

  • Property Summary

    Properties inherited from class javafx.scene.layout.StackPane

    alignment

    Properties inherited from class javafx.scene.layout.Region

    background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

    Properties inherited from class javafx.scene.Parent

    needsLayout

    Properties inherited from class javafx.scene.Node

    accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.refcodes.textual.FontNameAccessor

    org.refcodes.textual.FontNameAccessor.FontNameBuilder<B extends org.refcodes.textual.FontNameAccessor.FontNameBuilder<B>>, org.refcodes.textual.FontNameAccessor.FontNameMutator, org.refcodes.textual.FontNameAccessor.FontNameProperty

    Nested classes/interfaces inherited from interface org.refcodes.textual.HorizAlignTextModeAccessor

    org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<B extends org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<B>>, org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeMutator, org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeProperty

    Nested classes/interfaces inherited from interface org.refcodes.mixin.TextAccessor

    org.refcodes.mixin.TextAccessor.TextBuilder<B extends org.refcodes.mixin.TextAccessor.TextBuilder<B>>, org.refcodes.mixin.TextAccessor.TextMutator, org.refcodes.mixin.TextAccessor.TextProperty

    Nested classes/interfaces inherited from interface org.refcodes.textual.VertAlignTextModeAccessor

    org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeBuilder<B extends org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeBuilder<B>>, org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeMutator, org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeProperty

  • Field Summary

    Fields inherited from class javafx.scene.layout.Region

    USE_COMPUTED_SIZE, USE_PREF_SIZE

    Fields inherited from class javafx.scene.Node

    BASELINE_OFFSET_SAME_AS_HEIGHT

  • Constructor Summary

    Constructors
    Constructor
    Description
    FxLabelDecorator(Object aText, String aFontName, double aTextSizeFactor, javafx.scene.image.Image aImage)
    Constructs a FxLabelDecorator with the required minimum attributes.
    FxLabelDecorator(String aText, String aFontName, double aTextSizeFactor, javafx.scene.image.Image aImage)
    Constructs a FxLabelDecorator with the required minimum attributes.
    FxLabelDecorator(String aText, String aFontName, double aTextSizeFactor, javafx.scene.Node aNode)
    Constructs a FxLabelDecorator with the required minimum attributes.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getBottomTextMarginFactor()
    Returns the bottom margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    double
    getBottomTextPaddingFactor()
    Returns the bottom padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    javafx.scene.Node
    getContent()
    Returns the node of the cell.
    String
    getFontName()
    org.refcodes.textual.HorizAlignTextMode
    getHorizAlignTextMode()
    javafx.scene.image.Image
    getImage()
    Returns the image of the cell.
    double
    getLeftTextMarginFactor()
    Returns the left margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    double
    getLeftTextPaddingFactor()
    Returns the left padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    double
    getRightTextMarginFactor()
    Returns the right margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    double
    getRightTextPaddingFactor()
    Returns the right padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    String
    getText()
    javafx.scene.paint.Paint
    getTextBackground()
    Returns the background of the text.
    double
    getTextBorderArcFactor()
    Returns the arc of the text border relative to the arc of the cell (as of getTextLayoutMode()).
    javafx.scene.paint.Paint
    getTextBorderColor()
    Returns the color of the text border.
    double
    getTextBorderSizeFactor()
    Returns the size of the text border relative to the size of the cell (as of getTextLayoutMode()).
    javafx.scene.paint.Paint
    getTextColor()
    Returns the color of the text.
    org.refcodes.graphical.LayoutMode
    getTextLayoutMode()
    Returns the LayoutMode for the text metrics.
    double
    getTextSizeFactor()
    Returns the size of the text relative to the size of the cell (as of getTextLayoutMode()).
    double
    getTopTextMarginFactor()
    Returns the top margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    double
    getTopTextPaddingFactor()
    Returns the top padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    org.refcodes.textual.VertAlignTextMode
    getVertAlignTextMode()
    protected void
    redraw()
    Recalculates the metrics of the elements of this node.
    void
    setBottomTextMarginFactor(double aBottomTextMarginFactor)
    Sets the bottom margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    void
    setBottomTextPaddingFactor(double aBottomTextPaddingFactor)
    Sets the bottom padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    void
    setContent(javafx.scene.Node aContent)
    Sets the node of the cell.
    void
    setFontName(String aFontName)
    void
    setHorizAlignTextMode(org.refcodes.textual.HorizAlignTextMode aHorizAlignTextMode)
    void
    setHorizTextMarginFactor(double aTextMarginFactor)
    Sets the horizontal margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    void
    setHorizTextPaddingFactor(double aTextPaddingFactor)
    Sets the horizontal padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    void
    setImage(javafx.scene.image.Image aImage)
    Sets the image of the cell.
    void
    setLeftTextMarginFactor(double aLeftTextMarginFactor)
    Sets the left margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    void
    setLeftTextPaddingFactor(double aLeftTextPaddingFactor)
    Sets the left padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    void
    setRightTextMarginFactor(double aRightTextMarginFactor)
    Sets the right margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    void
    setRightTextPaddingFactor(double aRightTextPaddingFactor)
    Sets the right padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    void
    setText(String aText)
    void
    setTextBackground(javafx.scene.paint.Paint aTextBackground)
    Sets the background of the text.
    void
    setTextBorderArcFactor(double aTextBorderArcFactor)
    Sets the arc of the text border relative to the arc of the cell (as of getTextLayoutMode()).
    void
    setTextBorderColor(javafx.scene.paint.Paint aTextBorderColor)
    Sets the color of the text border.
    void
    setTextBorderSizeFactor(double aTextBorderSizeFactor)
    Sets the size of the text border relative to the size of the cell (as of getTextLayoutMode()).
    void
    setTextColor(javafx.scene.paint.Paint aColor)
    Sets the color of the text.
    void
    setTextLayoutMode(org.refcodes.graphical.LayoutMode aLayoutMode)
    Sets the LayoutMode for the text metrics.
    void
    setTextMarginFactor(double aTextMarginFactor)
    Sets the margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    void
    setTextPaddingFactor(double aTextPaddingFactor)
    Sets the padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    void
    setTextSizeFactor(double aTextSizeFactor)
    Sets the size of the text relative to the size of the cell (as of getTextLayoutMode()).
    void
    setTopTextMarginFactor(double aTopTextMarginFactor)
    Sets the top margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    void
    setTopTextPaddingFactor(double aTopTextPaddingFactor)
    Sets the top padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    void
    setVertAlignTextMode(org.refcodes.textual.VertAlignTextMode aVertAlignTextMode)
    void
    setVertTextMarginFactor(double aTextMarginFactor)
    Sets the vertical margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    void
    setVertTextPaddingFactor(double aTextPaddingFactor)
    Sets the vertical padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    FxLabelDecorator
    withBottomTextMarginFactor(double aTextMarginFactor)
    Sets the bottom margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    FxLabelDecorator
    withBottomTextPaddingFactor(double aTextPaddingFactor)
    Sets the bottom padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    FxLabelDecorator
    withContent(javafx.scene.Node aContent)
    Sets the node of the cell.
    FxLabelDecorator
    withFontName(String aFontName)
    FxLabelDecorator
    withHorizAlignTextMode(org.refcodes.textual.HorizAlignTextMode aHorizAlignTextMode)
    FxLabelDecorator
    withHorizTextMarginFactor(double aTextMarginFactor)
    Sets the horizontal margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    FxLabelDecorator
    withHorizTextPaddingFactor(double aTextPaddingFactor)
    Sets the horizontal padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    FxLabelDecorator
    withImage(javafx.scene.image.Image aImage)
    Sets the image of the cell.
    FxLabelDecorator
    withLeftTextMarginFactor(double aTextMarginFactor)
    Sets the left margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    FxLabelDecorator
    withLeftTextPaddingFactor(double aTextPaddingFactor)
    Sets the left padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    FxLabelDecorator
    withRightTextMarginFactor(double aTextMarginFactor)
    Sets the right margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    FxLabelDecorator
    withRightTextPaddingFactor(double aTextPaddingFactor)
    Sets the right padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    FxLabelDecorator
    withText(String aText)
    FxLabelDecorator
    withTextBackground(javafx.scene.paint.Paint aTextBackground)
    Sets the background of the text.
    FxLabelDecorator
    withTextBorderArcFactor(double aTextBorderArcFactor)
    Sets the arc of the text border relative to the arc of the cell (as of getTextLayoutMode()).
    FxLabelDecorator
    withTextBorderColor(javafx.scene.paint.Paint aTextBorderColor)
    Sets the color of the text border.
    FxLabelDecorator
    withTextBorderSizeFactor(double aTextBorderSizeFactor)
    Sets the size of the text border relative to the size of the cell (as of getTextLayoutMode()).
    FxLabelDecorator
    withTextColor(javafx.scene.paint.Paint aTextColor)
    Sets the color of the text.
    FxLabelDecorator
    withTextLayoutMode(org.refcodes.graphical.LayoutMode aLayoutMode)
    Sets the LayoutMode for the text metrics.
    FxLabelDecorator
    withTextMarginFactor(double aTextMarginFactor)
    Sets the margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    FxLabelDecorator
    withTextPaddingFactor(double aTextPaddingFactor)
    Sets the padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    FxLabelDecorator
    withTextSizeFactor(double aTextSizeFactor)
    Sets the size of the text relative to the size of the cell (as of getTextLayoutMode()).
    FxLabelDecorator
    withTopTextMarginFactor(double aTextMarginFactor)
    Sets the top margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    FxLabelDecorator
    withTopTextPaddingFactor(double aTextPaddingFactor)
    Sets the top padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
    FxLabelDecorator
    withVertAlignTextMode(org.refcodes.textual.VertAlignTextMode aVertAlignTextMode)
    FxLabelDecorator
    withVertTextMarginFactor(double aTextMarginFactor)
    Sets the vertical margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
    FxLabelDecorator
    withVertTextPaddingFactor(double aTextPaddingFactor)
    Sets the vertical padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.

    Methods inherited from class javafx.scene.layout.StackPane

    alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAlignment, getAlignment, getClassCssMetaData, getContentBias, getCssMetaData, getMargin, layoutChildren, requestLayout, setAlignment, setAlignment, setMargin

    Methods inherited from class javafx.scene.layout.Pane

    getChildren

    Methods inherited from class javafx.scene.layout.Region

    backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

    getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestParentLayout, setNeedsLayout, updateBounds

    Methods inherited from class javafx.scene.Node

    accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.refcodes.textual.FontNameAccessor.FontNameProperty

    letFontName

    Methods inherited from interface org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeProperty

    letHorizAlignTextMode

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

    Methods inherited from interface org.refcodes.mixin.TextAccessor.TextProperty

    letText

    Methods inherited from interface org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeProperty

    letVertAlignTextMode

  • Constructor Details

    • FxLabelDecorator

      public FxLabelDecorator(Object aText, String aFontName, double aTextSizeFactor, javafx.scene.image.Image aImage)
      Constructs a FxLabelDecorator with the required minimum attributes.
      Parameters:
      aText - The with which to initialize the cell.
      aFontName - The font name to be used when rendering.
      aTextSizeFactor - The factor to be used relative to the width of the cell.
      aImage - The background image to be used.

    • FxLabelDecorator

      public FxLabelDecorator(String aText, String aFontName, double aTextSizeFactor, javafx.scene.image.Image aImage)
      Constructs a FxLabelDecorator with the required minimum attributes.
      Parameters:
      aText - The with which to initialize the cell.
      aFontName - The font name to be used when rendering.
      aTextSizeFactor - The factor to be used relative to the width of the cell.
      aImage - The background image to be used.

    • FxLabelDecorator

      public FxLabelDecorator(String aText, String aFontName, double aTextSizeFactor, javafx.scene.Node aNode)
      Constructs a FxLabelDecorator with the required minimum attributes.
      Parameters:
      aText - The with which to initialize the cell.
      aFontName - The font name to be used when rendering.
      aTextSizeFactor - The factor to be used relative to the width of the cell.
      aNode - The background image to be used.

  • Method Details

    • getBottomTextMarginFactor

      public double getBottomTextMarginFactor()
      Returns the bottom margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Returns:
      The bottom margin factor relative to the size of the cell of the text from the text box.

    • getBottomTextPaddingFactor

      public double getBottomTextPaddingFactor()
      Returns the bottom padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Returns:
      The bottom padding factor relative to the size of the cell of the text from the text box.

    • getContent

      public javafx.scene.Node getContent()
      Returns the node of the cell.
      Returns:
      The node of the cell.

    • getFontName

      public String getFontName()
      Specified by:
      getFontName in interface org.refcodes.textual.FontNameAccessor

    • getHorizAlignTextMode

      public org.refcodes.textual.HorizAlignTextMode getHorizAlignTextMode()
      Specified by:
      getHorizAlignTextMode in interface org.refcodes.textual.HorizAlignTextModeAccessor

    • getImage

      public javafx.scene.image.Image getImage()
      Returns the image of the cell.
      Returns:
      The image of the cell.

    • getLeftTextMarginFactor

      public double getLeftTextMarginFactor()
      Returns the left margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Returns:
      The left margin factor relative to the size of the cell of the text from the text box.

    • getLeftTextPaddingFactor

      public double getLeftTextPaddingFactor()
      Returns the left padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Returns:
      The left padding factor relative to the size of the cell of the text from the text box.

    • getRightTextMarginFactor

      public double getRightTextMarginFactor()
      Returns the right margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Returns:
      The right margin factor relative to the size of the cell of the text from the text box.

    • getRightTextPaddingFactor

      public double getRightTextPaddingFactor()
      Returns the right padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Returns:
      The right padding factor relative to the size of the cell of the text from the text box.

    • getText

      public String getText()
      Specified by:
      getText in interface org.refcodes.mixin.TextAccessor

    • getTextBackground

      public javafx.scene.paint.Paint getTextBackground()
      Returns the background of the text.
      Returns:
      The background of the text inside the cell.

    • getTextBorderArcFactor

      public double getTextBorderArcFactor()
      Returns the arc of the text border relative to the arc of the cell (as of getTextLayoutMode()). Values form 0 to 1 represents width between 0% and 100%.
      Returns:
      The factor being used relative to the arc of the cell.

    • getTextBorderColor

      public javafx.scene.paint.Paint getTextBorderColor()
      Returns the color of the text border.
      Returns:
      The color of the text border inside the cell.

    • getTextBorderSizeFactor

      public double getTextBorderSizeFactor()
      Returns the size of the text border relative to the size of the cell (as of getTextLayoutMode()). Values form 0 to 1 represents width between 0% and 100%.
      Returns:
      The factor being used relative to the size of the cell.

    • getTextColor

      public javafx.scene.paint.Paint getTextColor()
      Returns the color of the text.
      Returns:
      The color of the text inside the cell.

    • getTextLayoutMode

      public org.refcodes.graphical.LayoutMode getTextLayoutMode()
      Returns the LayoutMode for the text metrics.
      Returns:
      The LayoutMode to be applied to text metrics. settings.

    • getTextSizeFactor

      public double getTextSizeFactor()
      Returns the size of the text relative to the size of the cell (as of getTextLayoutMode()). Values form 0 to 1 represents width between 0% and 100%.
      Returns:
      The factor being used relative to the size of the cell.

    • getTopTextMarginFactor

      public double getTopTextMarginFactor()
      Returns the top margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Returns:
      The top margin factor relative to the size of the cell of the text from the text box.

    • getTopTextPaddingFactor

      public double getTopTextPaddingFactor()
      Returns the top padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Returns:
      The top padding factor relative to the size of the cell of the text from the text box.

    • getVertAlignTextMode

      public org.refcodes.textual.VertAlignTextMode getVertAlignTextMode()
      Specified by:
      getVertAlignTextMode in interface org.refcodes.textual.VertAlignTextModeAccessor

    • setBottomTextMarginFactor

      public void setBottomTextMarginFactor(double aBottomTextMarginFactor)
      Sets the bottom margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aBottomTextMarginFactor - The bottom margin factor of the text from the text box.

    • setBottomTextPaddingFactor

      public void setBottomTextPaddingFactor(double aBottomTextPaddingFactor)
      Sets the bottom padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aBottomTextPaddingFactor - The bottom padding factor of the text from the text box.

    • setContent

      public void setContent(javafx.scene.Node aContent)
      Sets the node of the cell.
      Parameters:
      aContent - The node of the cell.

    • setFontName

      public void setFontName(String aFontName)
      Specified by:
      setFontName in interface org.refcodes.textual.FontNameAccessor.FontNameMutator

    • setHorizAlignTextMode

      public void setHorizAlignTextMode(org.refcodes.textual.HorizAlignTextMode aHorizAlignTextMode)
      Specified by:
      setHorizAlignTextMode in interface org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeMutator

    • setHorizTextMarginFactor

      public void setHorizTextMarginFactor(double aTextMarginFactor)
      Sets the horizontal margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aTextMarginFactor - The horizontal margin factor of the text from the text box.

    • setHorizTextPaddingFactor

      public void setHorizTextPaddingFactor(double aTextPaddingFactor)
      Sets the horizontal padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aTextPaddingFactor - The horizontal padding factor of the text from the text box.

    • setImage

      public void setImage(javafx.scene.image.Image aImage)
      Sets the image of the cell.
      Parameters:
      aImage - The image of the cell.

    • setLeftTextMarginFactor

      public void setLeftTextMarginFactor(double aLeftTextMarginFactor)
      Sets the left margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aLeftTextMarginFactor - The left margin factor of the text from the text box.

    • setLeftTextPaddingFactor

      public void setLeftTextPaddingFactor(double aLeftTextPaddingFactor)
      Sets the left padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aLeftTextPaddingFactor - The left padding factor of the text from the text box.

    • setRightTextMarginFactor

      public void setRightTextMarginFactor(double aRightTextMarginFactor)
      Sets the right margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aRightTextMarginFactor - The right margin factor of the text from the text box.

    • setRightTextPaddingFactor

      public void setRightTextPaddingFactor(double aRightTextPaddingFactor)
      Sets the right padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aRightTextPaddingFactor - The right padding factor of the text from the text box.

    • setText

      public void setText(String aText)
      Specified by:
      setText in interface org.refcodes.mixin.TextAccessor.TextMutator

    • setTextBackground

      public void setTextBackground(javafx.scene.paint.Paint aTextBackground)
      Sets the background of the text.
      Parameters:
      aTextBackground - The background of the text inside the cell.

    • setTextBorderArcFactor

      public void setTextBorderArcFactor(double aTextBorderArcFactor)
      Sets the arc of the text border relative to the arc of the cell (as of getTextLayoutMode()). Values form 0 to 1 represents width between 0% and 100%.
      Parameters:
      aTextBorderArcFactor - The factor to be used relative to the arc of the cell.

    • setTextBorderColor

      public void setTextBorderColor(javafx.scene.paint.Paint aTextBorderColor)
      Sets the color of the text border.
      Parameters:
      aTextBorderColor - The color of the text border inside the cell.

    • setTextBorderSizeFactor

      public void setTextBorderSizeFactor(double aTextBorderSizeFactor)
      Sets the size of the text border relative to the size of the cell (as of getTextLayoutMode()). Values form 0 to 1 represents width between 0% and 100%.
      Parameters:
      aTextBorderSizeFactor - The factor to be used relative to the size of the cell.

    • setTextColor

      public void setTextColor(javafx.scene.paint.Paint aColor)
      Sets the color of the text.
      Parameters:
      aColor - the new text color

    • setTextLayoutMode

      public void setTextLayoutMode(org.refcodes.graphical.LayoutMode aLayoutMode)
      Sets the LayoutMode for the text metrics.
      Parameters:
      aLayoutMode - The LayoutMode to be applied to text metrics. settings.

    • setTextMarginFactor

      public void setTextMarginFactor(double aTextMarginFactor)
      Sets the margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aTextMarginFactor - The margin factor of the text from the text box.

    • setTextPaddingFactor

      public void setTextPaddingFactor(double aTextPaddingFactor)
      Sets the padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aTextPaddingFactor - The padding factor of the text from the text box.

    • setTextSizeFactor

      public void setTextSizeFactor(double aTextSizeFactor)
      Sets the size of the text relative to the size of the cell (as of getTextLayoutMode()). Values form 0 to 1 represents width between 0% and 100%.
      Parameters:
      aTextSizeFactor - The factor to be used relative to the size of the cell.

    • setTopTextMarginFactor

      public void setTopTextMarginFactor(double aTopTextMarginFactor)
      Sets the top margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aTopTextMarginFactor - The top margin factor of the text from the text box.

    • setTopTextPaddingFactor

      public void setTopTextPaddingFactor(double aTopTextPaddingFactor)
      Sets the top padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aTopTextPaddingFactor - The top padding factor of the text from the text box.

    • setVertAlignTextMode

      public void setVertAlignTextMode(org.refcodes.textual.VertAlignTextMode aVertAlignTextMode)
      Specified by:
      setVertAlignTextMode in interface org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeMutator

    • setVertTextMarginFactor

      public void setVertTextMarginFactor(double aTextMarginFactor)
      Sets the vertical margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aTextMarginFactor - The vertical margin factor of the text from the text box.

    • setVertTextPaddingFactor

      public void setVertTextPaddingFactor(double aTextPaddingFactor)
      Sets the vertical padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aTextPaddingFactor - The vertical padding factor of the text from the text box.

    • withBottomTextMarginFactor

      public FxLabelDecorator withBottomTextMarginFactor(double aTextMarginFactor)
      Sets the bottom margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aTextMarginFactor - The bottom margin factor relative to the size of the cell of the text box from the cell
      Returns:
      The builder for applying multiple build operations.

    • withBottomTextPaddingFactor

      public FxLabelDecorator withBottomTextPaddingFactor(double aTextPaddingFactor)
      Sets the bottom padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aTextPaddingFactor - The bottom padding factor relative to the size of the cell of the text from the text box
      Returns:
      The builder for applying multiple build operations.

    • withContent

      public FxLabelDecorator withContent(javafx.scene.Node aContent)
      Sets the node of the cell.
      Parameters:
      aContent - The color to be used.
      Returns:
      The builder for applying multiple build operations.

    • withFontName

      public FxLabelDecorator withFontName(String aFontName)
      Specified by:
      withFontName in interface org.refcodes.textual.FontNameAccessor.FontNameBuilder<FxLabelDecorator>

    • withHorizAlignTextMode

      public FxLabelDecorator withHorizAlignTextMode(org.refcodes.textual.HorizAlignTextMode aHorizAlignTextMode)
      Specified by:
      withHorizAlignTextMode in interface org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<FxLabelDecorator>

    • withHorizTextMarginFactor

      public FxLabelDecorator withHorizTextMarginFactor(double aTextMarginFactor)
      Sets the horizontal margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aTextMarginFactor - The horizontal margin factor relative to the size of the cell of the text box from the cell
      Returns:
      The builder for applying multiple build operations.

    • withHorizTextPaddingFactor

      public FxLabelDecorator withHorizTextPaddingFactor(double aTextPaddingFactor)
      Sets the horizontal padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aTextPaddingFactor - The horizontal padding factor relative to the size of the cell of the text from the text box
      Returns:
      The builder for applying multiple build operations.

    • withImage

      public FxLabelDecorator withImage(javafx.scene.image.Image aImage)
      Sets the image of the cell.
      Parameters:
      aImage - The color to be used.
      Returns:
      The builder for applying multiple build operations.

    • withLeftTextMarginFactor

      public FxLabelDecorator withLeftTextMarginFactor(double aTextMarginFactor)
      Sets the left margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aTextMarginFactor - The left margin factor relative to the size of the cell of the text box from the cell
      Returns:
      The builder for applying multiple build operations.

    • withLeftTextPaddingFactor

      public FxLabelDecorator withLeftTextPaddingFactor(double aTextPaddingFactor)
      Sets the left padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aTextPaddingFactor - The left padding factor relative to the size of the cell of the text from the text box
      Returns:
      The builder for applying multiple build operations.

    • withRightTextMarginFactor

      public FxLabelDecorator withRightTextMarginFactor(double aTextMarginFactor)
      Sets the right margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aTextMarginFactor - The right margin factor relative to the size of the cell of the text box from the cell
      Returns:
      The builder for applying multiple build operations.

    • withRightTextPaddingFactor

      public FxLabelDecorator withRightTextPaddingFactor(double aTextPaddingFactor)
      Sets the right padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aTextPaddingFactor - The right padding factor relative to the size of the cell of the text from the text box
      Returns:
      The builder for applying multiple build operations.

    • withText

      public FxLabelDecorator withText(String aText)
      Specified by:
      withText in interface org.refcodes.mixin.TextAccessor.TextBuilder<FxLabelDecorator>

    • withTextBackground

      public FxLabelDecorator withTextBackground(javafx.scene.paint.Paint aTextBackground)
      Sets the background of the text.
      Parameters:
      aTextBackground - The background to be used.
      Returns:
      The builder for applying multiple build operations.

    • withTextBorderArcFactor

      public FxLabelDecorator withTextBorderArcFactor(double aTextBorderArcFactor)
      Sets the arc of the text border relative to the arc of the cell (as of getTextLayoutMode()). Values form 0 to 1 represents width between 0% and 100%.
      Parameters:
      aTextBorderArcFactor - The factor to be used relative to the arc of the cell.
      Returns:
      The builder for applying multiple build operations.

    • withTextBorderColor

      public FxLabelDecorator withTextBorderColor(javafx.scene.paint.Paint aTextBorderColor)
      Sets the color of the text border.
      Parameters:
      aTextBorderColor - The color to be used.
      Returns:
      The builder for applying multiple build operations.

    • withTextBorderSizeFactor

      public FxLabelDecorator withTextBorderSizeFactor(double aTextBorderSizeFactor)
      Sets the size of the text border relative to the size of the cell (as of getTextLayoutMode()). Values form 0 to 1 represents width between 0% and 100%.
      Parameters:
      aTextBorderSizeFactor - The factor to be used relative to the size of the cell.
      Returns:
      The builder for applying multiple build operations.

    • withTextColor

      public FxLabelDecorator withTextColor(javafx.scene.paint.Paint aTextColor)
      Sets the color of the text.
      Parameters:
      aTextColor - The color to be used.
      Returns:
      The builder for applying multiple build operations.

    • withTextLayoutMode

      public FxLabelDecorator withTextLayoutMode(org.refcodes.graphical.LayoutMode aLayoutMode)
      Sets the LayoutMode for the text metrics.
      Parameters:
      aLayoutMode - The LayoutMode to be applied to text metrics. settings.
      Returns:
      The builder for applying multiple build operations.

    • withTextMarginFactor

      public FxLabelDecorator withTextMarginFactor(double aTextMarginFactor)
      Sets the margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aTextMarginFactor - The margin factor relative to the size of the cell of the text box from the cell
      Returns:
      The builder for applying multiple build operations.

    • withTextPaddingFactor

      public FxLabelDecorator withTextPaddingFactor(double aTextPaddingFactor)
      Sets the padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aTextPaddingFactor - The padding factor relative to the size of the cell of the text from the text box
      Returns:
      The builder for applying multiple build operations.

    • withTextSizeFactor

      public FxLabelDecorator withTextSizeFactor(double aTextSizeFactor)
      Sets the size of the text relative to the size of the cell (as of getTextLayoutMode()). Values form 0 to 1 represents width between 0% and 100%.
      Parameters:
      aTextSizeFactor - The factor to be used relative to the size of the cell.
      Returns:
      The builder for applying multiple build operations.

    • withTopTextMarginFactor

      public FxLabelDecorator withTopTextMarginFactor(double aTextMarginFactor)
      Sets the top margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aTextMarginFactor - The top margin factor relative to the size of the cell of the text box from the cell
      Returns:
      The builder for applying multiple build operations.

    • withTopTextPaddingFactor

      public FxLabelDecorator withTopTextPaddingFactor(double aTextPaddingFactor)
      Sets the top padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aTextPaddingFactor - The top padding factor relative to the size of the cell of the text from the text box
      Returns:
      The builder for applying multiple build operations.

    • withVertAlignTextMode

      public FxLabelDecorator withVertAlignTextMode(org.refcodes.textual.VertAlignTextMode aVertAlignTextMode)
      Specified by:
      withVertAlignTextMode in interface org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeBuilder<FxLabelDecorator>

    • withVertTextMarginFactor

      public FxLabelDecorator withVertTextMarginFactor(double aTextMarginFactor)
      Sets the vertical margin factor relative to the size of the cell (as of getTextLayoutMode()) of the text box from the cell.
      Parameters:
      aTextMarginFactor - The vertical margin factor relative to the size of the cell of the text box from the cell
      Returns:
      The builder for applying multiple build operations.

    • withVertTextPaddingFactor

      public FxLabelDecorator withVertTextPaddingFactor(double aTextPaddingFactor)
      Sets the vertical padding factor relative to the size of the cell (as of getTextLayoutMode()) of the text from the text box.
      Parameters:
      aTextPaddingFactor - The vertical padding factor relative to the size of the cell of the text from the text box
      Returns:
      The builder for applying multiple build operations.

    • redraw

      protected void redraw()
      Recalculates the metrics of the elements of this node.