com.aspose.words

Class NodeRendererBase

java.lang.Object

com.aspose.words.NodeRendererBase

Direct Known Subclasses:

OfficeMathRenderer, ShapeRenderer

public abstract class NodeRendererBase
extends java.lang.Object

Base class for ShapeRenderer and OfficeMathRenderer.

Constructor Summary

Constructors

Constructor and Description
NodeRendererBase()

Method Summary

Modifier and Type	Method and Description
java.awt.Rectangle	getBoundsInPixels(float scale, float dpi) Calculates the bounds of the shape in pixels for a specified zoom factor and resolution.
java.awt.Rectangle	getBoundsInPixels(float scale, float horizontalDpi, float verticalDpi) Calculates the bounds of the shape in pixels for a specified zoom factor and resolution.
java.awt.geom.Rectangle2D.Float	getBoundsInPoints() Gets the actual bounds of the shape in points.
java.awt.Rectangle	getOpaqueBoundsInPixels(float scale, float dpi) Calculates the opaque bounds of the shape in pixels for a specified zoom factor and resolution.
java.awt.Rectangle	getOpaqueBoundsInPixels(float scale, float horizontalDpi, float verticalDpi) Calculates the opaque bounds of the shape in pixels for a specified zoom factor and resolution.
java.awt.geom.Rectangle2D.Float	getOpaqueBoundsInPoints() Gets the opaque bounds of the shape in points.
java.awt.Dimension	getSizeInPixels(float scale, float dpi) Calculates the size of the shape in pixels for a specified zoom factor and resolution.
java.awt.Dimension	getSizeInPixels(float scale, float horizontalDpi, float verticalDpi) Calculates the size of the shape in pixels for a specified zoom factor and resolution.
java.awt.geom.Point2D.Float	getSizeInPoints() Gets the actual size of the shape in points.
java.awt.geom.Point2D.Float	renderToScale(java.awt.Graphics2D graphics, float x, float y, float scale) Renders the shape into a Graphics2D object to a specified scale.
float	renderToSize(java.awt.Graphics2D graphics, float x, float y, float width, float height) Renders the shape into a Graphics2D object to a specified size.
void	save(java.io.OutputStream stream, ImageSaveOptions saveOptions)
void	save(java.lang.String fileName, ImageSaveOptions saveOptions) Renders the shape and saves into an image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NodeRendererBase

public NodeRendererBase()

Method Detail

getSizeInPoints

public java.awt.geom.Point2D.Float getSizeInPoints()

Gets the actual size of the shape in points.

This property returns the size of the actual (as rendered on the page) bounding box of the shape. The size takes into account shape rotation (if any).

Returns:

The actual size of the shape in points.

getBoundsInPoints

public java.awt.geom.Rectangle2D.Float getBoundsInPoints()

Gets the actual bounds of the shape in points.

This property returns the actual (as rendered on the page) bounding box of the shape. The bounds takes into account shape rotation (if any).

Returns:

The actual bounds of the shape in points.

getOpaqueBoundsInPoints

public java.awt.geom.Rectangle2D.Float getOpaqueBoundsInPoints()
                                                        throws java.lang.Exception

Gets the opaque bounds of the shape in points.

This property returns the opaque (i.e. transparent parts of the shape are ignored) bounding box of the shape. The bounds takes the shape rotation into account.

Returns:

The opaque bounds of the shape in points.

Throws:

java.lang.Exception

getSizeInPixels

public java.awt.Dimension getSizeInPixels(float scale,
                                          float dpi)

Calculates the size of the shape in pixels for a specified zoom factor and resolution.

This method converts getSizeInPoints() into size in pixels and it is useful when you want to create a bitmap for rendering the shape neatly onto the bitmap.

Parameters:

scale - The zoom factor (1.0 is 100%).

dpi - The resolution (horizontal and vertical) to convert from points to pixels (dots per inch).

Returns:

The size of the shape in pixels.

getSizeInPixels

public java.awt.Dimension getSizeInPixels(float scale,
                                          float horizontalDpi,
                                          float verticalDpi)

Calculates the size of the shape in pixels for a specified zoom factor and resolution.

This method converts getSizeInPoints() into size in pixels and it is useful when you want to create a bitmap for rendering the shape neatly onto the bitmap.

Parameters:

scale - The zoom factor (1.0 is 100%).

horizontalDpi - The horizontal resolution to convert from points to pixels (dots per inch).

verticalDpi - The vertical resolution to convert from points to pixels (dots per inch).

Returns:

The size of the shape in pixels.

getBoundsInPixels

public java.awt.Rectangle getBoundsInPixels(float scale,
                                            float dpi)

Calculates the bounds of the shape in pixels for a specified zoom factor and resolution.

This method converts getBoundsInPoints() into rectangle in pixels.

Parameters:

scale - The zoom factor (1.0 is 100%).

dpi - The resolution (horizontal and vertical) to convert from points to pixels (dots per inch).

Returns:

The actual (as rendered on the page) bounding box of the shape in pixels.

getBoundsInPixels

public java.awt.Rectangle getBoundsInPixels(float scale,
                                            float horizontalDpi,
                                            float verticalDpi)

Calculates the bounds of the shape in pixels for a specified zoom factor and resolution.

This method converts getBoundsInPoints() into rectangle in pixels.

Parameters:

scale - The zoom factor (1.0 is 100%).

horizontalDpi - The horizontal resolution to convert from points to pixels (dots per inch).

verticalDpi - The vertical resolution to convert from points to pixels (dots per inch).

Returns:

The actual (as rendered on the page) bounding box of the shape in pixels.

getOpaqueBoundsInPixels

public java.awt.Rectangle getOpaqueBoundsInPixels(float scale,
                                                  float dpi)
                                           throws java.lang.Exception

Calculates the opaque bounds of the shape in pixels for a specified zoom factor and resolution.

This method converts getOpaqueBoundsInPoints() into rectangle in pixels and it is useful when you want to create a bitmap for rendering the shape with only opaque part of the shape.

Parameters:

scale - The zoom factor (1.0 is 100%).

dpi - The resolution to convert from points to pixels (dots per inch).

Returns:

The opaque rectangle of the shape in pixels.

Throws:

java.lang.Exception

getOpaqueBoundsInPixels

public java.awt.Rectangle getOpaqueBoundsInPixels(float scale,
                                                  float horizontalDpi,
                                                  float verticalDpi)
                                           throws java.lang.Exception

Calculates the opaque bounds of the shape in pixels for a specified zoom factor and resolution.

This method converts getOpaqueBoundsInPoints() into rectangle in pixels and it is useful when you want to create a bitmap for rendering the shape with only opaque part of the shape.

Parameters:

scale - The zoom factor (1.0 is 100%).

horizontalDpi - The horizontal resolution to convert from points to pixels (dots per inch).

verticalDpi - The vertical resolution to convert from points to pixels (dots per inch).

Returns:

The opaque rectangle of the shape in pixels.

Throws:

java.lang.Exception

renderToScale

public java.awt.geom.Point2D.Float renderToScale(java.awt.Graphics2D graphics,
                                                 float x,
                                                 float y,
                                                 float scale)
                                          throws java.lang.Exception

Renders the shape into a Graphics2D object to a specified scale.

Parameters:

graphics - The object where to render to.

x - The X coordinate (in world units) of the top left corner of the rendered shape.

y - The Y coordinate (in world units) of the top left corner of the rendered shape.

scale - The scale for rendering the shape (1.0 is 100%).

Returns:

The width and height (in world units) of the rendered shape.

Throws:

java.lang.Exception

renderToSize

public float renderToSize(java.awt.Graphics2D graphics,
                          float x,
                          float y,
                          float width,
                          float height)
                   throws java.lang.Exception

Renders the shape into a Graphics2D object to a specified size.

Parameters:

graphics - The object where to render to.

x - The X coordinate (in world units) of the top left corner of the rendered shape.

y - The Y coordinate (in world units) of the top left corner of the rendered shape.

width - The maximum width (in world units) that can be occupied by the rendered shape.

height - The maximum height (in world units) that can be occupied by the rendered shape.

Returns:

The scale that was automatically calculated for the rendered shape to fit the specified size.

Throws:

java.lang.Exception

save

public void save(java.lang.String fileName,
                 ImageSaveOptions saveOptions)
          throws java.lang.Exception

Renders the shape and saves into an image. Renders the shape into an image and saves into a file.

Parameters:

fileName - The name for the image file. If a file with the specified name already exists, the existing file is overwritten.

saveOptions - Specifies the options that control how the shape is rendered and saved. Can be null.

Throws:

java.lang.Exception

save

public void save(java.io.OutputStream stream,
                 ImageSaveOptions saveOptions)
          throws java.lang.Exception

Throws:

java.lang.Exception