GifImage
Inheritance: java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase
public final class GifImage extends RasterImageResourceBase
Represents one image in GIF (Graphics Interchange Format) format with its metadata and additional methods
Constructors
| Constructor | Description |
|---|---|
| GifImage(String name, String contentInBase64) | Creates new GifImage instance from content, represented as base64-encoded string, and with specified name |
| GifImage(String name, InputStream binaryContent) | Creates new GifImage instance from content, represented as byte stream, and with specified name |
Methods
| Method | Description |
|---|---|
| isValid(InputStream binaryContent) | Checks whether specified stream is a valid GIF image |
| isValid(String contentInBase64) | Checks whether specified base64-encoded string is a valid GIF image |
| getType() | Returns ImageType.Gif |
| reduceToNewHeight(int targetHeightInPixels) | Creates and returns a new reduced GIF image, but with specified new reduced height and proportionally reduced width. |
| getVersion() | Returns internal version of this GIF image (version is extracted from header) |
GifImage(String name, String contentInBase64)
public GifImage(String name, String contentInBase64)
Creates new GifImage instance from content, represented as base64-encoded string, and with specified name
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | java.lang.String | Name of the GIF 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 GIF content, exception will be thrown. |
GifImage(String name, InputStream binaryContent)
public GifImage(String name, InputStream binaryContent)
Creates new GifImage instance from content, represented as byte stream, and with specified name
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | java.lang.String | Name of the GIF 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 GIF image
Parameters:
| Parameter | Type | Description |
|---|---|---|
| binaryContent | java.io.InputStream | Byte stream, that presumably contains a GIF image |
Returns: boolean - True if specified stream contains valid GIF image, false otherwise
isValid(String contentInBase64)
public static boolean isValid(String contentInBase64)
Checks whether specified base64-encoded string is a valid GIF image
Parameters:
| Parameter | Type | Description |
|---|---|---|
| contentInBase64 | java.lang.String | Content of the presumably GIF image in a form of base64-encoded string |
Returns: boolean - True if specified string contains valid GIF image, false otherwise
getType()
public ImageType getType()
Returns ImageType.Gif
Returns: ImageType
reduceToNewHeight(int targetHeightInPixels)
public final GifImage reduceToNewHeight(int targetHeightInPixels)
Creates and returns a new reduced GIF image, but with specified new reduced height and proportionally reduced width.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| targetHeightInPixels | int | Height of the desired GIF image in pixels. Should be strictly lesser than original height. |
Returns: GifImage - New GifImage instance with specified height
getVersion()
public final String getVersion()
Returns internal version of this GIF image (version is extracted from header)
Returns: java.lang.String