com.aspose.words

Class OfficeMathRenderer

public class OfficeMathRenderer 
extends NodeRendererBase

Provides methods to render an individual OfficeMath to a raster or vector image or to a Graphics object.

Constructor Summary
OfficeMathRenderer(OfficeMath math)
Initializes a new instance of this class.
 
Property Getters/Setters Summary
java.awt.geom.Rectangle2D.FloatgetBoundsInPoints()
Gets the actual bounds of the shape in points.
java.awt.geom.Rectangle2D.FloatgetOpaqueBoundsInPoints()
Gets the opaque bounds of the shape in points.
java.awt.DimensiongetSizeInPoints()
Gets the actual size of the shape in points.
 
Method Summary
java.awt.RectanglegetBoundsInPixels(float scale, float dpi)
Calculates the bounds of the shape in pixels for a specified zoom factor and resolution.
java.awt.RectanglegetBoundsInPixels(float scale, float horizontalDpi, float verticalDpi)
Calculates the bounds of the shape in pixels for a specified zoom factor and resolution.
java.awt.RectanglegetOpaqueBoundsInPixels(float scale, float dpi)
Calculates the opaque bounds of the shape in pixels for a specified zoom factor and resolution.
java.awt.RectanglegetOpaqueBoundsInPixels(float scale, float horizontalDpi, float verticalDpi)
Calculates the opaque bounds of the shape in pixels for a specified zoom factor and resolution.
java.awt.DimensiongetSizeInPixels(float scale, float dpi)
Calculates the size of the shape in pixels for a specified zoom factor and resolution.
java.awt.DimensiongetSizeInPixels(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.FloatrenderToScale(java.awt.Graphics2D graphics, float x, float y, float scale)
Renders the shape into a java.awt.Graphics2D object to a specified scale.
floatrenderToSize(java.awt.Graphics2D graphics, float x, float y, float width, float height)
Renders the shape into a java.awt.Graphics2D object to a specified size.
voidsave(java.io.OutputStream stream, ImageSaveOptions saveOptions)
Renders the shape into an image and saves into a stream.
voidsave(java.lang.String fileName, ImageSaveOptions saveOptions)
Renders the shape into an image and saves into a file.
 

    • Constructor Detail

      • OfficeMathRenderer

        public OfficeMathRenderer(OfficeMath math)
                           throws java.lang.Exception
        Initializes a new instance of this class.
        Parameters:
        math - The OfficeMath object that you want to render.
    • Property Getters/Setters Detail

      • 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).

      • getOpaqueBoundsInPoints

        public java.awt.geom.Rectangle2D.Float getOpaqueBoundsInPoints()
        
        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.

      • getSizeInPoints

        public java.awt.Dimension 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).

    • Method Detail

      • 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 BoundsInPoints 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 BoundsInPoints 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 OpaqueBoundsInPoints 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.
      • 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 OpaqueBoundsInPoints 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.
      • 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 SizeInPoints 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 SizeInPoints 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.
      • 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 java.awt.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.
      • 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 java.awt.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.
      • save

        public void save(java.io.OutputStream stream, ImageSaveOptions saveOptions)
                 throws java.lang.Exception
        Renders the shape into an image and saves into a stream.
        Parameters:
        stream - The stream where to save the image of the shape.
        saveOptions - Specifies the options that control how the shape is rendered and saved. Can be null. If this is null, the image will be saved in the PNG format.
      • save

        public void save(java.lang.String fileName, ImageSaveOptions saveOptions)
                 throws java.lang.Exception
        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.

        Example:

        Shows how to convert specific object into image
        Document doc = new Document(getMyDir() + "Shape.OfficeMath.docx");
        
        //Get OfficeMath node from the document and render this as image (you can also do the same with the Shape node)
        OfficeMath math = (OfficeMath) doc.getChild(NodeType.OFFICE_MATH, 0, true);
        math.getMathRenderer().save(getMyDir() + "\\Artifacts\\Shape.OfficeMath.svg", new ImageSaveOptions(SaveFormat.SVG));