com.lowagie.text.Watermark Maven / Gradle / Ivy
/*
* $Id: Watermark.java,v 1.52 2004/12/14 11:52:47 blowagie Exp $
* $Name: $
*
* Copyright 2000, 2001, 2002 by Bruno Lowagie.
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or 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 Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text;
import java.net.MalformedURLException;
/**
* A Watermark is a graphic element (GIF or JPEG)
* that is shown on a certain position on each page.
*
* @see Element
* @see Jpeg
*/
public class Watermark extends Image implements Element {
// membervariables
/** This is the offset in x-direction of the Watermark. */
private float offsetX = 0;
/** This is the offset in y-direction of the Watermark. */
private float offsetY = 0;
// Constructors
/**
* Constructs a Watermark-object, using an Image.
*
* @param image an Image-object
* @param offsetX the offset in x-direction
* @param offsetY the offset in y-direction
* @throws MalformedURLException
*/
public Watermark(Image image, float offsetX, float offsetY) throws MalformedURLException {
super(image);
this.offsetX = offsetX;
this.offsetY = offsetY;
}
// implementation of the Element interface
/**
* Gets the type of the text element.
*
* @return a type
*/
public int type() {
return type;
}
// methods to retrieve information
/**
* Returns the offset in x direction.
*
* @return an offset
*/
public float offsetX() {
return offsetX;
}
/**
* Returns the offset in y direction.
*
* @return an offset
*/
public float offsetY() {
return offsetY;
}
}