IconImage

Inheritance: java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase

public final class IconImage extends RasterImageResourceBase

Represents one image in ICON format with its metadata and additional methods

Constructors

Constructor Description
IconImage(String name, String contentInBase64) Creates new IconImage instance from content, represented as base64-encoded string, and with specified name
IconImage(String name, InputStream binaryContent) Creates new IconImage instance from content, represented as byte stream, and with specified name

Methods

Method Description
isValid(InputStream binaryContent) Checks whether specified stream is a valid ICON image
isValid(String contentInBase64) Checks whether specified base64-encoded string is a valid ICON image
getType() Returns ImageType.Icon
reduceToNewHeight_IconImage_New(int targetHeightInPixels) Creates and returns a new reduced Icon image, but with specified new reduced height and proportionally reduced width.
getNumberOfImages() Returns number of images, which are present in this ICON file

IconImage(String name, String contentInBase64)

public IconImage(String name, String contentInBase64)

Creates new IconImage instance from content, represented as base64-encoded string, and with specified name

Parameters:

Parameter Type Description
name java.lang.String Name of the ICON image. Cannot be null, empty or whitespaces.
contentInBase64 java.lang.String Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a ICON content, exception will be thrown.

IconImage(String name, InputStream binaryContent)

public IconImage(String name, InputStream binaryContent)

Creates new IconImage instance from content, represented as byte stream, and with specified name

Parameters:

Parameter Type Description
name java.lang.String Name of the ICON image. Cannot be null, empty or whitespaces.
binaryContent java.io.InputStream Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too.

isValid(InputStream binaryContent)

public static boolean isValid(InputStream binaryContent)

Checks whether specified stream is a valid ICON image

Parameters:

Parameter Type Description
binaryContent java.io.InputStream Byte stream, that presumably contains a ICON image

Returns: boolean - True if specified stream contains valid ICON image, false otherwise

isValid(String contentInBase64)

public static boolean isValid(String contentInBase64)

Checks whether specified base64-encoded string is a valid ICON image

Parameters:

Parameter Type Description
contentInBase64 java.lang.String Content of the presumably ICON image in a form of base64-encoded string

Returns: boolean - True if specified string contains valid ICON image, false otherwise

getType()

public ImageType getType()

Returns ImageType.Icon

Returns: ImageType

reduceToNewHeight_IconImage_New(int targetHeightInPixels)

public final IconImage reduceToNewHeight_IconImage_New(int targetHeightInPixels)

Creates and returns a new reduced Icon image, but with specified new reduced height and proportionally reduced width.

Parameters:

Parameter Type Description
targetHeightInPixels int Height of the desired Icon image in pixels. Should be strictly lesser than original height.

Returns: IconImage - New IconImage instance with specified height

getNumberOfImages()

public final int getNumberOfImages()

Returns number of images, which are present in this ICON file

Returns: int