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

Java: EmfImage

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

Inheritance: java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.vector.VectorImageResourceBase, com.groupdocs.editor.htmlcss.resources.images.vector.MetaImageBase

public final class EmfImage extends MetaImageBase

Represents one vector image in Enhanced metafile format (EMF) format with its metadata and additional methods

Constructors

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

Methods

Method	Description
isValid(InputStream binaryContent)	Checks whether specified stream is a valid EMF image
isValid(String contentInBase64)	Checks whether specified base64-encoded string is a valid EMF image
getType()	Returns ImageType.Emf
getByteContent()	Returns a content of this EMF image as a binary stream
getTextContent()	Returns a content of this EMF image as a plain text
save(String fullPathToFile)	Saves this EMF image to the file
saveToPng(OutputStream outputPngContent)	Saves this vector EMF image into raster PNG image
saveToSvg(OutputStream outputSvgContent)	Saves this vector EMF image into vector SVG image
dispose()	Disposes this EMF image by disposing its content and making most its methods and properties non-working

EmfImage(String name, String contentInBase64)

public EmfImage(String name, String contentInBase64)

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

Parameters:

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

EmfImage(String name, InputStream binaryContent)

public EmfImage(String name, InputStream binaryContent)

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

Parameters:

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

Parameters:

Parameter	Type	Description
binaryContent	java.io.InputStream	Input byte stream. Cannot be NULL, should support reading and seeking.

Returns: boolean - True if specified stream holds a valid EMF image, false otherwise

isValid(String contentInBase64)

public static boolean isValid(String contentInBase64)

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

Parameters:

Parameter	Type	Description
contentInBase64	java.lang.String	Input string, where content of EMF image is stored in base64 encoding. Cannot be NULL or empty.

Returns: boolean - True if specified string holds a valid EMF image, false otherwise

getType()

public ImageType getType()

Returns ImageType.Emf

Returns: ImageType

getByteContent()

public InputStream getByteContent()

Returns a content of this EMF image as a binary stream

Returns: java.io.InputStream

getTextContent()

public String getTextContent()

Returns a content of this EMF image as a plain text

Returns: java.lang.String -

save(String fullPathToFile)

public void save(String fullPathToFile)

Saves this EMF image to the file

Parameters:

Parameter	Type	Description
fullPathToFile	java.lang.String	Full path to the file, which will be created (if it doesn’t exist) or overwritten (if exists) with the content of this EMF image

saveToPng(OutputStream outputPngContent)

public void saveToPng(OutputStream outputPngContent)

Saves this vector EMF image into raster PNG image

Parameters:

Parameter	Type	Description
outputPngContent	java.io.OutputStream	Output stream, into which the content of PNG image will be written. Cannot be NULL and should be writable.

saveToSvg(OutputStream outputSvgContent)

public void saveToSvg(OutputStream outputSvgContent)

Saves this vector EMF image into vector SVG image

Parameters:

Parameter	Type	Description
outputSvgContent	java.io.OutputStream	Output stream, into which the content of SVG image will be written. Cannot be NULL and should be writable.

dispose()

public void dispose()

Disposes this EMF image by disposing its content and making most its methods and properties non-working

Java: MetaImageBase

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

Inheritance: java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.vector.VectorImageResourceBase

public abstract class MetaImageBase extends VectorImageResourceBase

Base abstract class for WMF and EMF image formats

Constructors

Constructor	Description
MetaImageBase(String name, String contentInBase64, boolean isWmf)	Common constructor, which prepares a creating a WMF or EMF instance from base64-encoded string
MetaImageBase(String name, InputStream binaryContent, boolean isWmf)	Common constructor, which prepares a creating a WMF or EMF instance from byte stream

Methods

Method	Description
isValidWmf(InputStream binaryContent)	Determines whether specified byte stream contains a valid WMF image
isValidWmf(String contentInBase64)	Determines whether specified string contains a valid WMF image, which is encoded with base64
isValidEmf(InputStream binaryContent)	Determines whether specified byte stream contains a valid EMF image
isValidEmf(String contentInBase64)	Determines whether specified string contains a valid EMF image, which is encoded with base64
saveToSvg(OutputStream outputSvgContent)	In implementing type should save a current vector meta-image to the vector SVG format into specified byte stream

MetaImageBase(String name, String contentInBase64, boolean isWmf)

public MetaImageBase(String name, String contentInBase64, boolean isWmf)

Common constructor, which prepares a creating a WMF or EMF instance from base64-encoded string

Parameters:

Parameter	Type	Description
name	java.lang.String	Mandatory name
contentInBase64	java.lang.String	Content as base64 string. Should be not NULL or empty.
isWmf	boolean	true for WMF, false for EMF

MetaImageBase(String name, InputStream binaryContent, boolean isWmf)

public MetaImageBase(String name, InputStream binaryContent, boolean isWmf)

Common constructor, which prepares a creating a WMF or EMF instance from byte stream

Parameters:

Parameter	Type	Description
name	java.lang.String	Mandatory name
binaryContent	java.io.InputStream	Content as byte stream. Should be valid.
isWmf	boolean	true for WMF, false for EMF

isValidWmf(InputStream binaryContent)

public static boolean isValidWmf(InputStream binaryContent)

Determines whether specified byte stream contains a valid WMF image

Parameters:

Parameter	Type	Description
binaryContent	java.io.InputStream	Input byte stream. Should be valid.

Returns: boolean - Returns ’true’ if valid and ‘false’ if invalid

isValidWmf(String contentInBase64)

public static boolean isValidWmf(String contentInBase64)

Determines whether specified string contains a valid WMF image, which is encoded with base64

Parameters:

Parameter	Type	Description
contentInBase64	java.lang.String	String, which is assumed to contain a base64-encoded WMF image

Returns: boolean - Returns ’true’ if valid and ‘false’ if invalid

isValidEmf(InputStream binaryContent)

public static boolean isValidEmf(InputStream binaryContent)

Determines whether specified byte stream contains a valid EMF image

Parameters:

Parameter	Type	Description
binaryContent	java.io.InputStream	Input byte stream. Should be valid.

Returns: boolean - Returns ’true’ if valid and ‘false’ if invalid

isValidEmf(String contentInBase64)

public static boolean isValidEmf(String contentInBase64)

Determines whether specified string contains a valid EMF image, which is encoded with base64

Parameters:

Parameter	Type	Description
contentInBase64	java.lang.String	String, which is assumed to contain a base64-encoded EMF image

Returns: boolean - Returns ’true’ if valid and ‘false’ if invalid

saveToSvg(OutputStream outputSvgContent)

public abstract void saveToSvg(OutputStream outputSvgContent)

In implementing type should save a current vector meta-image to the vector SVG format into specified byte stream

Parameters:

Parameter	Type	Description
outputSvgContent	java.io.OutputStream	Byte stream, into which the SVG version of this vector meta-image will be stored. Should not be NULL and should support writing.

Java: SvgImage

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

Inheritance: java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.vector.VectorImageResourceBase

public final class SvgImage extends VectorImageResourceBase

Represents one vector image in SVG (Scalable Vector Graphics) format with its metadata and additional methods

Constructors

Constructor	Description
SvgImage(String name, String content)	Creates new SvgImage instance from content, represented as usual string, and with specified name
SvgImage(String name, InputStream binaryContent)	Creates new SvgImage instance from content, represented as byte stream, and with specified name

Methods

Method	Description
isValid(String content)	Performs a surface check whether specified textual XML-compliant content represents a SVG image
getType()	Returns ImageType.Svg
getByteContent()	Returns a content of this SVG image as a binary stream
getTextContent()	Returns a content of this SVG image as a plain text (in XML format)
getXmlContent()	Returns a content of this SVG image int its original XML-compliant textual form
save(String fullPathToFile)	Saves this SVG image to the file
saveToPng(OutputStream outputPngContent)	Saves this vector SVG image into raster PNG image
dispose()	Disposes this raster image, disposing its content and making most methods and properties non-working

SvgImage(String name, String content)

public SvgImage(String name, String content)

Creates new SvgImage instance from content, represented as usual string, and with specified name

Parameters:

Parameter	Type	Description
name	java.lang.String	Name of the SVG image. Cannot be null, empty or whitespaces.
content	java.lang.String	Content as a usual string, which contains a valid XML-compliant content of SVG image. Cannot be null, empty or whitespaces. If it is not a SVG content, exception will be thrown.

SvgImage(String name, InputStream binaryContent)

public SvgImage(String name, InputStream binaryContent)

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

Parameters:

Parameter	Type	Description
name	java.lang.String	Name of the SVG 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(String content)

public static boolean isValid(String content)

Performs a surface check whether specified textual XML-compliant content represents a SVG image

Parameters:

Parameter	Type	Description
content	java.lang.String	XML content of an SVG image as simple text, not a base64-encoded content

Returns: boolean - True if specified string can be treated as valid SVG at first look, false if it is not SVG for sure

getType()

public ImageType getType()

Returns ImageType.Svg

Returns: ImageType -

getByteContent()

public InputStream getByteContent()

Returns a content of this SVG image as a binary stream

Returns: java.io.InputStream -

getTextContent()

public String getTextContent()

Returns a content of this SVG image as a plain text (in XML format)

Returns: java.lang.String -

getXmlContent()

public final String getXmlContent()

Returns a content of this SVG image int its original XML-compliant textual form

Returns: java.lang.String -

save(String fullPathToFile)

public void save(String fullPathToFile)

Saves this SVG image to the file

Parameters:

Parameter	Type	Description
fullPathToFile	java.lang.String	Full path to the file, which will be created (if it doesn’t exist) or overwritten (if exists) with the content of this SVG image

saveToPng(OutputStream outputPngContent)

public void saveToPng(OutputStream outputPngContent)

Saves this vector SVG image into raster PNG image

Parameters:

Parameter	Type	Description
outputPngContent	java.io.OutputStream	Output stream, into which the content of PNG image will be written. Cannot be NULL and should be writable.

dispose()

public void dispose()

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

Java: VectorImageResourceBase

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 VectorImageResourceBase implements IImageResource

Base class for any supported vector image

Constructors

Constructor	Description
VectorImageResourceBase()

Fields

Field	Description
Disposed

Methods

Method	Description
getName()	Returns name of this vector image.
getFilenameWithExtension()	Returns correct filename of this vector image, which consists of name and extension.
getAspectRatio()	Returns aspect ratio of this vector image
getLinearDimensions()	Returns linear dimensions of this vector image (width and height)
equals(IHtmlResource other)	Checks this instance with specified on reference equality.
isDisposed()	Determines whether this raster image is disposed or not
getType()	In implementing type should return information about type of the vector image
getByteContent()	In implementing type should return a content of this vector image as byte stream
getTextContent()	In implementing type should return a content of this vector image in text form: base64-encoded of XML regarding of image type
save(String fullPathToFile)	In implementing type should save this image to the disk by specified path
saveToPng(OutputStream outputPngContent)	In implementing type should save a current vector image to the raster PNG format into specified byte stream
dispose()	In implementing type should dispose this instance

VectorImageResourceBase()

public VectorImageResourceBase()

Disposed

public final Event<EventHandler> Disposed

getName()

public final String getName()

Returns name of this vector 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 vector image, which consists of name and extension. Theoretically can differ from the name.

Returns: java.lang.String

getAspectRatio()

public final Ratio getAspectRatio()

Returns aspect ratio of this vector image

Returns: Ratio

getLinearDimensions()

public final Dimensions getLinearDimensions()

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

Returns: Dimensions

equals(IHtmlResource other)

public final boolean equals(IHtmlResource other)

Checks this instance with specified on reference equality.

Parameters:

Parameter	Type	Description
other	IHtmlResource	Other instance of vector image

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

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

Returns: ImageType -

getByteContent()

public InputStream getByteContent()

In implementing type should return a content of this vector image as byte stream

Returns: java.io.InputStream -

getTextContent()

public abstract String getTextContent()

In implementing type should return a content of this vector image in text form: base64-encoded of XML regarding of image type

Returns: java.lang.String -

save(String fullPathToFile)

public abstract void save(String fullPathToFile)

In implementing type should save this image to the disk by specified path

Parameters:

Parameter	Type	Description
fullPathToFile	java.lang.String

saveToPng(OutputStream outputPngContent)

public abstract void saveToPng(OutputStream outputPngContent)

In implementing type should save a current vector image to the raster PNG format into specified byte stream

Parameters:

Parameter	Type	Description
outputPngContent	java.io.OutputStream	Byte stream, into which the PNG version of this raster image will be stored. Should not be NULL and should support writing.

dispose()

public abstract void dispose()

In implementing type should dispose this instance

Java: WmfImage

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

Inheritance: java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.vector.VectorImageResourceBase, com.groupdocs.editor.htmlcss.resources.images.vector.MetaImageBase

public final class WmfImage extends MetaImageBase

Represents one vector image in WMF (Windows MetaFile) format with its metadata and additional methods

Constructors

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

Methods

Method	Description
isValid(InputStream binaryContent)	Checks whether specified stream is a valid WMF image
isValid(String contentInBase64)	Checks whether specified base64-encoded string is a valid WMF image
getType()	Returns ImageType.Wmf
getByteContent()	Returns a content of this WMF image as a binary stream
getTextContent()	Returns a content of this WMF image as a plain text
save(String fullPathToFile)	Saves this WMF image to the file
saveToPng(OutputStream outputPngContent)	Saves this vector WMF image into raster PNG image
saveToSvg(OutputStream outputSvgContent)	Saves this vector WMF image into vector SVG image
dispose()	Disposes this WMF image by disposing its content and making most its methods and properties non-working

WmfImage(String name, String contentInBase64)

public WmfImage(String name, String contentInBase64)

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

Parameters:

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

WmfImage(String name, InputStream binaryContent)

public WmfImage(String name, InputStream binaryContent)

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

Parameters:

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

Parameters:

Parameter	Type	Description
binaryContent	java.io.InputStream	Input byte stream. Cannot be NULL, should support reading and seeking.

Returns: boolean - True if specified stream holds a valid WMF image, false otherwise

isValid(String contentInBase64)

public static boolean isValid(String contentInBase64)

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

Parameters:

Parameter	Type	Description
contentInBase64	java.lang.String	Input string, where content of WMF image is stored in base64 encoding. Cannot be NULL or empty.

Returns: boolean - True if specified string holds a valid WMF image, false otherwise

getType()

public ImageType getType()

Returns ImageType.Wmf

Returns: ImageType -

getByteContent()

public InputStream getByteContent()

Returns a content of this WMF image as a binary stream

Returns: java.io.InputStream -

getTextContent()

public String getTextContent()

Returns a content of this WMF image as a plain text

Returns: java.lang.String -

save(String fullPathToFile)

public void save(String fullPathToFile)

Saves this WMF image to the file

Parameters:

Parameter	Type	Description
fullPathToFile	java.lang.String	Full path to the file, which will be created (if it doesn’t exist) or overwritten (if exists) with the content of this WMF image

saveToPng(OutputStream outputPngContent)

public void saveToPng(OutputStream outputPngContent)

Saves this vector WMF image into raster PNG image

Parameters:

Parameter	Type	Description
outputPngContent	java.io.OutputStream	Output stream, into which the content of PNG image will be written. Cannot be NULL and should be writable.

saveToSvg(OutputStream outputSvgContent)

public void saveToSvg(OutputStream outputSvgContent)

Saves this vector WMF image into vector SVG image

Parameters:

Parameter	Type	Description
outputSvgContent	java.io.OutputStream	Output stream, into which the content of SVG image will be written. Cannot be NULL and should be writable.

dispose()

public void dispose()

Disposes this WMF image by disposing its content and making most its methods and properties non-working