com.atlassian.confluence.tinymceplugin.placeholder
Interface PlaceholderImageFactory

All Known Implementing Classes:

DefaultPlaceholderImageFactory

public interface PlaceholderImageFactory

Generates placeholder images.

Method Summary

BufferedImage	getPlaceholderHeading(List<StyledString> styledStrings, InputStream iconStream, Color backgroundColor) Generate a placeholder image that is suitable for use as a header in a body macro.
BufferedImage	getPlaceholderImage(InputStream iconStream, int sizeInPixels)
BufferedImage	getPlaceholderImage(List<StyledString> styledStrings, InputStream iconStream, Color backgroundColor) Generate placeholder image.
BufferedImage	getPlaceholderImage(List<StyledString> styledStrings, InputStream iconStream, Color backgroundColor, Color borderColor, boolean roundedCorner) Generate placeholder image.
BufferedImage	getPlaceholderImage(StyledString styledString, InputStream iconStream, Color backgroundColor) Generate placeholder image.
BufferedImage	getPlaceholderImage(StyledString styledString, InputStream iconStream, Color backgroundColor, Color borderColor, boolean roundedCorner) Generate placeholder image.

Method Detail

getPlaceholderImage

BufferedImage getPlaceholderImage(StyledString styledString,
                                  InputStream iconStream,
                                  Color backgroundColor)

Generate placeholder image.

Parameters:

styledString - a styled string

iconStream - stream of placeholder icon

backgroundColor - background color

Returns:

a placeholder image

getPlaceholderImage

BufferedImage getPlaceholderImage(StyledString styledString,
                                  InputStream iconStream,
                                  Color backgroundColor,
                                  Color borderColor,
                                  boolean roundedCorner)

Generate placeholder image.

Parameters:

styledString - a styled string

iconStream - stream of placeholder icon

backgroundColor - background color

borderColor - border color

roundedCorner - true if image should have rounded corner

Returns:

a placeholder image

getPlaceholderImage

BufferedImage getPlaceholderImage(List<StyledString> styledStrings,
                                  InputStream iconStream,
                                  Color backgroundColor)

Generate placeholder image.

Parameters:

styledStrings - an ordered list of styled strings

iconStream - stream of placeholder icon

backgroundColor - background color

Returns:

a placeholder image

getPlaceholderImage

BufferedImage getPlaceholderImage(List<StyledString> styledStrings,
                                  InputStream iconStream,
                                  Color backgroundColor,
                                  Color borderColor,
                                  boolean roundedCorner)

Generate placeholder image.

Parameters:

styledStrings - an ordered list of styled strings

iconStream - stream of placeholder icon

backgroundColor - background color

borderColor - border color

roundedCorner - true if image should have rounded corner

Returns:

a placeholder image

getPlaceholderHeading

BufferedImage getPlaceholderHeading(List<StyledString> styledStrings,
                                    InputStream iconStream,
                                    Color backgroundColor)

Generate a placeholder image that is suitable for use as a header in a body macro.

Parameters:

styledStrings - an ordered list of styled strings

iconStream - stream of placeholder icon

backgroundColor - background color

Returns:

a placeholder image

getPlaceholderImage

BufferedImage getPlaceholderImage(InputStream iconStream,
                                  int sizeInPixels)