KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > Watermark


1 /*
2  * $Id: Watermark.java,v 1.52 2004/12/14 11:52:47 blowagie Exp $
3  * $Name: $
4  *
5  * Copyright 2000, 2001, 2002 by Bruno Lowagie.
6  *
7  * The contents of this file are subject to the Mozilla Public License Version 1.1
8  * (the "License"); you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the License.
14  *
15  * The Original Code is 'iText, a free JAVA-PDF library'.
16  *
17  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
18  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
19  * All Rights Reserved.
20  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
21  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
22  *
23  * Contributor(s): all the names of the contributors are added in the source code
24  * where applicable.
25  *
26  * Alternatively, the contents of this file may be used under the terms of the
27  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
28  * provisions of LGPL are applicable instead of those above. If you wish to
29  * allow use of your version of this file only under the terms of the LGPL
30  * License and not to allow others to use your version of this file under
31  * the MPL, indicate your decision by deleting the provisions above and
32  * replace them with the notice and other provisions required by the LGPL.
33  * If you do not delete the provisions above, a recipient may use your version
34  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Library General Public License as published by the Free Software Foundation;
39  * either version 2 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
43  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
44  * details.
45  *
46  * If you didn't download this code from the following link, you should check if
47  * you aren't using an obsolete version:
48  * http://www.lowagie.com/iText/
49  */
50
51 package com.lowagie.text;
52
53 import java.net.MalformedURLException;
54
55 /**
56  * A <CODE>Watermark</CODE> is a graphic element (GIF or JPEG)
57  * that is shown on a certain position on each page.
58  *
59  * @see Element
60  * @see Jpeg
61  */
62
63 public class Watermark extends Image implements Element {
64     
65     // membervariables
66
67 /** This is the offset in x-direction of the Watermark. */
68     private float offsetX = 0;
69     
70 /** This is the offset in y-direction of the Watermark. */
71     private float offsetY = 0;
72     
73     // Constructors
74
75 /**
76  * Constructs a <CODE>Watermark</CODE>-object, using an <CODE>Image</CODE>.
77  *
78  * @param image an <CODE>Image</CODE>-object
79  * @param offsetX the offset in x-direction
80  * @param offsetY the offset in y-direction
81  * @throws MalformedURLException
82  */
83     
84     public Watermark(Image image, float offsetX, float offsetY) throws MalformedURLException {
85         super(image);
86         this.offsetX = offsetX;
87         this.offsetY = offsetY;
88     }
89     
90     // implementation of the Element interface
91
92 /**
93  * Gets the type of the text element.
94  *
95  * @return a type
96  */
97     
98     public int type() {
99         return type;
100     }
101     
102     // methods to retrieve information
103
104 /**
105  * Returns the offset in x direction.
106  *
107  * @return an offset
108  */
109     
110     public float offsetX() {
111         return offsetX;
112     }
113     
114 /**
115  * Returns the offset in y direction.
116  *
117  * @return an offset
118  */
119     
120     public float offsetY() {
121         return offsetY;
122     }
123 }
124
Popular Tags