Packages

com.aspose.html.rendering.image

Classes

java.lang.Object
- com.aspose.html.rendering.Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
- - com.aspose.html.rendering.image.ImageDevice

All Implemented Interfaces:

IDevice, com.aspose.html.internal.ms.System.IDisposable
```
public class ImageDevice
extends Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
```
Represents rendering to raster formats: jpeg, png, bmp, gif, tiff.

See Also:

ImageDevice.ImageGraphicContext

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImageDevice.ImageGraphicContext
Holds current graphics control parameters for the ImageDevice.
- Nested classes/interfaces inherited from class com.aspose.html.rendering.Device
  Device.DeviceConfiguration, Device.PageWritingStrategy

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImageDevice.ImageGraphicContext` Holds current graphics control parameters for the `ImageDevice`.

Constructor Summary

Constructors
Constructor and Description
`ImageDevice(ICreateStreamProvider streamProvider)` Initializes a new instance of the `ImageDevice` class.
`ImageDevice(ImageRenderingOptions options, ICreateStreamProvider streamProvider)` Initializes a new instance of the `ImageDevice` class by rendering options and stream provider.
`ImageDevice(ImageRenderingOptions options, com.aspose.html.internal.ms.System.IO.Stream stream)` Initializes a new instance of the `ImageDevice` class by rendering options and output stream.
`ImageDevice(ImageRenderingOptions options, String file)` Initializes a new instance of the `ImageDevice` class by rendering options and output file name.
`ImageDevice(com.aspose.html.internal.ms.System.IO.Stream stream)` Initializes a new instance of the `ImageDevice` class.
`ImageDevice(String file)` Initializes a new instance of the `ImageDevice` class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRect(com.aspose.html.internal.ms.System.Drawing.RectangleF rect)` Appends a rectangle to the current path as a complete subpath.
`void`	`beginDocument(Document document)` Begins rendering of the document.
`boolean`	`beginElement(Element element, com.aspose.html.internal.ms.System.Drawing.RectangleF rect)` Begins rendering of the html element.
`void`	`beginPage(com.aspose.html.internal.ms.System.Drawing.SizeF size)` Begins rendering of the new page.
`void`	`clip(int mode)` Modifies the current clipping path by intersecting it with the current path, using the FillMode rule to determine the region to fill.
`void`	`closePath()` Closes the current subpath by appending a straight line segment from the current point to the starting point of the subpath.
`void`	`cubicBezierTo(com.aspose.html.internal.ms.System.Drawing.PointF pt1, com.aspose.html.internal.ms.System.Drawing.PointF pt2, com.aspose.html.internal.ms.System.Drawing.PointF pt3)` Appends a cubic Bézier curve to the current path.
`void`	`drawImage(byte[] data, int type, com.aspose.html.internal.ms.System.Drawing.RectangleF rect)` Draws the specified image.
`void`	`endDocument()` Ends rendering of the document.
`void`	`endElement(Element element)` Ends rendering of the html element.
`void`	`endPage()` Ends rendering of the current page.
`void`	`fill(int mode)` Fills the entire region enclosed by the current path.
`void`	`fillText(String text, com.aspose.html.internal.ms.System.Drawing.PointF pt)` Fills the specified text string at the specified location.
`void`	`flush()` Flushes all data to output stream.
`com.aspose.html.internal.ms.System.Drawing.Graphics`	`getGraphics()` Gets the instance of Graphics.
`com.aspose.html.internal.ms.System.IO.Stream`	`getInternalOutputStream()`
`com.aspose.html.rendering.image.renderingstrategies.ImageRenderingStrategy`	`getRenderingStrategy()`
`void`	`lineTo(com.aspose.html.internal.ms.System.Drawing.PointF pt)` Appends a straight line segment from the current point to the point (pt).
`void`	`moveTo(com.aspose.html.internal.ms.System.Drawing.PointF pt)` Begins a new subpath by moving the current point to coordinates of the parameter pt, omitting any connecting line segment.
`void`	`restoreGraphicContext()` Restores the entire graphics context to its former value by popping it from the stack.
`void`	`saveGraphicContext()` Pushes a copy of the entire graphics context onto the stack.
`void`	`stroke()` Strokes a line along the current path.
`void`	`strokeAndFill(int mode)` Strokes and fill current path.
`void`	`strokeText(String text, com.aspose.html.internal.ms.System.Drawing.PointF pt)` Strokes the specified text string at the specified location.
`com.aspose.html.internal.ms.System.Drawing.Brush`	`toNativeBrush(IBrush brush)`

Methods inherited from class com.aspose.html.rendering.Device
dispose, getCurrentDocument, getGraphicContext, getOptions, getOriginalOutputStream, getPageIndex, getRenderingStarted, initPageBackground, setCurrentDocument, setPageIndex

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

- Constructor Detail
  - ImageDevice
```
public ImageDevice(ICreateStreamProvider streamProvider)
```
    Initializes a new instance of the ImageDevice class.
    
    Parameters:
    
    streamProvider - The stream provider.
  - ImageDevice
```
public ImageDevice(ImageRenderingOptions options,
                   ICreateStreamProvider streamProvider)
```
    Initializes a new instance of the ImageDevice class by rendering options and stream provider.
    
    Parameters:
    
    options - Rendering options.
    
    streamProvider - Object that implements the ICreateStreamProvider interface
  - ImageDevice
```
public ImageDevice(String file)
```
    Initializes a new instance of the ImageDevice class.
    
    Parameters:
    
    file - The output file name.
  - ImageDevice
```
public ImageDevice(ImageRenderingOptions options,
                   String file)
```
    Initializes a new instance of the ImageDevice class by rendering options and output file name.
    
    Parameters:
    
    options - Rendering options.
    
    file - The output file name.
  - ImageDevice
```
public ImageDevice(com.aspose.html.internal.ms.System.IO.Stream stream)
```
    Initializes a new instance of the ImageDevice class.
    
    Parameters:
    
    stream - The stream.
  - ImageDevice
```
public ImageDevice(ImageRenderingOptions options,
                   com.aspose.html.internal.ms.System.IO.Stream stream)
```
    Initializes a new instance of the ImageDevice class by rendering options and output stream.
    
    Parameters:
    
    options - Rendering options.
    
    stream - The output stream.
- Method Detail
  - getRenderingStrategy
```
public com.aspose.html.rendering.image.renderingstrategies.ImageRenderingStrategy getRenderingStrategy()
```
  - flush
```
public void flush()
```
    Flushes all data to output stream.
    
    Specified by:
    
    flush in interface IDevice
    
    Overrides:
    
    flush in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
  - beginDocument
```
public void beginDocument(Document document)
```
    Begins rendering of the document.
    
    Specified by:
    
    beginDocument in interface IDevice
    
    Overrides:
    
    beginDocument in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    document - The document.
  - endDocument
```
public void endDocument()
```
    Ends rendering of the document.
    
    Specified by:
    
    endDocument in interface IDevice
    
    Overrides:
    
    endDocument in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
  - saveGraphicContext
```
public void saveGraphicContext()
```
    Pushes a copy of the entire graphics context onto the stack.
    
    Specified by:
    
    saveGraphicContext in interface IDevice
    
    Overrides:
    
    saveGraphicContext in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
  - restoreGraphicContext
```
public void restoreGraphicContext()
```
    Restores the entire graphics context to its former value by popping it from the stack.
    
    Specified by:
    
    restoreGraphicContext in interface IDevice
    
    Overrides:
    
    restoreGraphicContext in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
  - beginElement
```
public boolean beginElement(Element element,
                            com.aspose.html.internal.ms.System.Drawing.RectangleF rect)
```
    Begins rendering of the html element.
    
    Specified by:
    
    beginElement in interface IDevice
    
    Specified by:
    
    beginElement in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    element - The html element.
    
    rect - Bounding box of the node.
    
    Returns:
    
    Returns [true] if element should be processed.
  - endElement
```
public void endElement(Element element)
```
    Ends rendering of the html element.
    
    Specified by:
    
    endElement in interface IDevice
    
    Specified by:
    
    endElement in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    element - The html element.
  - closePath
```
public void closePath()
```
    Closes the current subpath by appending a straight line segment from the current point to the starting point of the subpath. If the current subpath is already closed, "ClosePath" does nothing. This operator terminates the current subpath. Appending another segment to the current path begins a new subpath, even if the new segment begins at the endpoint reached by the "ClosePath" method.
    
    Specified by:
    
    closePath in interface IDevice
    
    Specified by:
    
    closePath in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
  - moveTo
```
public void moveTo(com.aspose.html.internal.ms.System.Drawing.PointF pt)
```
    Begins a new subpath by moving the current point to coordinates of the parameter pt, omitting any connecting line segment. If the previous path construction method in the current path was also "MoveTo", the new "MoveTo" overrides it; no vestige of the previous "MoveTo" operation remains in the path.
    
    Specified by:
    
    moveTo in interface IDevice
    
    Specified by:
    
    moveTo in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    pt - Point of where to move the path to.
  - lineTo
```
public void lineTo(com.aspose.html.internal.ms.System.Drawing.PointF pt)
```
    Appends a straight line segment from the current point to the point (pt). The new current point is pt.
    
    Specified by:
    
    lineTo in interface IDevice
    
    Specified by:
    
    lineTo in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    pt - Point of where to create the line to.
  - addRect
```
public void addRect(com.aspose.html.internal.ms.System.Drawing.RectangleF rect)
```
    Appends a rectangle to the current path as a complete subpath.
    
    Specified by:
    
    addRect in interface IDevice
    
    Specified by:
    
    addRect in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    rect - A rectangle to draw.
  - cubicBezierTo
```
public void cubicBezierTo(com.aspose.html.internal.ms.System.Drawing.PointF pt1,
                          com.aspose.html.internal.ms.System.Drawing.PointF pt2,
                          com.aspose.html.internal.ms.System.Drawing.PointF pt3)
```
    Appends a cubic Bézier curve to the current path. The curve extends from the current point to the point pt2, using pt1 and pt2 as the Bézier control points. The new current point is pt3.
    
    Specified by:
    
    cubicBezierTo in interface IDevice
    
    Specified by:
    
    cubicBezierTo in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    pt1 - Coordinates of first point
    
    pt2 - Coordinates of second point
    
    pt3 - Coordinates of third point
  - toNativeBrush
```
public com.aspose.html.internal.ms.System.Drawing.Brush toNativeBrush(IBrush brush)
```
  - stroke
```
public void stroke()
```
    Strokes a line along the current path. The stroked line follows each straight or curved segment in the path, centered on the segment with sides parallel to it. Each of the path’s subpaths is treated separately. This method terminates current path.
    
    Specified by:
    
    stroke in interface IDevice
    
    Specified by:
    
    stroke in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
  - fill
```
public void fill(int mode)
```
    Fills the entire region enclosed by the current path. If the path consists of several disconnected subpaths, it fills the insides of all subpaths, considered together. This method terminates current path.
    
    Specified by:
    
    fill in interface IDevice
    
    Specified by:
    
    fill in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    mode - Filling mode specifies how the interior of a closed path is filled
  - clip
```
public void clip(int mode)
```
    Modifies the current clipping path by intersecting it with the current path, using the FillMode rule to determine the region to fill. This method terminates current path.
    
    Specified by:
    
    clip in interface IDevice
    
    Specified by:
    
    clip in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    mode - Filling mode specifies how the interior of a closed path is clipped
  - strokeAndFill
```
public void strokeAndFill(int mode)
```
    Strokes and fill current path. This method terminates current path.
    
    Specified by:
    
    strokeAndFill in interface IDevice
    
    Specified by:
    
    strokeAndFill in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    mode - Filling mode specifies how the interior of a closed path is filled.
  - fillText
```
public void fillText(String text,
                     com.aspose.html.internal.ms.System.Drawing.PointF pt)
```
    Fills the specified text string at the specified location.
    
    Specified by:
    
    fillText in interface IDevice
    
    Specified by:
    
    fillText in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    text - String to fill.
    
    pt - Point that specifies the coordinates of the text.
  - strokeText
```
public void strokeText(String text,
                       com.aspose.html.internal.ms.System.Drawing.PointF pt)
```
    Strokes the specified text string at the specified location.
    
    Specified by:
    
    strokeText in interface IDevice
    
    Specified by:
    
    strokeText in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    text - String to stroke.
    
    pt - Point that specifies the coordinates where to start the text.
  - drawImage
```
public void drawImage(byte[] data,
                      int type,
                      com.aspose.html.internal.ms.System.Drawing.RectangleF rect)
```
    Draws the specified image.
    
    Specified by:
    
    drawImage in interface IDevice
    
    Specified by:
    
    drawImage in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    data - An array of bytes representing the image.
    
    type - Image type.
    
    rect - A rectangel which determines position and size to draw.
  - getInternalOutputStream
```
public com.aspose.html.internal.ms.System.IO.Stream getInternalOutputStream()
```
  - getGraphics
```
public com.aspose.html.internal.ms.System.Drawing.Graphics getGraphics()
```
    Gets the instance of Graphics.
  - beginPage
```
public void beginPage(com.aspose.html.internal.ms.System.Drawing.SizeF size)
```
    Begins rendering of the new page.
    
    Specified by:
    
    beginPage in interface IDevice
    
    Overrides:
    
    beginPage in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>
    
    Parameters:
    
    size - Size of the page.
  - endPage
```
public void endPage()
```
    Ends rendering of the current page.
    
    Specified by:
    
    endPage in interface IDevice
    
    Overrides:
    
    endPage in class Device<ImageDevice.ImageGraphicContext,ImageRenderingOptions>

Packages

com.aspose.html.rendering.image

Classes

Class ImageDevice

Nested Class Summary

Nested classes/interfaces inherited from class com.aspose.html.rendering.Device

Constructor Summary

Method Summary

Methods inherited from class com.aspose.html.rendering.Device

Methods inherited from class java.lang.Object

Constructor Detail

ImageDevice

ImageDevice

ImageDevice

ImageDevice

ImageDevice

ImageDevice

Method Detail

getRenderingStrategy

flush

beginDocument

endDocument

saveGraphicContext

restoreGraphicContext

beginElement

endElement

closePath

moveTo

lineTo

addRect

cubicBezierTo

toNativeBrush

stroke

fill

clip

strokeAndFill

fillText

strokeText

drawImage

getInternalOutputStream

getGraphics

beginPage

endPage