Interface IDecoration


  • public interface IDecoration
    Defines the result of decorating an element. This interface is not meant to be implemented and will be provided to instances of ILightweightLabelDecorator.
    Restriction:
    This interface is not intended to be implemented by clients.
    • Method Detail

      • addPrefix

        void addPrefix​(String prefix)
        Adds a prefix to the element's label.
        Parameters:
        prefix - the prefix
      • addSuffix

        void addSuffix​(String suffix)
        Adds a suffix to the element's label.
        Parameters:
        suffix - the suffix
      • addOverlay

        void addOverlay​(ImageDescriptor overlay)
        Adds an overlay to the element's image.
        Parameters:
        overlay - the overlay image descriptor
      • addOverlay

        void addOverlay​(ImageDescriptor overlay,
                        int quadrant)
        Adds an overlay to the element's image.
        Parameters:
        overlay - the overlay image descriptor
        quadrant - The constant for the quadrant to draw the image on.
      • setForegroundColor

        void setForegroundColor​(Color color)
        Set the foreground color for this decoration.
        Parameters:
        color - the color to be set for the foreground
        Since:
        3.1
      • setBackgroundColor

        void setBackgroundColor​(Color color)
        Set the background color for this decoration.
        Parameters:
        color - the color to be set for the background
        Since:
        3.1
      • setFont

        void setFont​(Font font)
        Set the font for this decoration.
        Parameters:
        font - the font to use in this decoration
        Since:
        3.1
      • getDecorationContext

        IDecorationContext getDecorationContext()
        Return the decoration context in which this decoration will be applied.
        Returns:
        the decoration context
        Since:
        3.2