Package org.refcodes.graphical.ext.javafx

Interface FxLabelDecorator

  • All Superinterfaces:
    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.mixin.TextAccessor, org.refcodes.mixin.TextAccessor.TextBuilder<FxLabelDecorator>, org.refcodes.mixin.TextAccessor.TextMutator, org.refcodes.mixin.TextAccessor.TextProperty, org.refcodes.textual.VertAlignTextModeAccessor, org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeBuilder<FxLabelDecorator>, org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeMutator, org.refcodes.textual.VertAlignTextModeAccessor.VertAlignTextModeProperty
    All Known Implementing Classes:
    FxLabelDecoratorImpl

    public interface FxLabelDecorator
extends 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>
    The interface FxLabelDecorator defines functionality for "cells" being constructed of an image and a "label" text.

    • Method Detail

      • withFontName

        default FxLabelDecorator withFontName​(java.lang.String aFontName)
        Specified by:
        withFontName in interface org.refcodes.textual.FontNameAccessor.FontNameBuilder<FxLabelDecorator>

      • withText

        default FxLabelDecorator withText​(java.lang.String aText)
        Specified by:
        withText in interface org.refcodes.mixin.TextAccessor.TextBuilder<FxLabelDecorator>

      • withHorizAlignTextMode

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

      • withVertAlignTextMode

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

      • setTextBackground

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

      • getTextBackground

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

      • withTextBackground

        default 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.

      • setTextColor

        void setTextColor​(javafx.scene.paint.Paint aTextColor)
        Sets the color of the text.
        Parameters:
        aTextColor - The color of the text inside the cell.

      • getTextColor

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

      • withTextColor

        default 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.

      • setTextLayoutMode

        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.

      • getTextLayoutMode

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

      • withTextLayoutMode

        default 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.

      • setTextSizeFactor

        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.

      • getTextSizeFactor

        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.

      • withTextSizeFactor

        default 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.

      • setTextMarginFactor

        default 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.

      • withTextMarginFactor

        default 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.

      • withHorizTextMarginFactor

        default 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.

      • setHorizTextMarginFactor

        default 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.

      • withVertTextMarginFactor

        default 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.

      • setVertTextMarginFactor

        default 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.

      • setTopTextMarginFactor

        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.

      • getTopTextMarginFactor

        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.

      • withTopTextMarginFactor

        default 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.

      • setBottomTextMarginFactor

        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.

      • getBottomTextMarginFactor

        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.

      • withBottomTextMarginFactor

        default 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.

      • setLeftTextMarginFactor

        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.

      • getLeftTextMarginFactor

        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.

      • withLeftTextMarginFactor

        default 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.

      • setRightTextMarginFactor

        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.

      • getRightTextMarginFactor

        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.

      • withRightTextMarginFactor

        default 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.

      • setTextPaddingFactor

        default 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.

      • withTextPaddingFactor

        default 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.

      • withHorizTextPaddingFactor

        default 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.

      • setHorizTextPaddingFactor

        default 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.

      • withVertTextPaddingFactor

        default 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.

      • setVertTextPaddingFactor

        default 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.

      • setTopTextPaddingFactor

        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.

      • getTopTextPaddingFactor

        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.

      • withTopTextPaddingFactor

        default 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.

      • setBottomTextPaddingFactor

        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.

      • getBottomTextPaddingFactor

        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.

      • withBottomTextPaddingFactor

        default 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.

      • setLeftTextPaddingFactor

        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.

      • getLeftTextPaddingFactor

        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.

      • withLeftTextPaddingFactor

        default 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.

      • setRightTextPaddingFactor

        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.

      • getRightTextPaddingFactor

        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.

      • withRightTextPaddingFactor

        default 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.

      • setTextBorderSizeFactor

        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.

      • getTextBorderSizeFactor

        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.

      • withTextBorderSizeFactor

        default 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.

      • setTextBorderArcFactor

        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.

      • getTextBorderArcFactor

        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.

      • withTextBorderArcFactor

        default 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.

      • setTextBorderColor

        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.

      • getTextBorderColor

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

      • withTextBorderColor

        default 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.

      • setImage

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

      • getImage

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

      • withImage

        default 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.

      • setContent

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

      • getContent

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

      • withContent

        default 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.