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

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

An Open Source JavaFX PDF Viewer

There is a newer version: 20151002

/*
 * ===========================================
 * 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-2015 IDRsolutions and Contributors.
 *
 * This file is part of JPedal/JPDF2HTML5
 *
     This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


 *
 * ---------------
 * 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();
    
    
}