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

Java: Dimensions

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

Inheritance: java.lang.Object

public class Dimensions

Represents the linear dimensions (width and height) of one raster rectangular image in arbitrary unit. Immutable struct.

Constructors

Constructor	Description
Dimensions(int width, int height)	Creates a new instance from specified width and height

Methods

Method	Description
getWidth()	Returns width of the image
getHeight()	Returns height of the image
isSquare()	Determines whether specified ‘Dimensions’ represents square, i.e.
getArea()	Returns an area (Width x Height)
isEmpty()	Determines whether this “Dimensions” instance is empty and default, i.e.
getAspectRatio()	Aspect ratio of this dimensions as width/height
proportionallyResizeForNewWidth(int targetWidth)	Creates and returns new “Dimensions” instance, which is proportionally resized from current, based on specified width
proportionallyResizeForNewHeight(int targetHeight)	Creates and returns new “Dimensions” instance, which is proportionally resized from current, based on specified height
equals(Dimensions other)	Determines whether this instance is equal with specified “Dimensions” instance
equals(Object obj)	Determines whether this instance is equal with specified uncasted object, which presumably is another “Dimensions” instance
hashCode()	Returns a hashcode for this instance, which cannot be changed during its lifetime
op_Equality(Dimensions first, Dimensions second)	Checks whether two “Dimensions” values are equal, i.e.
op_Inequality(Dimensions first, Dimensions second)	Checks whether two “Dimensions” values are not equal, i.e.
toString()	Returns a string representation of this “Dimensions”
deepClone()	Returns a full copy of this instance
getEmpty()	Returns an empty Dimensions instance

Dimensions(int width, int height)

public Dimensions(int width, int height)

Creates a new instance from specified width and height

Parameters:

Parameter	Type	Description
width	int	Width of image
height	int	Height of image

getWidth()

public final int getWidth()

Returns width of the image

Returns: int

getHeight()

public final int getHeight()

Returns height of the image

Returns: int

isSquare()

public final boolean isSquare()

Determines whether specified ‘Dimensions’ represents square, i.e. if width is equal to height

Returns: boolean

getArea()

public final long getArea()

Returns an area (Width x Height)

Returns: long

isEmpty()

public final boolean isEmpty()

Determines whether this “Dimensions” instance is empty and default, i.e. it doesn’t store correct width and height

Returns: boolean

getAspectRatio()

public final Ratio getAspectRatio()

Aspect ratio of this dimensions as width/height

Returns: Ratio

proportionallyResizeForNewWidth(int targetWidth)

public final Dimensions proportionallyResizeForNewWidth(int targetWidth)

Creates and returns new “Dimensions” instance, which is proportionally resized from current, based on specified width

Parameters:

Parameter	Type	Description
targetWidth	int	New target width, that will be present in resultant Dimension

Returns: Dimensions - New “Dimensions” instance with specified target width and proportionally resized height

proportionallyResizeForNewHeight(int targetHeight)

public final Dimensions proportionallyResizeForNewHeight(int targetHeight)

Creates and returns new “Dimensions” instance, which is proportionally resized from current, based on specified height

Parameters:

Parameter	Type	Description
targetHeight	int	New target height, that will be present in resultant Dimension

Returns: Dimensions - New “Dimensions” instance with specified target height and proportionally resized width

equals(Dimensions other)

public final boolean equals(Dimensions other)

Determines whether this instance is equal with specified “Dimensions” instance

Parameters:

Parameter	Type	Description
other	Dimensions	Other “Dimensions” instance to check on equality

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

equals(Object obj)

public boolean equals(Object obj)

Determines whether this instance is equal with specified uncasted object, which presumably is another “Dimensions” instance

Parameters:

Parameter	Type	Description
obj	java.lang.Object	Other object, that is presumably of “Dimensions” type, that should be checked on equality with this

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

hashCode()

public int hashCode()

Returns a hashcode for this instance, which cannot be changed during its lifetime

Returns: int - Immutable (for this instance) hash-code as signed 4-byte integer

op_Equality(Dimensions first, Dimensions second)

public static boolean op_Equality(Dimensions first, Dimensions second)

Checks whether two “Dimensions” values are equal, i.e. they have equal width and height, or both are empty

Parameters:

Parameter	Type	Description
first	Dimensions	First instance to check
second	Dimensions	Second instance to check

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

op_Inequality(Dimensions first, Dimensions second)

public static boolean op_Inequality(Dimensions first, Dimensions second)

Checks whether two “Dimensions” values are not equal, i.e. their corresponding width and/or height are different

Parameters:

Parameter	Type	Description
first	Dimensions	First instance to check
second	Dimensions	Second instance to check

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

toString()

public String toString()

Returns a string representation of this “Dimensions”

W640×H480

Returns: java.lang.String - String instance, that contains a width and height in W:(width)×H:(height) format

deepClone()

public final Dimensions deepClone()

Returns a full copy of this instance

Returns: Dimensions - New instance, that is a full and deep copy of this one

getEmpty()

public static Dimensions getEmpty()

Returns an empty Dimensions instance

Returns: Dimensions

Java: ImageType

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

Inheritance: java.lang.Object

All Implemented Interfaces: com.groupdocs.editor.htmlcss.resources.IResourceType

public class ImageType implements IResourceType

Represents one supportable image type (format), supports both raster and vector formats

Constructors

Constructor	Description
ImageType()

Methods

Method	Description
getUndefined()	Undefined image type - special value, which should not normally occur
getJpeg()	JPEG image type
getPng()	PNG image type
getBmp()	BMP image type
getGif()	GIF image type
getIcon()	ICON image type
getSvg()	SVG vector image type
getWmf()	WMF (Windows MetaFile) vector image type
getEmf()	EMF (Enhanced MetaFile) vector image type
getTiff()	TIFF (Tagged Image File Format) raster image type
getFormalName()	Returns a formal name of this image format.
isVector()	Indicates whether this particular format is vector (true) or raster (false)
getFileExtension()	File extension (without leading dot character) of a particular image type in lower case.
toString()	Returns a FormalName property
getMimeCode()	MIME code of a particular image type as a string.
equals(ImageType other)	Determines whether this instance is equal with specified “ImageType” instance
equals(Object obj)	Determines whether this instance is equal with specified uncasted object, which presumably is another “ImageType” instance
op_Equality(ImageType first, ImageType second)	Defines whether two specific ImageType instances are equal
op_Inequality(ImageType first, ImageType second)	Defines whether two specific ImageType instances are not equal
hashCode()	Returns a hash-code, which is an immutable number for this specific instance
parseFromFilenameWithExtension(String filename)	Returns ImageType value, which is equivalent of filename extension, which is extracted from specified filename
parseFromMime(String mimeCode)	Returns ImageType value, which is equivalent of specified MIME code

ImageType()

public ImageType()

getUndefined()

public static ImageType getUndefined()

Undefined image type - special value, which should not normally occur

Returns: ImageType

getJpeg()

public static ImageType getJpeg()

JPEG image type

Returns: ImageType

getPng()

public static ImageType getPng()

PNG image type

Returns: ImageType

getBmp()

public static ImageType getBmp()

BMP image type

Returns: ImageType

getGif()

public static ImageType getGif()

GIF image type

Returns: ImageType

getIcon()

public static ImageType getIcon()

ICON image type

Returns: ImageType

getSvg()

public static ImageType getSvg()

SVG vector image type

Returns: ImageType

getWmf()

public static ImageType getWmf()

WMF (Windows MetaFile) vector image type

Returns: ImageType

getEmf()

public static ImageType getEmf()

EMF (Enhanced MetaFile) vector image type

Returns: ImageType

getTiff()

public static ImageType getTiff()

TIFF (Tagged Image File Format) raster image type

Returns: ImageType

getFormalName()

public final String getFormalName()

Returns a formal name of this image format. Never reurns NULL. If instance is not corrupted, never throws an exception.

Returns: java.lang.String

isVector()

public final boolean isVector()

Indicates whether this particular format is vector (true) or raster (false)

Returns: boolean

getFileExtension()

public final String getFileExtension()

File extension (without leading dot character) of a particular image type in lower case. For the Undefined type returns a string ‘unsefined’.

Returns: java.lang.String

toString()

public String toString()

Returns a FormalName property

Returns: java.lang.String -

getMimeCode()

public final String getMimeCode()

MIME code of a particular image type as a string. For the Undefined type returns a string ‘unsefined’.

Returns: java.lang.String

equals(ImageType other)

public final boolean equals(ImageType other)

Determines whether this instance is equal with specified “ImageType” instance

Parameters:

Parameter	Type	Description
other	ImageType	Other ImageType instance to check on equality with this

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

equals(Object obj)

public boolean equals(Object obj)

Determines whether this instance is equal with specified uncasted object, which presumably is another “ImageType” instance

Parameters:

Parameter	Type	Description
obj	java.lang.Object	Other System.Object instance, that is presumably of ImageType type, to check on equality with this

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

op_Equality(ImageType first, ImageType second)

public static boolean op_Equality(ImageType first, ImageType second)

Defines whether two specific ImageType instances are equal

Parameters:

Parameter	Type	Description
first	ImageType	First ImageType instance to check
second	ImageType	Second ImageType instance to check

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

op_Inequality(ImageType first, ImageType second)

public static boolean op_Inequality(ImageType first, ImageType second)

Defines whether two specific ImageType instances are not equal

Parameters:

Parameter	Type	Description
first	ImageType	First ImageType instance to check
second	ImageType	Second ImageType instance to check

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

hashCode()

public int hashCode()

Returns a hash-code, which is an immutable number for this specific instance

Returns: int - Signed 4-byte integer

parseFromFilenameWithExtension(String filename)

public static ImageType parseFromFilenameWithExtension(String filename)

Returns ImageType value, which is equivalent of filename extension, which is extracted from specified filename

Parameters:

Parameter	Type	Description
filename	java.lang.String	Arbitrary filename, can be a relative or full path

Returns: ImageType - ImageType value. Returns ImageType.Undefined, if extension cannot be recognized.

parseFromMime(String mimeCode)

public static ImageType parseFromMime(String mimeCode)

Returns ImageType value, which is equivalent of specified MIME code

Parameters:

Parameter	Type	Description
mimeCode	java.lang.String	Arbitrary MIME-code

Returns: ImageType - ImageType value. Returns ImageType.Undefined, if extension cannot be recognized.

Java: IImage

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

public interface IImage

Image CSS data type represents a two-dimensional image

https://developer.mozilla.org/en-US/docs/Web/CSS/image CSS reference declares 4 types of images, that can be handled: 1. Images with intrinsic dimensions (a natural size) and thus fixed aspect ratio, that includes all raster images. 2. Images with multiple intrinsic dimensions, existing in multiple versions inside a single file, that includes ICON (*.ico) files. This may be also TIFF, as they support multiple images inside one file, however TIFF format is not supported in web. 3. Images with no intrinsic dimensions but with an intrinsic aspect ratio between its width and height. This includes all vector images, SVG first of all. 4. Images with neither intrinsic dimensions, nor an intrinsic aspect ratio. This includes all gradients.

Java: IImageResource

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

All Implemented Interfaces: com.groupdocs.editor.htmlcss.resources.IHtmlResource, com.groupdocs.editor.htmlcss.resources.images.IImage

public interface IImageResource extends IHtmlResource, IImage

Represents image resource of any type, raster or vector

https://developer.mozilla.org/en-US/docs/Web/CSS/image

Methods

Method	Description
getType()	In implementing type should return a type of specific image as an instance of specific ImageType, which encapsulates all type-specific info
getAspectRatio()	In implementing type should return an aspect ratio of particular image regardless of its type.
getLinearDimensions()	In implementing type should return linear dimensions of the image.

getType()

public abstract ImageType getType()

In implementing type should return a type of specific image as an instance of specific ImageType, which encapsulates all type-specific info

Returns: ImageType

getAspectRatio()

public abstract Ratio getAspectRatio()

In implementing type should return an aspect ratio of particular image regardless of its type. Both vector and raster images have intrinsic aspect ratio between its width and height.

Returns: Ratio -

getLinearDimensions()

public abstract Dimensions getLinearDimensions()

In implementing type should return linear dimensions of the image. For raster images they are intrinsic dimensions in pixels. Vector images, in counterpart, have no fixed dimensions, but their metadata can contain some basic dimensions in different measurement units.

Returns: Dimensions -