Packages

com.groupdocs.editor.htmlcss.resources.images.raster

Classes

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

Event<EventHandler> Disposed

Fields
Modifier and Type	Field and Description
`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.
`BufferedImage`	`generateBitmap()` Generates and returns a new instance of the 'System.Drawing.Bitmap' from this raster image.
`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
`RasterImageResourceBase`	`reduceToNewHeight(int targetHeightInPixels)` Creates and returns a new reduced image resource of the same type, but with specified new reduced height and proportionally reduced width.
`void`	`save(String fullPathToFile)` Saves this raster image to the specified file

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

- Field Detail
  - 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
  - generateBitmap
```
public final BufferedImage generateBitmap()
```
    Generates and returns a new instance of the 'System.Drawing.Bitmap' from this raster image.
    
    Returns:
    
    New instance of 'System.Drawing.Bitmap'
    
    'System.Drawing.Bitmap' is not cached and thus will be generated every time this method will be called
  - 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:
  - reduceToNewHeight
```
public RasterImageResourceBase reduceToNewHeight(int targetHeightInPixels)
```
    Creates and returns a new reduced image resource of the same type, but with specified new reduced height and proportionally reduced width.
    
    Parameters:
    
    targetHeightInPixels - Height of the desired image in pixels. Should be strictly lesser than original height.
    
    Returns:
    
    New instance with specified height, that is inheritor of RasterImageResourceBase
  - 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

Packages

com.groupdocs.editor.htmlcss.resources.images.raster

Classes

Class RasterImageResourceBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Disposed

Constructor Detail

RasterImageResourceBase

Method Detail

dispose

equals

generateBitmap

getAspectRatio

getByteContent

getFilenameWithExtension

getLength

getLinearDimensions

getName

getTextContent

getType

isDisposed

reduceToNewHeight

save