Groupdocs API References – com.groupdocs.editor.htmlcss.resources.images.raster

Nodejs-Java: BmpImage

Mon, 01 Jan 0001 00:00:00 +0000

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

public final class BmpImage extends RasterImageResourceBase

Represents one image in BMP (BitMap Picture) format with its metadata and additional methods

Constructors

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

Methods

Method	Description
isValid(InputStream binaryContent)	Checks whether specified stream is a valid BMP image
isValid(String contentInBase64)	Checks whether specified base64-encoded string is a valid BMP image
getType()	Returns ImageType.Bmp

BmpImage(String name, String contentInBase64)

public BmpImage(String name, String contentInBase64)

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

Parameters:

Parameter	Type	Description
name	java.lang.String	Name of the BMP 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 BMP content, exception will be thrown.

BmpImage(String name, InputStream binaryContent)

public BmpImage(String name, InputStream binaryContent)

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

Parameters:

Parameter	Type	Description
name	java.lang.String	Name of the BMP 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 BMP image

Parameters:

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

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

isValid(String contentInBase64)

public static boolean isValid(String contentInBase64)

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

Parameters:

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

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

getType()

public ImageType getType()

Returns ImageType.Bmp

Returns: ImageType

Nodejs-Java: GifImage

Mon, 01 Jan 0001 00:00:00 +0000

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
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

getVersion()

public final String getVersion()

Returns internal version of this GIF image (version is extracted from header)

Returns: java.lang.String

Nodejs-Java: IconImage

Mon, 01 Jan 0001 00:00:00 +0000

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
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

getNumberOfImages()

public final int getNumberOfImages()

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

Returns: int

Nodejs-Java: JpegImage

Mon, 01 Jan 0001 00:00:00 +0000

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

public final class JpegImage extends RasterImageResourceBase

Represents one image in JPEG (Joint Photographic Experts Group) format with its metadata and additional methods

Constructors

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

Methods

Method	Description
isValid(InputStream binaryContent)	Checks whether specified stream is a valid JPEG image
isValid(String contentInBase64)	Checks whether specified base64-encoded string is a valid JPEG image
getType()	Returns ImageType.Jpeg

JpegImage(String name, String contentInBase64)

public JpegImage(String name, String contentInBase64)

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

Parameters:

Parameter	Type	Description
name	java.lang.String	Name of the JPEG 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 JPEG content, exception will be thrown.

JpegImage(String name, InputStream binaryContent)

public JpegImage(String name, InputStream binaryContent)

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

Parameters:

Parameter	Type	Description
name	java.lang.String	Name of the JPEG 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 JPEG image

Parameters:

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

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

isValid(String contentInBase64)

public static boolean isValid(String contentInBase64)

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

Parameters:

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

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

getType()

public ImageType getType()

Returns ImageType.Jpeg

Returns: ImageType -

Nodejs-Java: PngImage

Mon, 01 Jan 0001 00:00:00 +0000

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

public final class PngImage extends RasterImageResourceBase

Represents one image in PNG (Portable Network Graphics) format with its metadata and additional methods

Constructors

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

Methods

Method	Description
isValid(InputStream binaryContent)	Checks whether specified stream is a valid PNG image
isValid(String contentInBase64)	Checks whether specified base64-encoded string is a valid PNG image
getType()	Returns ImageType.Png

PngImage(String name, String contentInBase64)

public PngImage(String name, String contentInBase64)

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

Parameters:

Parameter	Type	Description
name	java.lang.String	Name of the PNG 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 PNG content, exception will be thrown.

PngImage(String name, InputStream binaryContent)

public PngImage(String name, InputStream binaryContent)

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

Parameters:

Parameter	Type	Description
name	java.lang.String	Name of the PNG 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 PNG image

Parameters:

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

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

isValid(String contentInBase64)

public static boolean isValid(String contentInBase64)

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

Parameters:

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

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

getType()

public ImageType getType()

Returns ImageType.Png

Returns: ImageType -

Nodejs-Java: RasterImageResourceBase

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

All Implemented Interfaces: com.groupdocs.editor.htmlcss.resources.images.IImageResource

public abstract class RasterImageResourceBase implements IImageResource

Base class for any supported raster image with fixed name, dimensions, aspect ratio, type, size, and content.

Constructors

Constructor	Description
RasterImageResourceBase()

Fields

Field	Description
Disposed

Methods

Method	Description
getName()	Returns name of this raster image.
getFilenameWithExtension()	Returns correct filename of this raster image, which consists of name and extension.
getLinearDimensions()	Returns linear dimensions of this raster image (width and height)
getAspectRatio()	Returns an aspect ratio of this image as the width-to-height relation
getLength()	Returns the length of this raster image file in bytes
getByteContent()	Returns content of this raster image as byte stream
getTextContent()	Returns content of this raster image as base64-encoded string
save(String fullPathToFile)	Saves this raster image to the specified file
equals(IHtmlResource other)	Checks this instance with specified on reference equality.
dispose()	Disposes this raster image, disposing its content and making most methods and properties non-working
isDisposed()	Determines whether this raster image is disposed or not
getType()	In implementing type should return information about type of the raster image

RasterImageResourceBase()

public RasterImageResourceBase()

Disposed

public final Event<EventHandler> Disposed

getName()

public final String getName()

Returns name of this raster image. Usually doesn’t contain filename extension and theoretically can differ from filename.

Returns: java.lang.String

getFilenameWithExtension()

public final String getFilenameWithExtension()

Returns correct filename of this raster image, which consists of name and extension. Theoretically can differ from the name.

Returns: java.lang.String

getLinearDimensions()

public final Dimensions getLinearDimensions()

Returns linear dimensions of this raster image (width and height)

Returns: Dimensions

getAspectRatio()

public final Ratio getAspectRatio()

Returns an aspect ratio of this image as the width-to-height relation

Returns: Ratio

getLength()

public final int getLength()

Returns the length of this raster image file in bytes

Returns: int -

getByteContent()

public final InputStream getByteContent()

Returns content of this raster image as byte stream

Returns: java.io.InputStream -

getTextContent()

public final String getTextContent()

Returns content of this raster image as base64-encoded string

Returns: java.lang.String -

save(String fullPathToFile)

public final void save(String fullPathToFile)

Saves this raster image to the specified file

Parameters:

Parameter	Type	Description
fullPathToFile	java.lang.String	Full path to the file, which will be created or rewritten

equals(IHtmlResource other)

public final boolean equals(IHtmlResource other)

Checks this instance with specified on reference equality.

Parameters:

Parameter	Type	Description
other	IHtmlResource	Other IHtmlResource inheritor

Returns: boolean - True if are equal, false if are unequal

dispose()

public final void dispose()

Disposes this raster image, disposing its content and making most methods and properties non-working

isDisposed()

public final boolean isDisposed()

Determines whether this raster image is disposed or not

Returns: boolean -

getType()

public abstract ImageType getType()

In implementing type should return information about type of the raster image

Returns: ImageType -

Nodejs-Java: TiffImage

Mon, 01 Jan 0001 00:00:00 +0000

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

public final class TiffImage extends RasterImageResourceBase

Represents one image in TIFF (Tagged Image File Format) format with its metadata and additional methods

See https://en.wikipedia.org/wiki/TIFF for details. In very rare cases TIFF is present inside WordProcessing documents.

Constructors

Constructor	Description
TiffImage(String name, String contentInBase64)	Creates new TiffImage instance from content, represented as base64-encoded string, and with specified name
TiffImage(String name, InputStream binaryContent)	Creates new GifImage instance from content, represented as byte stream, and with specified name
TiffImage(String name, System.IO.Stream binaryContent)

Methods

Method	Description
isValid(InputStream binaryContent)	Checks whether specified stream is a valid TIFF image
isValid(String contentInBase64)	Checks whether specified base64-encoded string is a valid TIFF image
getType()	Returns ImageType.Tiff
getFramesCount()	Returns a number of frames (images) inside this TIFF image.

TiffImage(String name, String contentInBase64)

public TiffImage(String name, String contentInBase64)

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

Parameters:

Parameter	Type	Description
name	java.lang.String	Name of the TIFF 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 TIFF content, exception will be thrown.

TiffImage(String name, InputStream binaryContent)

public TiffImage(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.

TiffImage(String name, System.IO.Stream binaryContent)

public TiffImage(String name, System.IO.Stream binaryContent)

Parameters:

Parameter	Type	Description
name	java.lang.String
binaryContent	com.aspose.ms.System.IO.Stream

isValid(InputStream binaryContent)

public static boolean isValid(InputStream binaryContent)

Checks whether specified stream is a valid TIFF image

Parameters:

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

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

isValid(String contentInBase64)

public static boolean isValid(String contentInBase64)

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

Parameters:

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

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

getType()

public ImageType getType()

Returns ImageType.Tiff

Returns: ImageType -

getFramesCount()

public final int getFramesCount()

Returns a number of frames (images) inside this TIFF image. Cannot be lesser then 1.

Returns: int -