Working with Clips in PS file| Java

Add Clip in PS Document

A clip in a PS document is a path that bounds the content of the current graphics state that will be shown in the PS viewer or editor. The content that is left beyond the bounds will be cut off.

A clipping path in Java can be assigned in three ways:

• by any class implemented java.awt.Shape that can contain any closed shapes;
• by text outline;
• by 1 bpp (bits per pixel) 2-color image as a stencil mask;

At this moment Aspose.Page for Java library offers the first and the second ways of clipping. In the example below we obtain a circle shape as a clipping path and cut off a blue-filled rectangle in the same graphics state.

To add a clip to the new PsDocument with Aspose.Page for Java library in this example we do the following steps:

1. Create an output stream for the resulting PS file.
2. Create PsSaveOptions object with default options.
3. Create a 1-paged PsDocument with an already created output stream and save options.
4. Create a new graphics state.
5. Create a circle (java.awt.geom.Ellipse2D object) shape.
6. Set a clip with this path.
7. Set a paint to the current graphics state of PsDocument.
8. Fill the rectangle path with the current paint.
9. Exit from the current graphics state to upper level one.
10. Translate to the place of the filled rectangle.
11. Stroke with a dashed line the bounds of the same rectangle above the filled one to show the bounds of the clipped filled rectangle.
12. Close the page.
13. Save the document.

//Create an output stream for the PostScript document
FileOutputStream outPsStream = new FileOutputStream(dataDir + "Clipping_outPS.ps");
//Create save options with A4 size
PsSaveOptions options = new PsSaveOptions();

// Create a new PS Document with the page opened
PsDocument document = new PsDocument(outPsStream, options, false);

//Create a rectangle
Shape rectangle = new Rectangle2D.Float(0, 0, 300, 200);

//Set the paint in the upper level graphics state
document.setPaint(Color.BLUE);

//Save the  graphics state to return back to this state after the transformation
document.writeGraphicsSave();

//Displace the current graphics state on 100 points to the right and 100 points to the bottom.
document.translate(100, 100);

//Create a circle shape
Shape circle = new Ellipse2D.Float(50, 0, 200, 200);

//Add clipping by the circle to the current graphics state
document.clip(circle);

//Fill the rectangle in the current graphics state (with clipping)
document.fill(rectangle);

//Restore the graphics state to the previus (upper) level
document.writeGraphicsRestore();

//Displace the upper-level graphics state on 100 points to the right and 100 points to the bottom.
document.translate(100, 100);

BasicStroke stroke = new BasicStroke(2,
        BasicStroke.CAP_BUTT,
        BasicStroke.JOIN_MITER,
        10.0f, new float []{5.0f}, 0.0f);

document.setStroke(stroke);

//Draw the rectangle in the current graphics state (has no clipping) above the clipped rectangle
document.draw(rectangle);

//Close the current page
document.closePage();
//Save the document
document.save();

See working with clips in PS documents in .NET.

The result of running this code is appeared as

In the next example, we obtain a font used to clip a blue-filled rectangle with the text’s outline.

To add a clipping by text to the new PsDocument with Aspose.Page for Java library in this example we do the following steps:

1. Create an output stream for the resulting PS file.
2. Create PsSaveOptions object with default options.
3. Create a 1-paged PsDocument with an already created output stream and save options.
4. Create a new graphics state.
5. Create a font.
6. Set a clip with the text and the font.
7. Set a paint to the current graphics state of PsDocument.
8. Fill the rectangle path with the current paint.
9. Exit from the current graphics state to upper level one.
10. Translate to the place of the filled rectangle.
11. Stroke with a dashed line the bounds of the same rectangle above the filled one to show the bounds of the clipped filled rectangle.
12. Close the page.
13. Save the document.

//Create output stream for PostScript document
FileOutputStream outPsStream = new FileOutputStream(dataDir + "Clipping_outPS.ps");
//Create save options with A4 size
PsSaveOptions options = new PsSaveOptions();

// Create a new PS Document with the page opened
PsDocument document = new PsDocument(outPsStream, options, false);

//Create a rectangle
Shape rectangle = new Rectangle2D.Float(0, 0, 300, 200);

//Set paint in the upper-level graphics state
document.setPaint(Color.BLUE);

//Save graphics state to return back to this state after the transformation
document.writeGraphicsSave();

//Displace current graphics state on 100 points to the right and 100 points to the bottom.
document.translate(100, 100);

int fontSize = 120;
Font font = new Font("Arial", Font.BOLD, fontSize);

//Clip rectangle by text's outline
document.clipText("ABC", font, 20, fontSize + 10);		
document.fill(rectangle);

//Restore graphics state to the previous (upper) level
document.writeGraphicsRestore();

//Displace upper-level graphics state on 100 points to the right and 100 points to the bottom.
document.translate(100, 100);

BasicStroke stroke = new BasicStroke(2,
        BasicStroke.CAP_BUTT,
        BasicStroke.JOIN_MITER,
        10.0f, new float []{5.0f}, 0.0f);

document.setStroke(stroke);

//Draw the rectangle in the current graphics state (has no clipping) above the clipped rectangle
document.draw(rectangle);

//Close the current page
document.closePage();
//Save the document
document.save();

See working with clips in PS documents in .NET.

The result of running this code appears as

You can download examples and data files from GitHub.