Using XPS graphic utilities | Java

How to easily produce basic shapes in XPS

The XPS specification defines graphic primitive elements that can be used to compose any complex shapes. Aspose.Page for Java provides classes encapsulating these elements. However, creating even relatively simple shapes, such as a circular sector or segment, or a regular n-gon inscribed in or circumscribed around a circle, can be a bit tedious. Even drawing a circle or an ellipse is not as straightforward as it could be. That is why Aspose.Page also offers a set of utility methods to help save time when working on these tasks.

In the example below, we use all available shape utilities. It is important to note that each of these utility methods returns an object of XpsPathGeometry, which can then be used to create XPS paths. And for these paths, you can specify appearance properties - brushes, stroke pattern, opacity, etc.

// For complete examples and data files, please go to https://github.com/aspose-page/Aspose.Page-for-Java
// The path to the documents directory.
String dataDir = Utils.getDataDir();
// Create new XPS Document
final XpsDocument doc = new XpsDocument();
try {
    // Set first page's size.
    doc.getPage().setWidth(650f);
    doc.getPage().setHeight(240f);

    // Draw a circle with center (120, 120) and radius 100.
    XpsPath path = doc.createPath(doc.getUtils().createCircle(new Point2D.Float(120f, 120f), 100f));
    path.setFill(doc.createSolidColorBrush(Color.GREEN));
    doc.add(path);

    // Inscribe a regular pentagon in the circle.
    path = doc.createPath(doc.getUtils().createRegularInscribedNGon(5, new Point2D.Float(120f, 120f), 100f));
    path.setFill(doc.createSolidColorBrush(Color.RED));
    doc.add(path);

    // Circumscribe a regular hexagon around the circle.
    path = doc.createPath(doc.getUtils().createRegularCircumscribedNGon(6, new Point2D.Float(120f, 120f), 100f));
    path.setStroke(doc.createSolidColorBrush(Color.MAGENTA));
    path.setStrokeThickness(3f);
    doc.add(path);

    // Draw a sector of the circle centered at (340, 120), starting at -45 degrees and ending at +45 degrees.
    path = doc.createPath(doc.getUtils().createPieSlice(new Point2D.Float(340f, 120f), 100f, -45f, 45f));
    path.setStroke(doc.createSolidColorBrush(Color.RED));
    path.setStrokeThickness(5f);
    doc.add(path);

    // Draw a segment of the circle centered at (340, 120), starting at -45 degrees and ending at +45 degrees.
    path = doc.createPath(doc.getUtils().createCircularSegment(new Point2D.Float(340f, 120f), 100f, -45f, 45f));
    path.setFill(doc.createSolidColorBrush(Color.BLACK));
    doc.add(path);

    // Draw a rectangle with the top left vertex (530, 20), width 100 units and height 200 units.
    path = doc.createPath(doc.getUtils().createRectangle(new Rectangle2D.Float(530f, 20f, 100f, 200f)));
    path.setStroke(doc.createSolidColorBrush(Color.RED));
    doc.add(path);

    // Draw an ellipse with center (580, 120) and radii 50 and 100.
    path = doc.createPath(doc.getUtils().createEllipse(new Point2D.Float(580f, 120f), 50f, 100f));
    path.setFill(doc.createSolidColorBrush(Color.YELLOW));
    doc.add(path);

    doc.save(dataDir + "UseShapeUtilsXPS_out.xps");
} finally {
  if (doc != null)
    doc.close();
}

We start by creating a new XPS document and then adjusting the size of the first page. The first shape we add to the page is a solid green circle specified by its center and radius. Next, we draw an unfilled red regular pentagon inscribed in that circle. Then comes a regular hexagon stroked with magenta and circumscribed around the circle.

To the right, we draw a red circular sector (or a “pie slice”) between -45 and +45 degrees, followed by a black circular segment with the same parameters on top of the sector.

The last part of the drawing includes a red rectangle (specified by its top left corner and dimensions) and a yellow ellipse (specified by its center and radii) inscribed in the rectangle. In this case, we handle the inscription “by hand”.

Here is the intended output in the saved XPS file:

How to easily place an image on an XPS page

When using primitives defined by the XPS specification, placing an image on a page involves two steps:

• Adding a rectangular path (image box) to fill with the image;
• Applying an image brush to the image box, where you need to specify a view box and a viewport. Typically, you will need to know the resolution and the size in pixels of your image to accurately provide these parameters.

But fortunately, there is a convenient method among XPS graphic utilities in the Aspose.Page API for Java that can handle most of the work for you. It also offers you common fit modes. Let’s look at the following example:

// For complete examples and data files, please go to https://github.com/aspose-page/Aspose.Page-for-Java
// The path to the documents directory.
String dataDir = Utils.getDataDir();
// Create new XPS Document
final XpsDocument doc = new XpsDocument();
try {
    // Set first page's size.
    doc.getPage().setWidth(540f);
    doc.getPage().setHeight(220f);

    // Draw the image box.
    Rectangle2D imageBox = new Rectangle2D.Float(10f, 10f, 200f, 200f);
    XpsPath path = doc.addPath(doc.getUtils().createRectangle(imageBox));
    path.setStroke(doc.createSolidColorBrush(Color.BLACK));
    // Add an image to fit width.
    path = doc.getUtils().createImage(dataDir + "R08LN_NN.jpg", imageBox, ImageMode.FitToWidth);
    // Prevent tiling.
    ((XpsImageBrush)path.getFill()).setTileMode(XpsTileMode.None);
    doc.add(path);

    // Add an image to fit width.
    doc.add(doc.getUtils().createImage(
        dataDir + "R08LN_NN.jpg", new Rectangle2D.Float(220f, 10f, 200f, 100f), ImageMode.FitToHeight));

    // Add an image to fit width.
    doc.add(doc.getUtils().createImage(
        dataDir + "R08LN_NN.jpg", new Rectangle2D.Float(430f, 10f, 100f, 200f), ImageMode.FitToBox));

    // Save resultant XPS document 
    doc.save(dataDir + "UseImageUtilsXPS_out.xps");
} finally {
  if (doc != null)
    doc.close();
}

Again, we begin with a new XPS document and resize the first page. It is worth mentioning here that by default your image being used as a brush will tile across the image box in the same way as if it was used in XpsTileMode.Tile mode. However, in the first part of the example, we show how to prevent this tiling.

So, we first want the image to be displayed at coordinates (10, 10) and to fit the width of the rectangular box, which is 200 units wide and 200 units high. To better visualize the result, we first draw the box itself. Then, we proceed to create the image (which is essentially a filled path). Finally, after getting the path’s fill and casting it to XpsImageBrush, we set the TileMode property to XpsTileMode.None.

To the right, we place the same image fitting the height of the image box. Notice the tiling effect.

Finally, we place the same image to the right once more and adjust it to fit both the height and width of the image box, resulting in some distortion of the image.

And here is the result in the saved XPS file: