org.jpedal.objects.PdfClip Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of OpenViewerFX Show documentation

Open Source (LGPL) JavaFX PDF Viewer for NetBeans plugin

There is a newer version: 7.15.25

/*
 * ===========================================
 * Java Pdf Extraction Decoding Access Library
 * ===========================================
 *
 * Project Info:  http://www.idrsolutions.com
 * Help section for developers at http://www.idrsolutions.com/support/
 *
 * (C) Copyright 1997-2017 IDRsolutions and Contributors.
 *
 * This file is part of JPedal/JPDF2HTML5
 *
 @LICENSE@
 *
 * ---------------
 * PdfClip.java
 * ---------------
 */
package org.jpedal.objects;

/**
 * Code for storing and modifying the current clip held in the GraphicsState.
 */
public interface PdfClip {

    /**
     * Updates the clip by adding the passed in shape to the clip.
     *
     * @param path The path to be added to the clip
     * @return Whether the clip has been changed
     */
    boolean updateClip(Object path);

    /**
     * Gets the current clipping shape. Must be cast to the appropriate object.
     *
     * @return
     */
    Object getClippingShape();


}