001: /*
002: * $Id: PdfRectangle.java 2742 2007-05-08 13:04:56Z blowagie $
003: * $Name$
004: *
005: * Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
006: *
007: * The contents of this file are subject to the Mozilla Public License Version 1.1
008: * (the "License"); you may not use this file except in compliance with the License.
009: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
010: *
011: * Software distributed under the License is distributed on an "AS IS" basis,
012: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
013: * for the specific language governing rights and limitations under the License.
014: *
015: * The Original Code is 'iText, a free JAVA-PDF library'.
016: *
017: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
018: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
019: * All Rights Reserved.
020: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
021: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
022: *
023: * Contributor(s): all the names of the contributors are added in the source code
024: * where applicable.
025: *
026: * Alternatively, the contents of this file may be used under the terms of the
027: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
028: * provisions of LGPL are applicable instead of those above. If you wish to
029: * allow use of your version of this file only under the terms of the LGPL
030: * License and not to allow others to use your version of this file under
031: * the MPL, indicate your decision by deleting the provisions above and
032: * replace them with the notice and other provisions required by the LGPL.
033: * If you do not delete the provisions above, a recipient may use your version
034: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
035: *
036: * This library is free software; you can redistribute it and/or modify it
037: * under the terms of the MPL as stated above or under the terms of the GNU
038: * Library General Public License as published by the Free Software Foundation;
039: * either version 2 of the License, or any later version.
040: *
041: * This library is distributed in the hope that it will be useful, but WITHOUT
042: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
043: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
044: * details.
045: *
046: * If you didn't download this code from the following link, you should check if
047: * you aren't using an obsolete version:
048: * http://www.lowagie.com/iText/
049: */
050:
051: package com.lowagie.text.pdf;
052:
053: import com.lowagie.text.Rectangle;
054:
055: /**
056: * <CODE>PdfRectangle</CODE> is the PDF Rectangle object.
057: * <P>
058: * Rectangles are used to describe locations on the page and bounding boxes for several
059: * objects in PDF, such as fonts. A rectangle is represented as an <CODE>array</CODE> of
060: * four numbers, specifying the lower lef <I>x</I>, lower left <I>y</I>, upper right <I>x</I>,
061: * and upper right <I>y</I> coordinates of the rectangle, in that order.<BR>
062: * This object is described in the 'Portable Document Format Reference Manual version 1.3'
063: * section 7.1 (page 183).
064: *
065: * @see com.lowagie.text.Rectangle
066: * @see PdfArray
067: */
068:
069: public class PdfRectangle extends PdfArray {
070:
071: // membervariables
072:
073: /** lower left x */
074: private float llx = 0;
075:
076: /** lower left y */
077: private float lly = 0;
078:
079: /** upper right x */
080: private float urx = 0;
081:
082: /** upper right y */
083: private float ury = 0;
084:
085: // constructors
086:
087: /**
088: * Constructs a <CODE>PdfRectangle</CODE>-object.
089: *
090: * @param llx lower left x
091: * @param lly lower left y
092: * @param urx upper right x
093: * @param ury upper right y
094: *
095: * @since rugPdf0.10
096: */
097:
098: public PdfRectangle(float llx, float lly, float urx, float ury,
099: int rotation) {
100: super ();
101: if (rotation == 90 || rotation == 270) {
102: this .llx = lly;
103: this .lly = llx;
104: this .urx = ury;
105: this .ury = urx;
106: } else {
107: this .llx = llx;
108: this .lly = lly;
109: this .urx = urx;
110: this .ury = ury;
111: }
112: super .add(new PdfNumber(this .llx));
113: super .add(new PdfNumber(this .lly));
114: super .add(new PdfNumber(this .urx));
115: super .add(new PdfNumber(this .ury));
116: }
117:
118: public PdfRectangle(float llx, float lly, float urx, float ury) {
119: this (llx, lly, urx, ury, 0);
120: }
121:
122: /**
123: * Constructs a <CODE>PdfRectangle</CODE>-object starting from the origin (0, 0).
124: *
125: * @param urx upper right x
126: * @param ury upper right y
127: */
128:
129: public PdfRectangle(float urx, float ury, int rotation) {
130: this (0, 0, urx, ury, rotation);
131: }
132:
133: public PdfRectangle(float urx, float ury) {
134: this (0, 0, urx, ury, 0);
135: }
136:
137: /**
138: * Constructs a <CODE>PdfRectangle</CODE>-object with a <CODE>Rectangle</CODE>-object.
139: *
140: * @param rectangle a <CODE>Rectangle</CODE>
141: */
142:
143: public PdfRectangle(Rectangle rectangle, int rotation) {
144: this (rectangle.getLeft(), rectangle.getBottom(), rectangle
145: .getRight(), rectangle.getTop(), rotation);
146: }
147:
148: public PdfRectangle(Rectangle rectangle) {
149: this (rectangle.getLeft(), rectangle.getBottom(), rectangle
150: .getRight(), rectangle.getTop(), 0);
151: }
152:
153: // methods
154: /**
155: * Returns the high level version of this PdfRectangle
156: * @return this PdfRectangle translated to class Rectangle
157: */
158: public Rectangle getRectangle() {
159: return new Rectangle(left(), bottom(), right(), top());
160: }
161:
162: /**
163: * Overrides the <CODE>add</CODE>-method in <CODE>PdfArray</CODE> in order to prevent the adding of extra object to the array.
164: *
165: * @param object <CODE>PdfObject</CODE> to add (will not be added here)
166: * @return <CODE>false</CODE>
167: */
168:
169: public boolean add(PdfObject object) {
170: return false;
171: }
172:
173: /**
174: * Returns the lower left x-coordinate.
175: *
176: * @return the lower left x-coordinaat
177: */
178:
179: public float left() {
180: return llx;
181: }
182:
183: /**
184: * Returns the upper right x-coordinate.
185: *
186: * @return the upper right x-coordinate
187: */
188:
189: public float right() {
190: return urx;
191: }
192:
193: /**
194: * Returns the upper right y-coordinate.
195: *
196: * @return the upper right y-coordinate
197: */
198:
199: public float top() {
200: return ury;
201: }
202:
203: /**
204: * Returns the lower left y-coordinate.
205: *
206: * @return the lower left y-coordinate
207: */
208:
209: public float bottom() {
210: return lly;
211: }
212:
213: /**
214: * Returns the lower left x-coordinate, considering a given margin.
215: *
216: * @param margin a margin
217: * @return the lower left x-coordinate
218: */
219:
220: public float left(int margin) {
221: return llx + margin;
222: }
223:
224: /**
225: * Returns the upper right x-coordinate, considering a given margin.
226: *
227: * @param margin a margin
228: * @return the upper right x-coordinate
229: */
230:
231: public float right(int margin) {
232: return urx - margin;
233: }
234:
235: /**
236: * Returns the upper right y-coordinate, considering a given margin.
237: *
238: * @param margin a margin
239: * @return the upper right y-coordinate
240: */
241:
242: public float top(int margin) {
243: return ury - margin;
244: }
245:
246: /**
247: * Returns the lower left y-coordinate, considering a given margin.
248: *
249: * @param margin a margin
250: * @return the lower left y-coordinate
251: */
252:
253: public float bottom(int margin) {
254: return lly + margin;
255: }
256:
257: /**
258: * Returns the width of the rectangle.
259: *
260: * @return a width
261: */
262:
263: public float width() {
264: return urx - llx;
265: }
266:
267: /**
268: * Returns the height of the rectangle.
269: *
270: * @return a height
271: */
272:
273: public float height() {
274: return ury - lly;
275: }
276:
277: /**
278: * Swaps the values of urx and ury and of lly and llx in order to rotate the rectangle.
279: *
280: * @return a <CODE>PdfRectangle</CODE>
281: */
282:
283: public PdfRectangle rotate() {
284: return new PdfRectangle(lly, llx, ury, urx, 0);
285: }
286: }
|