Package org.eclipse.graphiti.tb

Interface ITextDecorator

  • All Superinterfaces:
    IDecorator, ILocation
    All Known Implementing Classes:
    TextDecorator
    public interface ITextDecorator
extends IDecorator, ILocation
    Text decorators can be used to add a text to the visualization of a shape without modifying the dirty state of the displaying editor, see IDecorator.
    Since:
    0.10

    • Method Detail

      • getText

        java.lang.String getText()
        Returns the text of the decorator.
        Returns:
        A String containing the text

      • setText

        void setText​(java.lang.String text)
        Sets the text or the decorator.
        Parameters:
        text - A String containing the text

      • getFontName

        java.lang.String getFontName()
        Gets the name of the font used in the decorator.
        Returns:
        A String containing the name of the font.

      • setFontName

        void setFontName​(java.lang.String fontName)
        Sets the name of the font used in the decorator.
        Parameters:
        fontName - A String containing the name of the font.

      • getFontSize

        int getFontSize()
        Gets the size of the font used in the decorator.
        Returns:
        An integer defining the size of the font.

      • setFontSize

        void setFontSize​(int fontSize)
        Sets the size of the font used in the decorator.
        Parameters:
        fontSize - An integer defining the size of the font.

      • setBackgroundColor

        void setBackgroundColor​(IColorConstant backgroundColor)
        Sets the color that will be used for painting the background of the text. By default (when returning null) the original background color of the text is kept.

      • getBackgroundColor

        IColorConstant getBackgroundColor()
        Returns the color that will be used for painting the background of the shape to decorate. By default (when returning null) the original background color of the shape is kept.
        Returns:
        a IColorConstant defining the color

      • setForegroundColor

        void setForegroundColor​(IColorConstant foregroundColor)
        Sets the color that will be used for painting the foreground of the text. By default (when returning null) the original foreground color of the text is kept.

      • getForegroundColor

        IColorConstant getForegroundColor()
        Returns the color that will be used for painting the foreground of the shape to decorate. By default (when returning null) the original foreground color of the shape is kept.
        Returns:
        a IColorConstant defining the color