Package org.pepstock.charba.client.annotation

Class Arrow

  • Direct Known Subclasses:
    ArrowHeads
    public class Arrow
extends AbstractNode
    Implements a ARROWHEADS, and its start and end nodes, to apply on a LINE annotation.
    Author:
    Andrea "Stock" Stocchero

    • Method Detail

      • getBackgroundColorHandler

        public final org.pepstock.charba.client.annotation.BackgroundColorHandler getBackgroundColorHandler()

      • getBorderOptionsHandler

        public final org.pepstock.charba.client.annotation.BorderOptionsHandler getBorderOptionsHandler()

      • getShadowOptionsHandler

        public final org.pepstock.charba.client.annotation.ShadowOptionsHandler getShadowOptionsHandler()

      • getExtendedShadowOptionsHandler

        public final org.pepstock.charba.client.annotation.ExtendedShadowOptionsHandler getExtendedShadowOptionsHandler()

      • setDisplay

        public final void setDisplay​(boolean display)
        Sets true whether the arrow head should be displayed.
        Parameters:
        display - true whether the arrow head should be displayed

      • isDisplay

        public final boolean isDisplay()
        Returns true whether the arrow head should be displayed.
        Returns:
        true whether the arrow head should be displayed

      • setFill

        public final void setFill​(boolean fill)
        Sets true whether the arrow head must be closed and filled.
        Parameters:
        fill - true whether the arrow head must be closed and filled.

      • isFill

        public final boolean isFill()
        Returns true whether the arrow head must be closed and filled.
        Returns:
        true whether the arrow head must be closed and filled.

      • setLength

        public final void setLength​(int length)
        Sets the amount of pixels of the length of the arrow head.
        Parameters:
        length - the amount of pixels of the length of the arrow head.

      • getLength

        public final int getLength()
        Returns the amount of pixels of the length of the arrow head.
        Returns:
        the amount of pixels of the length of the arrow head.

      • setWidth

        public final void setWidth​(int width)
        Sets the amount of pixels of the width of the arrow head.
        Parameters:
        width - the amount of pixels of the width of the arrow head

      • getWidth

        public final int getWidth()
        Returns the width of the arrow head.
        Returns:
        the width of the arrow head

      • getDisplayCallback

        public final SimpleDisplayCallback<AnnotationContext> getDisplayCallback()
        Returns the callback called to set whether the arrow head should be displayed.
        Returns:
        the callback called to set whether the arrow head should be displayed

      • setDisplay

        public final void setDisplay​(SimpleDisplayCallback<AnnotationContext> displayCallback)
        Sets the callback to set whether the arrow head should be displayed.
        Parameters:
        displayCallback - to set whether the arrow head should be displayed

      • setDisplay

        public final void setDisplay​(NativeCallback displayCallback)
        Sets the callback to set whether the arrow head should be displayed.
        Parameters:
        displayCallback - to set whether the arrow head should be displayed

      • getLengthCallback

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

      • setLength

        public final void setLength​(LengthCallback lengthCallback)
        Sets the callback to set the amount of pixels of the length of the arrow head.
        Parameters:
        lengthCallback - to set the amount of pixels of the length of the arrow head.

      • setLength

        public final void setLength​(NativeCallback lengthCallback)
        Sets the callback to set the amount of pixels of the length of the arrow head.
        Parameters:
        lengthCallback - to set the amount of pixels of the length of the arrow head.

      • getWidthCallback

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

      • setWidth

        public final void setWidth​(WidthCallback<AnnotationContext> widthCallback)
        Sets the callback to set the amount of pixels of the width of the arrow head.
        Parameters:
        widthCallback - to set the amount of pixels of the width of the arrow head.

      • setWidth

        public final void setWidth​(NativeCallback widthCallback)
        Sets the callback to set the amount of pixels of the width of the arrow head.
        Parameters:
        widthCallback - to set the amount of pixels of the width of the arrow head.

      • getFillCallback

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

      • setFill

        public final void setFill​(FillCallback fillCallback)
        Sets the callback to set whether true whether the arrow head must be closed and filled.
        Parameters:
        fillCallback - to set whether true whether the arrow head must be closed and filled.

      • setFill

        public final void setFill​(NativeCallback fillCallback)
        Sets the callback to set whether true whether the arrow head must be closed and filled.
        Parameters:
        fillCallback - to set whether true whether the arrow head 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