Class BorderDecorator

    • Constructor Summary

      Constructors 
      Constructor Description
      BorderDecorator()
      Creates a new border decorator that decorates a shape with a border.
      BorderDecorator​(IColorConstant borderColor, java.lang.Integer lineWidth, java.lang.Integer lineStyle)
      Creates a new border decorator that decorates a shape with a border with the given settings.
    • Constructor Detail

      • BorderDecorator

        public BorderDecorator()
        Creates a new border decorator that decorates a shape with a border.
      • BorderDecorator

        public BorderDecorator​(IColorConstant borderColor,
                               java.lang.Integer lineWidth,
                               java.lang.Integer lineStyle)
        Creates a new border decorator that decorates a shape with a border with the given settings. See the setter methods for details on these values.
        Parameters:
        borderColor - an IColorConstant defining the color for the border line
        lineWidth - an Integer defining the width of the border line
        lineStyle - an Integer defining the style of the border line
    • Method Detail

      • setBorderColor

        public void setBorderColor​(IColorConstant borderColor)
        Sets the color to be used for the border line. By default (when null is set) IColorConstant.BLACK is used.
        Parameters:
        borderColor -
      • getBorderWidth

        public java.lang.Integer getBorderWidth()
        Description copied from interface: IBorderDecorator
        Returns the width that will be used for the border line. By default (when returning null or a value smaller than 1) 1 is used.
        Specified by:
        getBorderWidth in interface IBorderDecorator
        Returns:
        an Integer defining the width of the border line
      • setBorderWidth

        public void setBorderWidth​(java.lang.Integer lineWidth)
        Sets the width that will be used for the border line. By default (when null or a value smaller than 1 is set) 1 is used.
        Parameters:
        lineWidth - an Integer defining the width of the border line
      • getBorderStyle

        public java.lang.Integer getBorderStyle()
        Description copied from interface: IBorderDecorator
        Returns the style that will be used for the border line. Possible values are:

        • Graphics.LINE_SOLID
        • Graphics.LINE_DASH
        • Graphics.LINE_DASHDOT
        • Graphics.LINE_DASHDOTDOT
        • Graphics.LINE_DOT
        By default (when returning null or an invalid value) Graphics.LINE_SOLID is used.
        Specified by:
        getBorderStyle in interface IBorderDecorator
        Returns:
        an Integer defining the width of the border style
      • setBorderStyle

        public void setBorderStyle​(java.lang.Integer lineStyle)
        Sets the style that will be used for the border line. Possible values are:

        • Graphics.LINE_SOLID
        • Graphics.LINE_DASH
        • Graphics.LINE_DASHDOT
        • Graphics.LINE_DASHDOTDOT
        • Graphics.LINE_DOT
        By default (when null or an invalid value is set) Graphics.LINE_SOLID is used.
        Parameters:
        lineStyle - an Integer defining the style of the border line