Package org.pepstock.charba.client.annotation

Class ArrowHeads

  • public final class ArrowHeads
extends Arrow
    Implements a ARROWHEADS to apply on a LINE annotation.
    Author:
    Andrea "Stock" Stocchero

    • Field Detail

      • DEFAULT_DISPLAY

        public static final boolean DEFAULT_DISPLAY
        Default arrow heads display, false.
        See Also:
        Constant Field Values

      • DEFAULT_LENGTH

        public static final int DEFAULT_LENGTH
        Default amount of pixels to define the length of the arrow heads, 12.
        See Also:
        Constant Field Values

      • DEFAULT_WIDTH

        public static final int DEFAULT_WIDTH
        Default amount of pixels to define the width of the arrow heads, 6.
        See Also:
        Constant Field Values

      • DEFAULT_FILL

        public static final boolean DEFAULT_FILL
        Default fill options in order to fill the arrows, false.
        See Also:
        Constant Field Values

    • Method Detail

      • getStart

        public Arrow getStart()
        Returns the arrow head definition at start position.
        Returns:
        the arrow head definition at start position

      • getEnd

        public Arrow getEnd()
        Returns the arrow head definition at end position.
        Returns:
        the arrow head definition at end position

      • isDisplay

        public default boolean isDisplay()
        Returns true whether the arrow heads should be displayed.
        Returns:
        true whether the arrow heads should be displayed

      • isFill

        public default boolean isFill()
        Returns true whether the arrow heads should be filled.
        Returns:
        true whether the arrow heads should be filled

      • getLength

        public default int getLength()
        Returns the length in pixels of the arrow head.
        Returns:
        the length in pixels of the arrow head

      • getWidth

        public default int getWidth()
        Returns the width in pixels of the arrow head.
        Returns:
        the width in pixels of the arrow head

      • getDisplayCallback

        public default SimpleDisplayCallback<AnnotationContext> getDisplayCallback()
        Returns the callback called to set the display options.
        Returns:
        the callback called to set the display options

      • getLengthCallback

        public default LengthCallback getLengthCallback()
        Returns the callback called to set the amount of pixels of the length of the arrow.
        Returns:
        the callback called to set the amount of pixels of the length of the arrow.

      • getWidthCallback

        public default WidthCallback<AnnotationContext> getWidthCallback()
        Returns the callback called to set the amount of pixels of the width of the arrow.
        Returns:
        the callback called to set the amount of pixels of the width of the arrow.

      • getFillCallback

        public default FillCallback getFillCallback()
        Returns the callback called to set true whether the arrow must be closed and filled.
        Returns:
        the callback called to set true whether the arrow must be closed and filled.

      • setBorderColor

        public default void setBorderColor​(IsColor borderColor)
        Sets the color of the border of annotation.
        Parameters:
        borderColor - the color of the border of annotation

      • setBorderColor

        public default void setBorderColor​(String borderColor)
        Sets the color of the border of annotation.
        Parameters:
        borderColor - the color of the border of annotation

      • getBorderColorAsString

        public default String getBorderColorAsString()
        Returns the color of the border of annotation.
        Returns:
        the color of the border of annotation

      • getBorderColor

        public default IsColor getBorderColor()
        Returns the color of the border of annotation.
        Returns:
        the color of the border of annotation

      • setBorderWidth

        public default void setBorderWidth​(int borderWidth)
        Sets the width of the border in pixels.
        Parameters:
        borderWidth - the width of the border in pixels.

      • getBorderWidth

        public default int getBorderWidth()
        Returns the width of the border in pixels.
        Returns:
        the width of the border in pixels.

      • setBorderDash

        public default void setBorderDash​(int... borderDash)
        Sets the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
        Parameters:
        borderDash - the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.

      • getBorderDash

        public default List<Integer> getBorderDash()
        Returns the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
        Returns:
        the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.

      • setBorderDashOffset

        public default void setBorderDashOffset​(double borderDashOffset)
        Sets the line dash pattern offset.
        Parameters:
        borderDashOffset - the line dash pattern offset.

      • getBorderDashOffset

        public default double getBorderDashOffset()
        Returns the line dash pattern offset.
        Returns:
        the line dash pattern offset.

      • getBorderColorCallback

        public default ColorCallback<AnnotationContext> getBorderColorCallback()
        Returns the callback called to set the color of the border of annotation.
        Returns:
        the callback called to set the color of the border of annotation

      • setBorderColor

        public default void setBorderColor​(ColorCallback<AnnotationContext> borderColorCallback)
        Sets the callback to set the color of the border of annotation.
        Parameters:
        borderColorCallback - to set the color of the border of annotation

      • setBorderColor

        public default void setBorderColor​(NativeCallback borderColorCallback)
        Sets the callback to set the color of the border of annotation.
        Parameters:
        borderColorCallback - to set the color of the border of annotation

      • getBorderWidthCallback

        public default WidthCallback<AnnotationContext> getBorderWidthCallback()
        Returns the callback called to set the width of the border in pixels.
        Returns:
        the callback called to set the width of the border in pixels

      • setBorderWidth

        public default void setBorderWidth​(WidthCallback<AnnotationContext> borderWidthCallback)
        Sets the callback to set the color of the width of the border in pixels.
        Parameters:
        borderWidthCallback - to set the width of the border in pixels

      • setBorderWidth

        public default void setBorderWidth​(NativeCallback borderWidthCallback)
        Sets the callback to set the color of the width of the border in pixels.
        Parameters:
        borderWidthCallback - to set the width of the border in pixels

      • getBorderDashCallback

        public default BorderDashCallback<AnnotationContext> getBorderDashCallback()
        Returns the callback called to set the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
        Returns:
        the callback called to set the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern

      • setBorderDash

        public default void setBorderDash​(BorderDashCallback<AnnotationContext> borderDashCallback)
        Sets the callback to set the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
        Parameters:
        borderDashCallback - to set the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern

      • setBorderDash

        public default void setBorderDash​(NativeCallback borderDashCallback)
        Sets the callback to set the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
        Parameters:
        borderDashCallback - to set the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern

      • getBorderDashOffsetCallback

        public default BorderDashOffsetCallback<AnnotationContext> getBorderDashOffsetCallback()
        Returns the callback called to set the line dash pattern offset.
        Returns:
        the callback called to set the line dash pattern offset

      • setBorderDashOffset

        public default void setBorderDashOffset​(BorderDashOffsetCallback<AnnotationContext> borderDashOffsetCallback)
        Sets the callback to set the line dash pattern offset.
        Parameters:
        borderDashOffsetCallback - to set the line dash pattern offset

      • setBorderDashOffset

        public default void setBorderDashOffset​(NativeCallback borderDashOffsetCallback)
        Sets the callback to set the line dash pattern offset.
        Parameters:
        borderDashOffsetCallback - to set the line dash pattern offset

      • setBorderShadowColor

        public default void setBorderShadowColor​(IsColor borderColor)
        Sets the color of the border shadow of annotation.
        Parameters:
        borderColor - the color of the border shadow of annotation

      • setBorderShadowColor

        public default void setBorderShadowColor​(String borderColor)
        Sets the color of the border shadow of annotation.
        Parameters:
        borderColor - the color of the border shadow of annotation

      • getBorderShadowColorAsString

        public default String getBorderShadowColorAsString()
        Returns the color of the border shadow of annotation.
        Returns:
        the color of the border shadow of annotation

      • getBorderShadowColor

        public default IsColor getBorderShadowColor()
        Returns the color of the border shadow of annotation.
        Returns:
        the color of the border shadow of annotation

      • setShadowBlur

        public default void setShadowBlur​(double shadowBlur)
        Sets the amount of blur applied to shadows.
        Parameters:
        shadowBlur - the amount of blur applied to shadows

      • getShadowBlur

        public default double getShadowBlur()
        Returns the amount of blur applied to shadows.
        Returns:
        the amount of blur applied to shadows

      • setShadowOffsetX

        public default void setShadowOffsetX​(int shadowOffset)
        Sets the distance that shadows will be offset horizontally.
        Parameters:
        shadowOffset - the distance that shadows will be offset horizontally.

      • getShadowOffsetX

        public default int getShadowOffsetX()
        Returns the distance that shadows will be offset horizontally.
        Returns:
        the distance that shadows will be offset horizontally.

      • setShadowOffsetY

        public default void setShadowOffsetY​(int shadowOffset)
        Sets the distance that shadows will be offset vertically.
        Parameters:
        shadowOffset - the distance that shadows will be offset vertically.

      • getShadowOffsetY

        public default int getShadowOffsetY()
        Returns the distance that shadows will be offset vertically.
        Returns:
        the distance that shadows will be offset vertically.

      • getBorderShadowColorCallback

        public default ColorCallback<AnnotationContext> getBorderShadowColorCallback()
        Returns the callback called to set the color of the border shadow of annotation.
        Returns:
        the callback called to set the color of the border shadow of annotation

      • setBorderShadowColor

        public default void setBorderShadowColor​(ColorCallback<AnnotationContext> borderShadowColorCallback)
        Sets the callback to set the color of the border shadow of annotation.
        Parameters:
        borderShadowColorCallback - to set the color of the border shadow of annotation

      • setBorderShadowColor

        public default void setBorderShadowColor​(NativeCallback borderShadowColorCallback)
        Sets the callback to set the color of the border shadow of annotation.
        Parameters:
        borderShadowColorCallback - to set the color of the border shadow of annotation

      • getShadowBlurCallback

        public default ShadowBlurCallback getShadowBlurCallback()
        Returns the callback called to set the amount of blur applied to shadows.
        Returns:
        the callback called to set the amount of blur applied to shadows.

      • setShadowBlur

        public default void setShadowBlur​(ShadowBlurCallback shadowBlurCallback)
        Sets the callback to set the amount of blur applied to shadows.
        Parameters:
        shadowBlurCallback - to set the amount of blur applied to shadows.

      • setShadowBlur

        public default void setShadowBlur​(NativeCallback shadowBlurCallback)
        Sets the callback to set the amount of blur applied to shadows.
        Parameters:
        shadowBlurCallback - to set the amount of blur applied to shadows.

      • getShadowOffsetXCallback

        public default ShadowOffsetCallback getShadowOffsetXCallback()
        Returns the callback called to set the distance that shadows will be offset horizontally.
        Returns:
        the callback called to set the distance that shadows will be offset horizontally.

      • setShadowOffsetX

        public default void setShadowOffsetX​(ShadowOffsetCallback shadowOffsetCallback)
        Sets the callback to set the distance that shadows will be offset horizontally.
        Parameters:
        shadowOffsetCallback - to set the distance that shadows will be offset horizontally.

      • setShadowOffsetX

        public default void setShadowOffsetX​(NativeCallback shadowOffsetCallback)
        Sets the callback to set the distance that shadows will be offset horizontally.
        Parameters:
        shadowOffsetCallback - to set the distance that shadows will be offset horizontally.

      • getShadowOffsetYCallback

        public default ShadowOffsetCallback getShadowOffsetYCallback()
        Returns the callback called to set the distance that shadows will be offset vertically.
        Returns:
        the callback called to set the distance that shadows will be offset vertically.

      • setShadowOffsetY

        public default void setShadowOffsetY​(ShadowOffsetCallback shadowOffsetCallback)
        Sets the callback to set the distance that shadows will be offset vertically.
        Parameters:
        shadowOffsetCallback - to set the distance that shadows will be offset vertically.

      • setShadowOffsetY

        public default void setShadowOffsetY​(NativeCallback shadowOffsetCallback)
        Sets the callback to set the distance that shadows will be offset vertically.
        Parameters:
        shadowOffsetCallback - to set the distance that shadows will be offset vertically.

      • setBackgroundShadowColor

        public default void setBackgroundShadowColor​(IsColor backgroundColor)
        Sets the color of the shadow of annotation.
        Parameters:
        backgroundColor - the color of the shadow of annotation

      • setBackgroundShadowColor

        public default void setBackgroundShadowColor​(String backgroundColor)
        Sets the color of the shadow of annotation.
        Parameters:
        backgroundColor - the color of the shadow of annotation

      • getBackgroundShadowColorAsString

        public default String getBackgroundShadowColorAsString()
        Returns the color of the shadow of annotation.
        Returns:
        the color of the shadow of annotation

      • getBackgroundShadowColor

        public default IsColor getBackgroundShadowColor()
        Returns the color of the shadow of annotation.
        Returns:
        the color of the shadow of annotation

      • getBackgroundShadowColorCallback

        public default ColorCallback<AnnotationContext> getBackgroundShadowColorCallback()
        Returns the callback called to set the color of the shadow of annotation.
        Returns:
        the callback called to set the color of the shadow of annotation

      • setBackgroundShadowColor

        public default void setBackgroundShadowColor​(ColorCallback<AnnotationContext> borderShadowColorCallback)
        Sets the callback to set the color of the shadow of annotation.
        Parameters:
        borderShadowColorCallback - to set the color of the shadow of annotation

      • setBackgroundShadowColor

        public default void setBackgroundShadowColor​(NativeCallback borderShadowColorCallback)
        Sets the callback to set the color of the shadow of annotation.
        Parameters:
        borderShadowColorCallback - to set the color of the shadow of annotation

      • setBackgroundColor

        public default void setBackgroundColor​(IsColor backgroundColor)
        Sets the color of the background of annotation.
        Parameters:
        backgroundColor - the color of the background of annotation

      • setBackgroundColor

        public default void setBackgroundColor​(String backgroundColor)
        Sets the color of the background of annotation.
        Parameters:
        backgroundColor - the color of the background of annotation

      • getBackgroundColorAsString

        public default String getBackgroundColorAsString()
        Returns the color of the background of annotation.
        Returns:
        the color of the background of annotation

      • getBackgroundColor

        public default IsColor getBackgroundColor()
        Returns the color of the background of annotation.
        Returns:
        the color of the background of annotation

      • getBackgroundColorCallback

        public default ColorCallback<AnnotationContext> getBackgroundColorCallback()
        Returns the callback called to set the color of the background of annotation.
        Returns:
        the callback called to set the color of the background of annotation

      • setBackgroundColor

        public default void setBackgroundColor​(ColorCallback<AnnotationContext> backgroundColorCallback)
        Sets the callback to set the color of the background of annotation.
        Parameters:
        backgroundColorCallback - to set the color of the background of annotation

      • setBackgroundColor

        public default void setBackgroundColor​(NativeCallback backgroundColorCallback)
        Sets the callback to set the color of the background of annotation.
        Parameters:
        backgroundColorCallback - to set the color of the background of annotation