Packages

com.aspose.html.rendering

Interfaces

IDevice

Classes

java.lang.Object
- com.aspose.html.rendering.Device<TGraphicContext,TRenderingOptions>

All Implemented Interfaces:

IDevice, com.aspose.html.internal.ms.System.IDisposable

Direct Known Subclasses:

ImageDevice, PdfDevice, XpsDevice
```
public abstract class Device<TGraphicContext extends GraphicContext,TRenderingOptions extends RenderingOptions>
extends Object
implements IDevice
```
Represents base class for implementation particular rendering devices.
TGraphicContext: Graphic context that holds current graphics control parameters
TRenderingOptions: Rendering options

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Device.DeviceConfiguration` Represents configuration object for devices.
`static class`	`Device.PageWritingStrategy` Specifies types of strategies for writing pages into output stream\streams.

Constructor Summary

Constructors
Constructor and Description
`Device(TRenderingOptions options, InputStream stream)` Initializes a new instance of the `Device{TGraphicContext,TRenderingOptions}` class by rendering options and output stream.
`Device(TRenderingOptions options, OutputStream outputStream)` Initializes a new instance of the `Device{TGraphicContext,TRenderingOptions}` class by rendering options and output stream.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract 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.
`abstract boolean`	`beginElement(Element element, com.aspose.html.internal.ms.System.Drawing.RectangleF rect)` Begins rendering of the html node.
`void`	`beginPage(com.aspose.html.internal.ms.System.Drawing.SizeF size)` Begins rendering of the new page.
`abstract 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.
`abstract void`	`closePath()` Closes the current subpath by appending a straight line segment from the current point to the starting point of the subpath.
`abstract 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`	`dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
`abstract 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.
`abstract void`	`endElement(Element element)` Ends rendering of the html node.
`void`	`endPage()` Ends rendering of the current page.
`abstract void`	`fill(int mode)` Fills the entire region enclosed by the current path.
`abstract 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.
`Document`	`getCurrentDocument()`
`TGraphicContext`	`getGraphicContext()` Gets the graphic context
`TRenderingOptions`	`getOptions()` Gets rendering options.
`com.aspose.html.internal.ms.System.IO.Stream`	`getOriginalOutputStream()`
`int`	`getPageIndex()` Sets or gets the index of the current page
`boolean`	`getRenderingStarted()`
`void`	`initPageBackground(com.aspose.html.internal.ms.System.Drawing.SizeF size)`
`abstract void`	`lineTo(com.aspose.html.internal.ms.System.Drawing.PointF pt)` Appends a straight line segment from the current point to the point (pt).
`abstract 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`	`setCurrentDocument(Document value)`
`void`	`setPageIndex(int value)` Sets or gets the index of the current page
`abstract void`	`stroke()` Strokes a line along the current path.
`abstract void`	`strokeAndFill(int mode)` Strokes and fill current path.
`abstract void`	`strokeText(String text, com.aspose.html.internal.ms.System.Drawing.PointF pt)` Strokes the specified text string at the specified location.

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

- Constructor Detail
  - Device
```
public Device(TRenderingOptions options,
              InputStream stream)
```
    Initializes a new instance of the Device{TGraphicContext,TRenderingOptions} class by rendering options and output stream.
    
    Parameters:
    
    options - Rendering options.
    
    stream - The output stream.
  - Device
```
public Device(TRenderingOptions options,
              OutputStream outputStream)
```
    Initializes a new instance of the Device{TGraphicContext,TRenderingOptions} class by rendering options and output stream.
    
    Parameters:
    
    options - Rendering options.
    
    outputStream - The java.io.OutputStream.
- Method Detail
  - getOptions
```
public TRenderingOptions getOptions()
```
    Gets rendering options.
    
    Specified by:
    
    getOptions in interface IDevice
  - getGraphicContext
```
public TGraphicContext getGraphicContext()
```
    Gets the graphic context
    
    Specified by:
    
    getGraphicContext in interface IDevice
  - getOriginalOutputStream
```
public com.aspose.html.internal.ms.System.IO.Stream getOriginalOutputStream()
```
  - saveGraphicContext
```
public void saveGraphicContext()
```
    Pushes a copy of the entire graphics context onto the stack.
    
    Specified by:
    
    saveGraphicContext in interface IDevice
  - 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
  - getPageIndex
```
public int getPageIndex()
```
    Sets or gets the index of the current page
  - setPageIndex
```
public void setPageIndex(int value)
```
    Sets or gets the index of the current page
  - getCurrentDocument
```
public Document getCurrentDocument()
```
  - setCurrentDocument
```
public void setCurrentDocument(Document value)
```
  - getRenderingStarted
```
public boolean getRenderingStarted()
```
  - beginDocument
```
public void beginDocument(Document document)
```
    Begins rendering of the document.
    
    Specified by:
    
    beginDocument in interface IDevice
    
    Parameters:
    
    document - The document.
  - endDocument
```
public void endDocument()
```
    Ends rendering of the document.
    
    Specified by:
    
    endDocument in interface IDevice
  - 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
    
    Parameters:
    
    size - Size of the page.
  - endPage
```
public void endPage()
```
    Ends rendering of the current page.
    
    Specified by:
    
    endPage in interface IDevice
  - flush
```
public void flush()
```
    Flushes all data to output stream.
    
    Specified by:
    
    flush in interface IDevice
  - beginElement
```
public abstract boolean beginElement(Element element,
                                     com.aspose.html.internal.ms.System.Drawing.RectangleF rect)
```
    Begins rendering of the html node.
    
    Specified by:
    
    beginElement in interface IDevice
    
    Parameters:
    
    element - The html element.
    
    rect - Bounding box of the node.
    
    Returns:
    
    Returns [true] if element should be processed.
  - endElement
```
public abstract void endElement(Element element)
```
    Ends rendering of the html node.
    
    Specified by:
    
    endElement in interface IDevice
    
    Parameters:
    
    element - The html element.
  - closePath
```
public abstract 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
  - moveTo
```
public abstract 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
    
    Parameters:
    
    pt - Point of where to move the path to.
  - lineTo
```
public abstract 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
    
    Parameters:
    
    pt - Point of where to create the line to.
  - addRect
```
public abstract 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
    
    Parameters:
    
    rect - A rectangle to draw.
  - cubicBezierTo
```
public abstract 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
    
    Parameters:
    
    pt1 - Coordinates of first point
    
    pt2 - Coordinates of second point
    
    pt3 - Coordinates of third point
  - stroke
```
public abstract 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
  - fill
```
public abstract 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
    
    Parameters:
    
    mode - Filling mode specifies how the interior of a closed path is filled
  - clip
```
public abstract 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
    
    Parameters:
    
    mode - Filling mode specifies how the interior of a closed path is clipped
  - strokeAndFill
```
public abstract void strokeAndFill(int mode)
```
    Strokes and fill current path. This method terminates current path.
    
    Specified by:
    
    strokeAndFill in interface IDevice
    
    Parameters:
    
    mode - Filling mode specifies how the interior of a closed path is filled.
  - fillText
```
public abstract 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
    
    Parameters:
    
    text - String to fill.
    
    pt - Point that specifies the coordinates of the text.
  - strokeText
```
public abstract 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
    
    Parameters:
    
    text - String to stroke.
    
    pt - Point that specifies the coordinates where to start the text.
  - drawImage
```
public abstract 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
    
    Parameters:
    
    data - An array of bytes representing the image.
    
    type - Image type.
    
    rect - A rectangel which determines position and size to draw.
  - dispose
```
public void dispose()
```
    Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
    
    Specified by:
    
    dispose in interface com.aspose.html.internal.ms.System.IDisposable
  - initPageBackground
```
public void initPageBackground(com.aspose.html.internal.ms.System.Drawing.SizeF size)
```

Packages

com.aspose.html.rendering

Interfaces

Classes

Class Device<TGraphicContext extends GraphicContext,TRenderingOptions extends RenderingOptions>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Device

Device

Method Detail

getOptions

getGraphicContext

getOriginalOutputStream

saveGraphicContext

restoreGraphicContext

getPageIndex

setPageIndex

getCurrentDocument

setCurrentDocument

getRenderingStarted

beginDocument

endDocument

beginPage

endPage

flush

beginElement

endElement

closePath

moveTo

lineTo

addRect

cubicBezierTo

stroke

fill

clip

strokeAndFill

fillText

strokeText

drawImage

dispose

initPageBackground