Package sh.stein.carbon

Class ImageOptions.ImageOptionsBuilder

  • Enclosing class:
    ImageOptions
    public static class ImageOptions.ImageOptionsBuilder
extends java.lang.Object
    Used to build an instance of ImageOptions fluently.

    • Constructor Detail

      • ImageOptionsBuilder

        public ImageOptionsBuilder()

    • Method Detail

      • backgroundColor

        public ImageOptions.ImageOptionsBuilder backgroundColor​(java.lang.String backgroundColor)
        Sets the background color.
        Parameters:
        backgroundColor - an RGBA or hex color
        Returns:
        the ImageOptionsBuilder instance

      • dropShadow

        public ImageOptions.ImageOptionsBuilder dropShadow​(boolean dropShadow)
        Sets drop shadow.
        Parameters:
        dropShadow - whether drop shadow is enabled
        Returns:
        the ImageOptionsBuilder instance

      • dropShadowBlurRadius

        public ImageOptions.ImageOptionsBuilder dropShadowBlurRadius​(java.lang.String dropShadowBlurRadius)
        Sets the drop shadow blur radius.
        Parameters:
        dropShadowBlurRadius - a px value, e.g. 20px
        Returns:
        the ImageOptionsBuilder instance

      • dropShadowOffsetY

        public ImageOptions.ImageOptionsBuilder dropShadowOffsetY​(java.lang.String dropShadowOffsetY)
        Sets the drop shadow Y offset.
        Parameters:
        dropShadowOffsetY - a px value, e.g. 20px
        Returns:
        the ImageOptionsBuilder instance

      • firstLineNumber

        public ImageOptions.ImageOptionsBuilder firstLineNumber​(int firstLineNumber)
        Sets the first line number. Line numbers must be enabled.
        Parameters:
        firstLineNumber - an integer, e.g. 19
        Returns:
        the ImageOptionsBuilder instance

      • fontFamily

        public ImageOptions.ImageOptionsBuilder fontFamily​(java.lang.String fontFamily)
        Sets the font family.
        Parameters:
        fontFamily - a font family, found by exporting a Carbon config
        Returns:
        the ImageOptionsBuilder instance

      • fontSize

        public ImageOptions.ImageOptionsBuilder fontSize​(java.lang.String fontSize)
        Sets the font size.
        Parameters:
        fontSize - a px value, e.g. 20px
        Returns:
        the ImageOptionsBuilder instance

      • lineHeight

        public ImageOptions.ImageOptionsBuilder lineHeight​(java.lang.String lineHeight)
        Sets the line height.
        Parameters:
        lineHeight - a percentage, e.g. 200%
        Returns:
        the ImageOptionsBuilder instance

      • lineNumbers

        public ImageOptions.ImageOptionsBuilder lineNumbers​(boolean lineNumbers)
        Sets line numbers.
        Parameters:
        lineNumbers - whether line numbers are enabled
        Returns:
        the ImageOptionsBuilder instance

      • paddingHorizontal

        public ImageOptions.ImageOptionsBuilder paddingHorizontal​(java.lang.String paddingHorizontal)
        Sets the horizontal padding.
        Parameters:
        paddingHorizontal - a px value, e.g. 20px
        Returns:
        the ImageOptionsBuilder instance

      • paddingVertical

        public ImageOptions.ImageOptionsBuilder paddingVertical​(java.lang.String paddingVertical)
        Sets the vertical padding.
        Parameters:
        paddingVertical - a px value, e.g. 20px
        Returns:
        the ImageOptionsBuilder instance

      • scaleFactor

        public ImageOptions.ImageOptionsBuilder scaleFactor​(int scaleFactor)
        Sets the scale factor.
        Parameters:
        scaleFactor - an integer, e.g. 3
        Returns:
        the ImageOptionsBuilder instance

      • theme

        public ImageOptions.ImageOptionsBuilder theme​(java.lang.String theme)
        Sets the theme.
        Parameters:
        theme - a theme, valid themes can be found by exporting a Carbon config
        Returns:
        the ImageOptionsBuilder instance

      • watermark

        public ImageOptions.ImageOptionsBuilder watermark​(boolean watermark)
        Sets watermark.
        Parameters:
        watermark - whether watermark is enabled
        Returns:
        the ImageOptionsBuilder instance

      • widthAdjustment

        public ImageOptions.ImageOptionsBuilder widthAdjustment​(boolean widthAdjustment)
        Sets width adjustment.
        Parameters:
        widthAdjustment - whether width adjustment is enabled.
        Returns:
        the ImageOptionsBuilder instance

      • windowControls

        public ImageOptions.ImageOptionsBuilder windowControls​(boolean windowControls)
        Sets window controls.
        Parameters:
        windowControls - whether window controls are enabled
        Returns:
        the ImageOptionsBuilder instance

      • build

        public ImageOptions build()
        Gets the created options.
        Returns:
        the ImageOptions instance