RasterImageResourceBase (GroupDocs.Total for Java (24.10) API Reference)

java.lang.Object
- com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase

All Implemented Interfaces:

IAuxDisposable, IHtmlResource, IImage, IImageResource, IDisposable

Direct Known Subclasses:

BmpImage, GifImage, IconImage, JpegImage, PngImage, TiffImage
```
public abstract class RasterImageResourceBase
extends Object
implements IImageResource
```
Base class for any supported raster image with fixed name, dimensions, aspect ratio, type, size, and content.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`_base64TextContent` Content of the image in base64-encoded form, stored in the string
`protected com.aspose.ms.System.IO.Stream`	`_binaryContent` Content of the image in the stream
`protected boolean`	`_isDisposed` Flag, which indicates, whether this image is disposed
`protected boolean`	`_isOwnStream` true if stream was created internally within inheritor (usually because original content was base64 string) and should be disposed; false if stream was passed from outside and should not be touched.
`protected Dimensions`	`_linearDimensions` Linear dimensions of the image
`protected String`	`_name` Name of the raster image, which serves as its unique identifier.
`protected long`	`_streamOrigPosition` Original position in the stream, which indicates the beginning of the image content
`Event<EventHandler>`	`Disposed`

Constructor Summary

Constructors
Constructor and Description

RasterImageResourceBase()

Constructors
Constructor and Description
`RasterImageResourceBase()`

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _base64TextContent
```
protected String _base64TextContent
```
    Content of the image in base64-encoded form, stored in the string
  - _binaryContent
```
protected com.aspose.ms.System.IO.Stream _binaryContent
```
    Content of the image in the stream
  - _isDisposed
```
protected boolean _isDisposed
```
    Flag, which indicates, whether this image is disposed
  - _isOwnStream
```
protected boolean _isOwnStream
```
    true if stream was created internally within inheritor (usually because original content was base64 string) and should be disposed; false if stream was passed from outside and should not be touched.
  - _linearDimensions
```
protected Dimensions _linearDimensions
```
    Linear dimensions of the image
  - _name
```
protected String _name
```
    Name of the raster image, which serves as its unique identifier. Should not be changed (readonly) after creating an instance of the class.
  - _streamOrigPosition
```
protected long _streamOrigPosition
```
    Original position in the stream, which indicates the beginning of the image content
  - Disposed
```
public final Event<EventHandler> Disposed
```
- Constructor Detail
  - RasterImageResourceBase
```
public RasterImageResourceBase()
```
- Method Detail
  - dispose
```
public final void dispose()
```
    Disposes this raster image, disposing its content and making most methods and properties non-working
    
    Specified by:
    
    dispose in interface IDisposable
  - equals
```
public final boolean equals(IHtmlResource other)
```
    Checks this instance with specified on reference equality.
    
    Parameters:
    
    other - Other IHtmlResource inheritor
    
    Returns:
    
    True if are equal, false if are unequal
  - getAspectRatio
```
public final Ratio getAspectRatio()
```
    Returns an aspect ratio of this image as the width-to-height relation
    
    Specified by:
    
    getAspectRatio in interface IImageResource
    
    Returns:
  - getByteContent
```
public final InputStream getByteContent()
```
    Returns content of this raster image as byte stream
    
    Specified by:
    
    getByteContent in interface IHtmlResource
    
    Returns:
  - getFilenameWithExtension
```
public final String getFilenameWithExtension()
```
    Returns correct filename of this raster image, which consists of name and extension. Theoretically can differ from the name.
    
    Specified by:
    
    getFilenameWithExtension in interface IHtmlResource
    
    Returns:
  - getLength
```
public final int getLength()
```
    Returns the length of this raster image file in bytes
    
    Returns:
  - getLinearDimensions
```
public final Dimensions getLinearDimensions()
```
    Returns linear dimensions of this raster image (width and height)
    
    Specified by:
    
    getLinearDimensions in interface IImageResource
    
    Returns:
  - getName
```
public final String getName()
```
    Returns name of this raster image. Usually doesn't contain filename extension and theoretically can differ from filename.
    
    Specified by:
    
    getName in interface IHtmlResource
    
    Returns:
  - getTextContent
```
public final String getTextContent()
```
    Returns content of this raster image as base64-encoded string
    
    Specified by:
    
    getTextContent in interface IHtmlResource
    
    Returns:
  - getType
```
public abstract ImageType getType()
```
    In implementing type should return information about type of the raster image
    
    Specified by:
    
    getType in interface IHtmlResource
    
    Specified by:
    
    getType in interface IImageResource
    
    Returns:
  - isDisposed
```
public final boolean isDisposed()
```
    Determines whether this raster image is disposed or not
    
    Specified by:
    
    isDisposed in interface IAuxDisposable
    
    Returns:
  - save
```
public final void save(String fullPathToFile)
```
    Saves this raster image to the specified file
    
    Specified by:
    
    save in interface IHtmlResource
    
    Parameters:
    
    fullPathToFile - Full path to the file, which will be created or rewritten

Class RasterImageResourceBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_base64TextContent

_binaryContent

_isDisposed

_isOwnStream

_linearDimensions

_name

_streamOrigPosition

Disposed

Constructor Detail

RasterImageResourceBase

Method Detail

dispose

equals

getAspectRatio

getByteContent

getFilenameWithExtension

getLength

getLinearDimensions

getName

getTextContent

getType

isDisposed

save