PageAPI (Aspose.Page for Java (25.11) API Documentation)

java.lang.Object
- com.aspose.xps.features.EventBasedModifications.PageAPI

All Implemented Interfaces:

IModificationAPI
```
public class PageAPI
extends Object
implements IModificationAPI
```
The Page element modification API.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends XpsContentElement> T`	`add(T element)` Adds a content element (Canvas, Path, or Glyphs)
`XpsCanvas`	`addCanvas()` Adds a new canvas to the page.
`XpsGlyphs`	`addGlyphs(String fontFamily, float fontRenderingEmSize, XpsFontStyle fontStyle, float originX, float originY, String unicodeString)` Adds new glyphs to the page.
`XpsGlyphs`	`addGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, String unicodeString)` Adds new glyphs to the page.
`void`	`addOutlineEntry(String description, int outlineLevel, int targetPageNumber)` Adds an outline entry to the document.
`XpsPath`	`addPath(XpsPathGeometry data)` Adds a new path to the page.
`XpsArcSegment`	`createArcSegment(Point2D point, Dimension2D size, float rotationAngle, boolean isLargeArc, XpsSweepDirection sweepDirection)` Creates a new stroked elliptical arc segment.
`XpsArcSegment`	`createArcSegment(Point2D point, Dimension2D size, float rotationAngle, boolean isLargeArc, XpsSweepDirection sweepDirection, boolean isStroked)` Creates a new elliptical arc segment.
`XpsCanvas`	`createCanvas()` Creates a new canvas.
`XpsColor`	`createColor(Color color)` Creates a new color.
`XpsColor`	`createColor(float r, float g, float b)` Creates a new color in scRGB color space.
`XpsColor`	`createColor(float a, float r, float g, float b)` Creates a new color in scRGB color space.
`XpsColor`	`createColor(int r, int g, int b)` Creates a new color in sRGB color space.
`XpsColor`	`createColor(int a, int r, int g, int b)` Creates a new color in sRGB color space.
`XpsColor`	`createColor(String path, float... components)` Creates a new color in ICC based color space.
`XpsColor`	`createColor(XpsIccProfile iccProfile, float... components)` Creates a new color in ICC based color space.
`XpsGlyphs`	`createGlyphs(String fontFamily, float fontRenderingEmSize, XpsFontStyle fontStyle, float originX, float originY, String unicodeString)` Creates new glyphs.
`XpsGlyphs`	`createGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, String unicodeString)` Creates new glyphs.
`XpsGradientStop`	`createGradientStop(Color color, float offset)` Creates a new gradient stop.
`XpsGradientStop`	`createGradientStop(XpsColor color, float offset)` Creates a new gradient stop.
`XpsImageBrush`	`createImageBrush(String imagePath, Rectangle2D viewbox, Rectangle2D viewport)` Creates a new image brush.
`XpsImageBrush`	`createImageBrush(XpsImage image, Rectangle2D viewbox, Rectangle2D viewport)` Creates a new image brush.
`XpsLinearGradientBrush`	`createLinearGradientBrush(List<XpsGradientStop> gradientStops, Point2D startPoint, Point2D endPoint)` Creates a new linear gradient brush.
`XpsLinearGradientBrush`	`createLinearGradientBrush(Point2D startPoint, Point2D endPoint)` Creates a new linear gradient brush.
`XpsMatrix`	`createMatrix(float m11, float m12, float m21, float m22, float m31, float m32)` Creates a new affine transformation matrix.
`XpsPath`	`createPath(XpsPathGeometry data)` Creates a new path.
`XpsPathFigure`	`createPathFigure(Point2D startPoint)` Creates a new open path figure.
`XpsPathFigure`	`createPathFigure(Point2D startPoint, boolean isClosed)` Creates a new path figure.
`XpsPathFigure`	`createPathFigure(Point2D startPoint, List<XpsPathSegment> segments)` Creates a new open path figure.
`XpsPathFigure`	`createPathFigure(Point2D startPoint, List<XpsPathSegment> segments, boolean isClosed)` Creates a new path figure.
`XpsPathGeometry`	`createPathGeometry()` Creates a new path geometry.
`XpsPathGeometry`	`createPathGeometry(List<XpsPathFigure> pathFigures)` Creates a new path geometry with specified list of path figures.
`XpsPathGeometry`	`createPathGeometry(String abbreviatedGeometry)` Creates a new path geometry specified with abbreviated form.
`XpsPolyBezierSegment`	`createPolyBezierSegment(Point2D[] points)` Creates a new set of stroked cubic Bézier curves.
`XpsPolyBezierSegment`	`createPolyBezierSegment(Point2D[] points, boolean isStroked)` Creates a new set of cubic Bézier curves.
`XpsPolyLineSegment`	`createPolyLineSegment(Point2D[] points)` Creates a new stroked polygonal drawing containing an arbitrary number of individual vertices.
`XpsPolyLineSegment`	`createPolyLineSegment(Point2D[] points, boolean isStroked)` Creates a new polygonal drawing containing an arbitrary number of individual vertices.
`XpsPolyQuadraticBezierSegment`	`createPolyQuadraticBezierSegment(Point2D[] points)` Creates a new set of stroked quadratic Bézier curves from the previous point in the path figure through a set of vertices, using specified control points.
`XpsPolyQuadraticBezierSegment`	`createPolyQuadraticBezierSegment(Point2D[] points, boolean isStroked)` Creates a new set of quadratic Bézier curves from the previous point in the path figure through a set of vertices, using specified control points.
`XpsRadialGradientBrush`	`createRadialGradientBrush(List<XpsGradientStop> gradientStops, Point2D center, Point2D gradientOrigin, float radiusX, float radiusY)` Creates a new radial gradient brush.
`XpsRadialGradientBrush`	`createRadialGradientBrush(Point2D center, Point2D gradientOrigin, float radiusX, float radiusY)` Creates a new radial gradient brush.
`XpsSolidColorBrush`	`createSolidColorBrush(Color color)` Creates a new solid color brush.
`XpsSolidColorBrush`	`createSolidColorBrush(XpsColor color)` Creates a new solid color brush.
`XpsVisualBrush`	`createVisualBrush(XpsContentElement element, Rectangle2D viewbox, Rectangle2D viewport)` Creates a new visual brush.
`float`	`getHeight()` Returns the height of the page, expressed as a real number in units of the effective coordinate space.
`int`	`getPageCount()` Returns the number of pages in the active document.
`int`	`getTotalPageCount()` Returns the total number of pages in all documents inside XPS document.
`DocumentUtils`	`getUtils()` Gets the object that provides utilities beyond the formal XPS manipulation API.
`float`	`getWidth()` Returns the width of the page, expressed as a real number in units of the effective coordinate space.
`<T extends XpsContentElement> T`	`insert(int index, T element)` Inserts an element (Canvas, Path, or Glyphs) to the page at `index` position.
`XpsCanvas`	`insertCanvas(int index)` Inserts a new canvas to the page at `index` position.
`XpsGlyphs`	`insertGlyphs(int index, String fontFamily, float fontSize, XpsFontStyle fontStyle, float originX, float originY, String unicodeString)` Inserts new glyphs to the page at `index` position.
`XpsGlyphs`	`insertGlyphs(int index, XpsFont font, float fontSize, float originX, float originY, String unicodeString)` Inserts new glyphs to the page at `index` position.
`XpsPath`	`insertPath(int index, XpsPathGeometry data)` Inserts a new path to the page at `index` position.
`<T extends XpsContentElement> T`	`remove(T element)` Removes an element from the page.
`XpsContentElement`	`removeAt(int index)` Removes an element at `index` position from the page.
`void`	`setHeight(float value)` Sets the height of the page, expressed as a real number in units of the effective coordinate space.
`void`	`setWidth(float value)` Sets the width of the page, expressed as a real number in units of the effective coordinate space.

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

- Method Detail
  - getUtils
```
public DocumentUtils getUtils()
```
    Gets the object that provides utilities beyond the formal XPS manipulation API.
    
    Returns:
    
    The object that provides utilities beyond the formal XPS manipulation API.
  - getTotalPageCount
```
public int getTotalPageCount()
```
    Returns the total number of pages in all documents inside XPS document.
    
    Returns:
    
    The total number of pages in all documents inside XPS document.
  - getPageCount
```
public int getPageCount()
```
    Returns the number of pages in the active document.
    
    Returns:
    
    The number of pages in the active document.
  - getHeight
```
public float getHeight()
```
    Returns the height of the page, expressed as a real number in units of the effective coordinate space.
    
    Returns:
    
    The height of the page.
  - setHeight
```
public void setHeight(float value)
```
    Sets the height of the page, expressed as a real number in units of the effective coordinate space.
    
    Parameters:
    
    value - The height of the page.
  - getWidth
```
public float getWidth()
```
    Returns the width of the page, expressed as a real number in units of the effective coordinate space.
    
    Returns:
    
    The width of the page.
  - setWidth
```
public void setWidth(float value)
```
    Sets the width of the page, expressed as a real number in units of the effective coordinate space.
    
    Parameters:
    
    value - The width of the page.
  - add
```
public <T extends XpsContentElement> T add(T element)
```
    Adds a content element (Canvas, Path, or Glyphs)
    
    Type Parameters:
    
    T - The type of the element to add.
    
    Parameters:
    
    element - The element to add.
    
    Returns:
    
    Added element.
  - insert
```
public <T extends XpsContentElement> T insert(int index,
                                              T element)
```
    Inserts an element (Canvas, Path, or Glyphs) to the page at index position.
    
    Type Parameters:
    
    T - The type of the element to insert.
    
    Parameters:
    
    index - Position at which an element should be inserted.
    
    element - The element to insert.
    
    Returns:
    
    Inserted element.
  - remove
```
public <T extends XpsContentElement> T remove(T element)
```
    Removes an element from the page.
    
    Type Parameters:
    
    T - The type of the element to remove.
    
    Parameters:
    
    element - The element to remove.
    
    Returns:
    
    Removed element.
  - removeAt
```
public XpsContentElement removeAt(int index)
```
    Removes an element at index position from the page.
    
    Parameters:
    
    index - Position at which element should be removed.
    
    Returns:
    
    Removed element.
  - createCanvas
```
public XpsCanvas createCanvas()
```
    Creates a new canvas.
    
    Returns:
    
    New canvas.
  - addCanvas
```
public XpsCanvas addCanvas()
```
    Adds a new canvas to the page.
    
    Returns:
    
    Added canvas.
  - insertCanvas
```
public XpsCanvas insertCanvas(int index)
```
    Inserts a new canvas to the page at index position.
    
    Parameters:
    
    index - Position at which a new canvas should be inserted.
    
    Returns:
    
    Inserted canvas.
  - createPath
```
public XpsPath createPath(XpsPathGeometry data)
```
    Creates a new path.
    
    Parameters:
    
    data - The geometry of the path.
    
    Returns:
    
    New path.
  - addPath
```
public XpsPath addPath(XpsPathGeometry data)
```
    Adds a new path to the page.
    
    Parameters:
    
    data - The geometry of the path.
    
    Returns:
    
    Added path.
  - insertPath
```
public XpsPath insertPath(int index,
                          XpsPathGeometry data)
```
    Inserts a new path to the page at index position.
    
    Parameters:
    
    index - Position at which a new path should be inserted.
    
    data - The geometry of the path.
    
    Returns:
    
    Inserted path.
  - createGlyphs
```
public XpsGlyphs createGlyphs(String fontFamily,
                              float fontRenderingEmSize,
                              XpsFontStyle fontStyle,
                              float originX,
                              float originY,
                              String unicodeString)
```
    Creates new glyphs.
    
    Parameters:
    
    fontFamily - Font family.
    
    fontRenderingEmSize - Font size.
    
    fontStyle - Font style.
    
    originX - Glyphs origin X coordinate.
    
    originY - Glyphs origin Y coordinate.
    
    unicodeString - String to be printed.
    
    Returns:
    
    New glyphs.
  - createGlyphs
```
public XpsGlyphs createGlyphs(XpsFont font,
                              float fontRenderingEmSize,
                              float originX,
                              float originY,
                              String unicodeString)
```
    Creates new glyphs.
    
    Parameters:
    
    font - Font resource.
    
    fontRenderingEmSize - Font size.
    
    originX - Glyphs origin X coordinate.
    
    originY - Glyphs origin Y coordinate.
    
    unicodeString - String to be printed.
    
    Returns:
    
    New glyphs.
  - addGlyphs
```
public XpsGlyphs addGlyphs(String fontFamily,
                           float fontRenderingEmSize,
                           XpsFontStyle fontStyle,
                           float originX,
                           float originY,
                           String unicodeString)
```
    Adds new glyphs to the page.
    
    Parameters:
    
    fontFamily - Font family.
    
    fontRenderingEmSize - Font size.
    
    fontStyle - Font style.
    
    originX - Glyphs origin X coordinate.
    
    originY - Glyphs origin Y coordinate.
    
    unicodeString - String to be printed.
    
    Returns:
    
    Added glyphs.
  - insertGlyphs
```
public XpsGlyphs insertGlyphs(int index,
                              String fontFamily,
                              float fontSize,
                              XpsFontStyle fontStyle,
                              float originX,
                              float originY,
                              String unicodeString)
```
    Inserts new glyphs to the page at index position.
    
    Parameters:
    
    index - Position at which new glyphs should be inserted.
    
    fontFamily - Font family.
    
    fontSize - Font size.
    
    fontStyle - Font style.
    
    originX - Glyphs origin X coordinate.
    
    originY - Glyphs origin Y coordinate.
    
    unicodeString - String to be printed.
    
    Returns:
    
    Inserted glyphs.
  - addGlyphs
```
public XpsGlyphs addGlyphs(XpsFont font,
                           float fontRenderingEmSize,
                           float originX,
                           float originY,
                           String unicodeString)
```
    Adds new glyphs to the page.
    
    Parameters:
    
    font - Font resource.
    
    fontRenderingEmSize - Font size.
    
    originX - Glyphs origin X coordinate.
    
    originY - Glyphs origin Y coordinate.
    
    unicodeString - String to be printed.
    
    Returns:
    
    Added glyphs.
  - insertGlyphs
```
public XpsGlyphs insertGlyphs(int index,
                              XpsFont font,
                              float fontSize,
                              float originX,
                              float originY,
                              String unicodeString)
```
    Inserts new glyphs to the page at index position.
    
    Parameters:
    
    index - Position at which new glyphs should be inserted.
    
    font - Font resource.
    
    fontSize - Font size.
    
    originX - Glyphs origin X coordinate.
    
    originY - Glyphs origin Y coordinate.
    
    unicodeString - String to be printed.
    
    Returns:
    
    Inserted glyphs.
  - createMatrix
```
public XpsMatrix createMatrix(float m11,
                              float m12,
                              float m21,
                              float m22,
                              float m31,
                              float m32)
```
    Creates a new affine transformation matrix.
    
    Parameters:
    
    m11 - Element 11.
    
    m12 - Element 12.
    
    m21 - Element 21.
    
    m22 - Element 22.
    
    m31 - Element 31.
    
    m32 - Element 32.
    
    Returns:
    
    New affine transformation matrix.
  - createPathGeometry
```
public XpsPathGeometry createPathGeometry(String abbreviatedGeometry)
```
    Creates a new path geometry specified with abbreviated form.
    
    Parameters:
    
    abbreviatedGeometry - Abbreviated form of path geometry.
    
    Returns:
    
    New path geometry.
  - createPathGeometry
```
public XpsPathGeometry createPathGeometry()
```
    Creates a new path geometry.
    
    Returns:
    
    New path geometry.
  - createPathGeometry
```
public XpsPathGeometry createPathGeometry(List<XpsPathFigure> pathFigures)
```
    Creates a new path geometry with specified list of path figures.
    
    Parameters:
    
    pathFigures - List of path figures.
    
    Returns:
    
    New path geometry.
  - createPathFigure
```
public XpsPathFigure createPathFigure(Point2D startPoint)
```
    Creates a new open path figure.
    
    Parameters:
    
    startPoint - The starting point for the first segment of the path figure.
    
    Returns:
    
    New path figure.
  - createPathFigure
```
public XpsPathFigure createPathFigure(Point2D startPoint,
                                      boolean isClosed)
```
    Creates a new path figure.
    
    Parameters:
    
    startPoint - The starting point for the first segment of the path figure.
    
    isClosed - Specifies whether the path is closed. If set to true, the stroke is drawn "closed", that is, the last point in the last segment of the path figure is connected with the point specified in the StartPoint attribute, otherwise the stroke is drawn "open", and the last point is not connected to the start point. Only applicable if the path figure is used in a Path element that specifies a stroke.
    
    Returns:
    
    New path figure.
  - createPathFigure
```
public XpsPathFigure createPathFigure(Point2D startPoint,
                                      List<XpsPathSegment> segments)
```
    Creates a new open path figure.
    
    Parameters:
    
    startPoint - The starting point for the first segment of the path figure.
    
    segments - List of path segments.
    
    Returns:
    
    New path figure.
  - createPathFigure
```
public XpsPathFigure createPathFigure(Point2D startPoint,
                                      List<XpsPathSegment> segments,
                                      boolean isClosed)
```
    Creates a new path figure.
    
    Parameters:
    
    startPoint - The starting point for the first segment of the path figure.
    
    segments - List of path segments.
    
    isClosed - Specifies whether the path is closed. If set to true, the stroke is drawn "closed", that is, the last point in the last segment of the path figure is connected with the point specified in the StartPoint attribute, otherwise the stroke is drawn "open", and the last point is not connected to the start point. Only applicable if the path figure is used in a Path element that specifies a stroke.
    
    Returns:
    
    New path figure.
  - createArcSegment
```
public XpsArcSegment createArcSegment(Point2D point,
                                      Dimension2D size,
                                      float rotationAngle,
                                      boolean isLargeArc,
                                      XpsSweepDirection sweepDirection)
```
    Creates a new stroked elliptical arc segment.
    
    Parameters:
    
    point - The end point of the elliptical arc.
    
    size - The x and y radius of the elliptical arc as an x,y pair.
    
    rotationAngle - Indicates how the ellipse is rotated relative to the current coordinate system.
    
    isLargeArc - Determines whether the arc is drawn with a sweep of 180 or greater.
    
    sweepDirection - The direction in which the arc is drawn.
    
    Returns:
    
    New elliptical arc segment.
  - createArcSegment
```
public XpsArcSegment createArcSegment(Point2D point,
                                      Dimension2D size,
                                      float rotationAngle,
                                      boolean isLargeArc,
                                      XpsSweepDirection sweepDirection,
                                      boolean isStroked)
```
    Creates a new elliptical arc segment.
    
    Parameters:
    
    point - The end point of the elliptical arc.
    
    size - The x and y radius of the elliptical arc as an x,y pair.
    
    rotationAngle - Indicates how the ellipse is rotated relative to the current coordinate system.
    
    isLargeArc - Determines whether the arc is drawn with a sweep of 180 or greater.
    
    sweepDirection - The direction in which the arc is drawn.
    
    isStroked - Specifies whether the stroke for this segment of the path is drawn.
    
    Returns:
    
    New elliptical arc segment.
  - createPolyLineSegment
```
public XpsPolyLineSegment createPolyLineSegment(Point2D[] points)
```
    Creates a new stroked polygonal drawing containing an arbitrary number of individual vertices.
    
    Parameters:
    
    points - A set of coordinates for the multiple segments that define the poly line segment.
    
    Returns:
    
    New polygonal drawing segment.
  - createPolyLineSegment
```
public XpsPolyLineSegment createPolyLineSegment(Point2D[] points,
                                                boolean isStroked)
```
    Creates a new polygonal drawing containing an arbitrary number of individual vertices.
    
    Parameters:
    
    points - A set of coordinates for the multiple segments that define the poly line segment.
    
    isStroked - Specifies whether the stroke for this segment of the path is drawn.
    
    Returns:
    
    New polygonal drawing segment.
  - createPolyBezierSegment
```
public XpsPolyBezierSegment createPolyBezierSegment(Point2D[] points)
```
    Creates a new set of stroked cubic Bézier curves.
    
    Parameters:
    
    points - Control points for multiple Bézier segments.
    
    Returns:
    
    New cubic Bézier curves segment.
  - createPolyBezierSegment
```
public XpsPolyBezierSegment createPolyBezierSegment(Point2D[] points,
                                                    boolean isStroked)
```
    Creates a new set of cubic Bézier curves.
    
    Parameters:
    
    points - Control points for multiple Bézier segments.
    
    isStroked - Specifies whether the stroke for this segment of the path is drawn.
    
    Returns:
    
    New cubic Bézier curves segment.
  - createPolyQuadraticBezierSegment
```
public XpsPolyQuadraticBezierSegment createPolyQuadraticBezierSegment(Point2D[] points)
```
    Creates a new set of stroked quadratic Bézier curves from the previous point in the path figure through a set of vertices, using specified control points.
    
    Parameters:
    
    points - Control points for multiple quadratic Bézier segments.
    
    Returns:
    
    New quadratic Bézier curves segment.
  - createPolyQuadraticBezierSegment
```
public XpsPolyQuadraticBezierSegment createPolyQuadraticBezierSegment(Point2D[] points,
                                                                      boolean isStroked)
```
    Creates a new set of quadratic Bézier curves from the previous point in the path figure through a set of vertices, using specified control points.
    
    Parameters:
    
    points - Control points for multiple quadratic Bézier segments.
    
    isStroked - Specifies whether the stroke for this segment of the path is drawn.
    
    Returns:
    
    New quadratic Bézier curves segment.
  - createSolidColorBrush
```
public XpsSolidColorBrush createSolidColorBrush(XpsColor color)
```
    Creates a new solid color brush.
    
    Parameters:
    
    color - The color for filled elements.
    
    Returns:
    
    New solid color brush.
  - createSolidColorBrush
```
public XpsSolidColorBrush createSolidColorBrush(Color color)
```
    Creates a new solid color brush.
    
    Parameters:
    
    color - The color for filled elements.
    
    Returns:
    
    New solid color brush.
  - createGradientStop
```
public XpsGradientStop createGradientStop(XpsColor color,
                                          float offset)
```
    Creates a new gradient stop.
    
    Parameters:
    
    color - The gradient stop color.
    
    offset - The gradient offset.
    
    Returns:
    
    New gradient stop.
  - createGradientStop
```
public XpsGradientStop createGradientStop(Color color,
                                          float offset)
```
    Creates a new gradient stop.
    
    Parameters:
    
    color - The gradient stop color.
    
    offset - The gradient offset.
    
    Returns:
    
    New gradient stop.
  - createLinearGradientBrush
```
public XpsLinearGradientBrush createLinearGradientBrush(List<XpsGradientStop> gradientStops,
                                                        Point2D startPoint,
                                                        Point2D endPoint)
```
    Creates a new linear gradient brush.
    
    Parameters:
    
    gradientStops - The list of gradient stops.
    
    startPoint - The starting point of the linear gradient.
    
    endPoint - The end point of the linear gradient.
    
    Returns:
    
    New linear gradient brush.
  - createLinearGradientBrush
```
public XpsLinearGradientBrush createLinearGradientBrush(Point2D startPoint,
                                                        Point2D endPoint)
```
    Creates a new linear gradient brush.
    
    Parameters:
    
    startPoint - The starting point of the linear gradient.
    
    endPoint - The end point of the linear gradient.
    
    Returns:
    
    New linear gradient brush.
  - createRadialGradientBrush
```
public XpsRadialGradientBrush createRadialGradientBrush(List<XpsGradientStop> gradientStops,
                                                        Point2D center,
                                                        Point2D gradientOrigin,
                                                        float radiusX,
                                                        float radiusY)
```
    Creates a new radial gradient brush.
    
    Parameters:
    
    gradientStops - The list of gradient stops.
    
    center - The center point of the radial gradient (that is, the center of the ellipse).
    
    gradientOrigin - The origin point of the radial gradient.
    
    radiusX - The radius in the x dimension of the ellipse which defines the radial gradient.
    
    radiusY - The radius in the y dimension of the ellipse which defines the radial gradient.
    
    Returns:
    
    New radial gradient brush.
  - createRadialGradientBrush
```
public XpsRadialGradientBrush createRadialGradientBrush(Point2D center,
                                                        Point2D gradientOrigin,
                                                        float radiusX,
                                                        float radiusY)
```
    Creates a new radial gradient brush.
    
    Parameters:
    
    center - The center point of the radial gradient (that is, the center of the ellipse).
    
    gradientOrigin - The origin point of the radial gradient.
    
    radiusX - The radius in the x dimension of the ellipse which defines the radial gradient.
    
    radiusY - The radius in the y dimension of the ellipse which defines the radial gradient.
    
    Returns:
    
    New radial gradient brush.
  - createVisualBrush
```
public XpsVisualBrush createVisualBrush(XpsContentElement element,
                                        Rectangle2D viewbox,
                                        Rectangle2D viewport)
```
    Creates a new visual brush.
    
    Parameters:
    
    element - The XPS element (Canvas, Path, or Glyphs) for Visual property od visual brush.
    
    viewbox - The position and dimensions of the brush's source content.
    
    viewport - The region in the containing coordinate space of the prime brush tile that is (possibly repeatedly) applied to fill the region to which the brush is applied
    
    Returns:
    
    New visual brush.
  - createImageBrush
```
public XpsImageBrush createImageBrush(XpsImage image,
                                      Rectangle2D viewbox,
                                      Rectangle2D viewport)
```
    Creates a new image brush.
    
    Parameters:
    
    image - An image resource.
    
    viewbox - The position and dimensions of the brush's source content.
    
    viewport - The region in the containing coordinate space of the prime brush tile that is (possibly repeatedly) applied to fill the region to which the brush is applied
    
    Returns:
    
    New image brush.
  - createImageBrush
```
public XpsImageBrush createImageBrush(String imagePath,
                                      Rectangle2D viewbox,
                                      Rectangle2D viewport)
```
    Creates a new image brush.
    
    Parameters:
    
    imagePath - The path to the image to take as a brush tile.
    
    viewbox - The position and dimensions of the brush's source content.
    
    viewport - The region in the containing coordinate space of the prime brush tile that is (possibly repeatedly) applied to fill the region to which the brush is applied
    
    Returns:
    
    New image brush.
  - createColor
```
public XpsColor createColor(Color color)
```
    Creates a new color.
    
    Parameters:
    
    color - A native color instance for RGB color.
    
    Returns:
    
    New color.
  - createColor
```
public XpsColor createColor(int a,
                            int r,
                            int g,
                            int b)
```
    Creates a new color in sRGB color space.
    
    Parameters:
    
    a - The alpha color component.
    
    r - The red color component.
    
    g - The green color component.
    
    b - The blue color component.
    
    Returns:
    
    New color.
  - createColor
```
public XpsColor createColor(int r,
                            int g,
                            int b)
```
    Creates a new color in sRGB color space.
    
    Parameters:
    
    r - The red color component.
    
    g - The green color component.
    
    b - The blue color component.
    
    Returns:
    
    New color.
  - createColor
```
public XpsColor createColor(float a,
                            float r,
                            float g,
                            float b)
```
    Creates a new color in scRGB color space.
    
    Parameters:
    
    a - The alpha color component.
    
    r - The red color component.
    
    g - The green color component.
    
    b - The blue color component.
    
    Returns:
    
    New color.
  - createColor
```
public XpsColor createColor(float r,
                            float g,
                            float b)
```
    Creates a new color in scRGB color space.
    
    Parameters:
    
    r - The red color component.
    
    g - The green color component.
    
    b - The blue color component.
    
    Returns:
    
    New color.
  - createColor
```
public XpsColor createColor(String path,
                            float... components)
```
    Creates a new color in ICC based color space.
    
    Parameters:
    
    path - The path to the ICC profile.
    
    components - Color components.
    
    Returns:
    
    New color.
  - createColor
```
public XpsColor createColor(XpsIccProfile iccProfile,
                            float... components)
```
    Creates a new color in ICC based color space.
    
    Parameters:
    
    iccProfile - The ICC profile resource.
    
    components - Color components.
    
    Returns:
    
    New color.
  - addOutlineEntry
```
public void addOutlineEntry(String description,
                            int outlineLevel,
                            int targetPageNumber)
```
    Adds an outline entry to the document.
    
    Parameters:
    
    description - The entry description.
    
    outlineLevel - The outline level.
    
    targetPageNumber - The target page number.

Class PageAPI

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getUtils

getTotalPageCount

getPageCount

getHeight

setHeight

getWidth

setWidth

add

insert

remove

removeAt

createCanvas

addCanvas

insertCanvas

createPath

addPath

insertPath

createGlyphs

createGlyphs

addGlyphs

insertGlyphs

addGlyphs

insertGlyphs

createMatrix

createPathGeometry

createPathGeometry

createPathGeometry

createPathFigure

createPathFigure

createPathFigure

createPathFigure

createArcSegment

createArcSegment

createPolyLineSegment

createPolyLineSegment

createPolyBezierSegment

createPolyBezierSegment

createPolyQuadraticBezierSegment

createPolyQuadraticBezierSegment

createSolidColorBrush

createSolidColorBrush

createGradientStop

createGradientStop

createLinearGradientBrush

createLinearGradientBrush

createRadialGradientBrush

createRadialGradientBrush

createVisualBrush

createImageBrush

createImageBrush

createColor

createColor

createColor

createColor

createColor

createColor

createColor

addOutlineEntry