core.com.lowagie.text.Rectangle Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of itext Show documentation
Show all versions of itext Show documentation
iText, a free Java-PDF library
/*
* $Id: Rectangle.java 3048 2007-12-01 10:33:01Z blowagie $
* $Name$
*
* Copyright 1999, 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.awt.Color;
import java.util.ArrayList;
import com.lowagie.text.pdf.GrayColor;
/**
* A Rectangle is the representation of a geometric figure.
*
* Rectangles support constant width borders using
* {@link #setBorderWidth(float)}and {@link #setBorder(int)}. They also
* support borders that vary in width/color on each side using methods like
* {@link #setBorderWidthLeft(float)}or
* {@link #setBorderColorLeft(java.awt.Color)}.
*
* @see Element
* @see Table
* @see Cell
* @see HeaderFooter
*/
public class Rectangle implements Element {
// static final membervariables (concerning the presence of borders)
/** This is the value that will be used as undefined . */
public static final int UNDEFINED = -1;
/** This represents one side of the border of the Rectangle. */
public static final int TOP = 1;
/** This represents one side of the border of the Rectangle. */
public static final int BOTTOM = 2;
/** This represents one side of the border of the Rectangle. */
public static final int LEFT = 4;
/** This represents one side of the border of the Rectangle. */
public static final int RIGHT = 8;
/** This represents a rectangle without borders. */
public static final int NO_BORDER = 0;
/** This represents a type of border. */
public static final int BOX = TOP + BOTTOM + LEFT + RIGHT;
// membervariables
/** the lower left x-coordinate. */
protected float llx;
/** the lower left y-coordinate. */
protected float lly;
/** the upper right x-coordinate. */
protected float urx;
/** the upper right y-coordinate. */
protected float ury;
/** The rotation of the Rectangle */
protected int rotation = 0;
/** This represents the status of the 4 sides of the rectangle. */
protected int border = UNDEFINED;
/** This is the width of the border around this rectangle. */
protected float borderWidth = UNDEFINED;
/** The color of the border of this rectangle. */
protected Color borderColor = null;
/** This is the color of the background of this rectangle. */
protected Color backgroundColor = null;
/** Whether variable width/color borders are used. */
protected boolean useVariableBorders = false;
/** The width of the left border of this rectangle. */
protected float borderWidthLeft = UNDEFINED;
/** The width of the right border of this rectangle. */
protected float borderWidthRight = UNDEFINED;
/** The width of the top border of this rectangle. */
protected float borderWidthTop = UNDEFINED;
/** The width of the bottom border of this rectangle. */
protected float borderWidthBottom = UNDEFINED;
/** The color of the left border of this rectangle. */
protected Color borderColorLeft = null;
/** The color of the right border of this rectangle. */
protected Color borderColorRight = null;
/** The color of the top border of this rectangle. */
protected Color borderColorTop = null;
/** The color of the bottom border of this rectangle. */
protected Color borderColorBottom = null;
// constructors
/**
* Constructs a Rectangle -object.
*
* @param llx
* lower left x
* @param lly
* lower left y
* @param urx
* upper right x
* @param ury
* upper right y
*/
public Rectangle(float llx, float lly, float urx, float ury) {
this.llx = llx;
this.lly = lly;
this.urx = urx;
this.ury = ury;
}
/**
* Constructs a Rectangle -object starting from the origin
* (0, 0).
*
* @param urx
* upper right x
* @param ury
* upper right y
*/
public Rectangle(float urx, float ury) {
this(0, 0, urx, ury);
}
/**
* Constructs a Rectangle -object.
*
* @param rect
* another Rectangle
*/
public Rectangle(Rectangle rect) {
this(rect.llx, rect.lly, rect.urx, rect.ury);
cloneNonPositionParameters(rect);
}
// implementation of the Element interface
/**
* Processes the element by adding it (or the different parts) to an
* ElementListener.
*
* @param listener
* an ElementListener
* @return true if the element was processed successfully
*/
public boolean process(ElementListener listener) {
try {
return listener.add(this);
} catch (DocumentException de) {
return false;
}
}
/**
* Gets the type of the text element.
*
* @return a type
*/
public int type() {
return Element.RECTANGLE;
}
/**
* Gets all the chunks in this element.
*
* @return an ArrayList
*/
public ArrayList getChunks() {
return new ArrayList();
}
/**
* @see com.lowagie.text.Element#isContent()
* @since iText 2.0.8
*/
public boolean isContent() {
return true;
}
/**
* @see com.lowagie.text.Element#isNestable()
* @since iText 2.0.8
*/
public boolean isNestable() {
return false;
}
// methods to get/set the dimensions
/**
* Sets the lower left x-coordinate.
*
* @param value
* the new value
*/
public void setLeft(float value) {
llx = value;
}
/**
* Returns the lower left x-coordinate.
*
* @return the lower left x-coordinate
*/
public float getLeft() {
return llx;
}
/**
* Returns the lower left x-coordinate, considering a given margin.
*
* @param margin
* a margin
* @return the lower left x-coordinate
*/
public float getLeft(float margin) {
return llx + margin;
}
/**
* Sets the upper right x-coordinate.
*
* @param value
* the new value
*/
public void setRight(float value) {
urx = value;
}
/**
* Returns the upper right x-coordinate.
*
* @return the upper right x-coordinate
*/
public float getRight() {
return urx;
}
/**
* Returns the upper right x-coordinate, considering a given margin.
*
* @param margin
* a margin
* @return the upper right x-coordinate
*/
public float getRight(float margin) {
return urx - margin;
}
/**
* Returns the width of the rectangle.
*
* @return a width
*/
public float getWidth() {
return urx - llx;
}
/**
* Sets the upper right y-coordinate.
*
* @param value
* the new value
*/
public void setTop(float value) {
ury = value;
}
/**
* Returns the upper right y-coordinate.
*
* @return the upper right y-coordinate
*/
public float getTop() {
return ury;
}
/**
* Returns the upper right y-coordinate, considering a given margin.
*
* @param margin
* a margin
* @return the upper right y-coordinate
*/
public float getTop(float margin) {
return ury - margin;
}
/**
* Sets the lower left y-coordinate.
*
* @param value
* the new value
*/
public void setBottom(float value) {
lly = value;
}
/**
* Returns the lower left y-coordinate.
*
* @return the lower left y-coordinate
*/
public float getBottom() {
return lly;
}
/**
* Returns the lower left y-coordinate, considering a given margin.
*
* @param margin
* a margin
* @return the lower left y-coordinate
*/
public float getBottom(float margin) {
return lly + margin;
}
/**
* Returns the height of the rectangle.
*
* @return a height
*/
public float getHeight() {
return ury - lly;
}
/**
* Switches lowerleft with upperright
*/
public void normalize() {
if (llx > urx) {
float a = llx;
llx = urx;
urx = a;
}
if (lly > ury) {
float a = lly;
lly = ury;
ury = a;
}
}
// methods to get/set the rotation
/**
* Gets the rotation of the rectangle
*
* @return a rotation value
*/
public int getRotation() {
return rotation;
}
/**
* Swaps the values of urx and ury and of lly and llx in order to rotate the
* rectangle.
*
* @return a Rectangle
*/
public Rectangle rotate() {
Rectangle rect = new Rectangle(lly, llx, ury, urx);
rect.rotation = rotation + 90;
rect.rotation %= 360;
return rect;
}
// border
/**
* Returns the exact type of the border.
*
* @return a value
*/
public int getBorder() {
return border;
}
/**
* Indicates if the table has borders.
*
* @return a boolean
*/
public boolean hasBorders() {
return (border > 0)
&& ((borderWidth > 0) || (borderWidthLeft > 0)
|| (borderWidthRight > 0) || (borderWidthTop > 0) || (borderWidthBottom > 0));
}
/**
* Indicates if the table has a some type of border.
*
* @param type
* the type of border
* @return a boolean
*/
public boolean hasBorder(int type) {
return border != UNDEFINED && (border & type) == type;
}
/**
* Enables/Disables the border on the specified sides. The border is
* specified as an integer bitwise combination of the constants:
* LEFT, RIGHT, TOP, BOTTOM.
*
* @see #enableBorderSide(int)
* @see #disableBorderSide(int)
* @param value
* the new value
*/
public void setBorder(int value) {
border = value;
}
/**
* Enables the border on the specified side.
*
* @param side
* the side to enable. One of LEFT, RIGHT, TOP, BOTTOM
*
*/
public void enableBorderSide(int side) {
if (border == UNDEFINED) {
border = 0;
}
border |= side;
}
/**
* Disables the border on the specified side.
*
* @param side
* the side to disable. One of LEFT, RIGHT, TOP, BOTTOM
*
*/
public void disableBorderSide(int side) {
if (border == UNDEFINED) {
border = 0;
}
border &= ~side;
}
// borderwidth
/**
* Gets the borderwidth.
*
* @return a value
*/
public float getBorderWidth() {
return borderWidth;
}
/**
* Sets the borderwidth of the table.
*
* @param value
* the new value
*/
public void setBorderWidth(float value) {
borderWidth = value;
}
// bordercolor
/**
* Gets the color of the border.
*
* @return a value
*/
public Color getBorderColor() {
return borderColor;
}
/**
* Sets the color of the border.
*
* @param value
* the new value
*/
public void setBorderColor(Color value) {
borderColor = value;
}
// backgroundcolor
/**
* Gets the backgroundcolor.
*
* @return a value
*/
public Color getBackgroundColor() {
return backgroundColor;
}
/**
* Sets the backgroundcolor of the rectangle.
*
* @param value
* the new value
*/
public void setBackgroundColor(Color value) {
backgroundColor = value;
}
/**
* Gets the grayscale.
*
* @return a value
*/
public float getGrayFill() {
if (backgroundColor instanceof GrayColor)
return ((GrayColor)backgroundColor).getGray();
else
return 0;
}
/**
* Sets the grayscale of the rectangle.
*
* @param value
* the new value
*/
public void setGrayFill(float value) {
backgroundColor = new GrayColor(value);
}
// variable borders
/**
* Indicates whether variable width borders are being used. Returns true if
* setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, or
* setBorderWidthBottom has been called.
*
* @return true if variable width borders are in use
*
*/
public boolean isUseVariableBorders() {
return useVariableBorders;
}
/**
* Sets a parameter indicating if the rectangle has variable borders
*
* @param useVariableBorders
* indication if the rectangle has variable borders
*/
public void setUseVariableBorders(boolean useVariableBorders) {
this.useVariableBorders = useVariableBorders;
}
// variable border width
/** Gives the border width of a specific side. */
private float getVariableBorderWidth(float variableWidthValue, int side) {
if ((border & side) != 0) {
return variableWidthValue != UNDEFINED ? variableWidthValue
: borderWidth;
} else {
return 0;
}
}
/**
* Updates the border flag for a side based on the specified width. A width
* of 0 will disable the border on that side. Any other width enables it.
*
* @param width
* width of border
* @param side
* border side constant
*/
private void updateBorderBasedOnWidth(float width, int side) {
useVariableBorders = true;
if (width > 0) {
enableBorderSide(side);
} else {
disableBorderSide(side);
}
}
/**
* Gets the width of a border.
*
* @return a width
*/
public float getBorderWidthLeft() {
return getVariableBorderWidth(borderWidthLeft, LEFT);
}
/**
* Sets the width of a border
*
* @param borderWidthLeft
* a width
*/
public void setBorderWidthLeft(float borderWidthLeft) {
this.borderWidthLeft = borderWidthLeft;
updateBorderBasedOnWidth(borderWidthLeft, LEFT);
}
/**
* Gets the width of a border.
*
* @return a width
*/
public float getBorderWidthRight() {
return getVariableBorderWidth(borderWidthRight, RIGHT);
}
/**
* Sets the width of a border
*
* @param borderWidthRight
* a width
*/
public void setBorderWidthRight(float borderWidthRight) {
this.borderWidthRight = borderWidthRight;
updateBorderBasedOnWidth(borderWidthRight, RIGHT);
}
/**
* Gets the width of a border.
*
* @return a width
*/
public float getBorderWidthTop() {
return getVariableBorderWidth(borderWidthTop, TOP);
}
/**
* Sets the width of a border
*
* @param borderWidthTop
* a width
*/
public void setBorderWidthTop(float borderWidthTop) {
this.borderWidthTop = borderWidthTop;
updateBorderBasedOnWidth(borderWidthTop, TOP);
}
/**
* Gets the width of a border.
*
* @return a width
*/
public float getBorderWidthBottom() {
return getVariableBorderWidth(borderWidthBottom, BOTTOM);
}
/**
* Sets the width of a border
*
* @param borderWidthBottom
* a width
*/
public void setBorderWidthBottom(float borderWidthBottom) {
this.borderWidthBottom = borderWidthBottom;
updateBorderBasedOnWidth(borderWidthBottom, BOTTOM);
}
// variable border color
/**
* Gets the color of a border.
*
* @return a color value
*/
public Color getBorderColorLeft() {
if (borderColorLeft == null) return borderColor;
return borderColorLeft;
}
/**
* Sets the value of the border color
*
* @param value
* a color value
*/
public void setBorderColorLeft(Color value) {
borderColorLeft = value;
}
/**
* Gets the color of a border.
*
* @return a color value
*/
public Color getBorderColorRight() {
if (borderColorRight == null) return borderColor;
return borderColorRight;
}
/**
* Sets the value of the border color
*
* @param value
* a color value
*/
public void setBorderColorRight(Color value) {
borderColorRight = value;
}
/**
* Gets the color of a border.
*
* @return a color value
*/
public Color getBorderColorTop() {
if (borderColorTop == null) return borderColor;
return borderColorTop;
}
/**
* Sets the value of the border color
*
* @param value
* a color value
*/
public void setBorderColorTop(Color value) {
borderColorTop = value;
}
/**
* Gets the color of a border.
*
* @return a color value
*/
public Color getBorderColorBottom() {
if (borderColorBottom == null) return borderColor;
return borderColorBottom;
}
/**
* Sets the value of the border color
*
* @param value
* a color value
*/
public void setBorderColorBottom(Color value) {
borderColorBottom = value;
}
// special methods
/**
* Gets a Rectangle that is altered to fit on the page.
*
* @param top
* the top position
* @param bottom
* the bottom position
* @return a Rectangle
*/
public Rectangle rectangle(float top, float bottom) {
Rectangle tmp = new Rectangle(this);
if (getTop() > top) {
tmp.setTop(top);
tmp.disableBorderSide(TOP);
}
if (getBottom() < bottom) {
tmp.setBottom(bottom);
tmp.disableBorderSide(BOTTOM);
}
return tmp;
}
/**
* Copies all of the parameters from a Rectangle object
* except the position.
*
* @param rect
* Rectangle to copy from
*/
public void cloneNonPositionParameters(Rectangle rect) {
this.rotation = rect.rotation;
this.border = rect.border;
this.borderWidth = rect.borderWidth;
this.borderColor = rect.borderColor;
this.backgroundColor = rect.backgroundColor;
this.useVariableBorders = rect.useVariableBorders;
this.borderWidthLeft = rect.borderWidthLeft;
this.borderWidthRight = rect.borderWidthRight;
this.borderWidthTop = rect.borderWidthTop;
this.borderWidthBottom = rect.borderWidthBottom;
this.borderColorLeft = rect.borderColorLeft;
this.borderColorRight = rect.borderColorRight;
this.borderColorTop = rect.borderColorTop;
this.borderColorBottom = rect.borderColorBottom;
}
/**
* Copies all of the parameters from a Rectangle object
* except the position.
*
* @param rect
* Rectangle to copy from
*/
public void softCloneNonPositionParameters(Rectangle rect) {
if (rect.rotation != 0)
this.rotation = rect.rotation;
if (rect.border != UNDEFINED)
this.border = rect.border;
if (rect.borderWidth != UNDEFINED)
this.borderWidth = rect.borderWidth;
if (rect.borderColor != null)
this.borderColor = rect.borderColor;
if (rect.backgroundColor != null)
this.backgroundColor = rect.backgroundColor;
if (useVariableBorders)
this.useVariableBorders = rect.useVariableBorders;
if (rect.borderWidthLeft != UNDEFINED)
this.borderWidthLeft = rect.borderWidthLeft;
if (rect.borderWidthRight != UNDEFINED)
this.borderWidthRight = rect.borderWidthRight;
if (rect.borderWidthTop != UNDEFINED)
this.borderWidthTop = rect.borderWidthTop;
if (rect.borderWidthBottom != UNDEFINED)
this.borderWidthBottom = rect.borderWidthBottom;
if (rect.borderColorLeft != null)
this.borderColorLeft = rect.borderColorLeft;
if (rect.borderColorRight != null)
this.borderColorRight = rect.borderColorRight;
if (rect.borderColorTop != null)
this.borderColorTop = rect.borderColorTop;
if (rect.borderColorBottom != null)
this.borderColorBottom = rect.borderColorBottom;
}
/**
* @see java.lang.Object#toString()
*/
public String toString() {
StringBuffer buf = new StringBuffer("Rectangle: ");
buf.append(getWidth());
buf.append('x');
buf.append(getHeight());
buf.append(" (rot: ");
buf.append(rotation);
buf.append(" degrees)");
return buf.toString();
}
// deprecated stuff
/**
* Returns the lower left x-coordinate.
*
* @return the lower left x-coordinate
* @deprecated As of iText 2.0.3, replaced by {@link #getLeft()},
* scheduled for removal at 2.1.0
*/
public float left() {
return getLeft();
}
/**
* Returns the upper right x-coordinate.
*
* @return the upper right x-coordinate
* @deprecated As of iText 2.0.3, replaced by {@link #getRight()},
* scheduled for removal at 2.1.0
*/
public float right() {
return getRight();
}
/**
* Returns the upper right y-coordinate.
*
* @return the upper right y-coordinate
* @deprecated As of iText 2.0.3, replaced by {@link #getTop()},
* scheduled for removal at 2.1.0
*/
public float top() {
return getTop();
}
/**
* Returns the lower left y-coordinate.
*
* @return the lower left y-coordinate
* @deprecated As of iText 2.0.3, replaced by {@link #getBottom()},
* scheduled for removal at 2.1.0
*/
public float bottom() {
return getBottom();
}
/**
* Returns the lower left x-coordinate, considering a given margin.
*
* @param margin
* a margin
* @return the lower left x-coordinate
* @deprecated As of iText 2.0.3, replaced by {@link #getLeft(float)},
* scheduled for removal at 2.1.0
*/
public float left(float margin) {
return getLeft(margin);
}
/**
* Returns the upper right x-coordinate, considering a given margin.
*
* @param margin
* a margin
* @return the upper right x-coordinate
* @deprecated As of iText 2.0.3, replaced by {@link #getRight(float)},
* scheduled for removal at 2.1.0
*/
public float right(float margin) {
return getRight(margin);
}
/**
* Returns the width of the rectangle.
*
* @return a width
* @deprecated As of iText 2.0.3, replaced by {@link #getWidth()},
* scheduled for removal at 2.1.0
*/
public float width() {
return getWidth();
}
/**
* Returns the upper right y-coordinate, considering a given margin.
*
* @param margin
* a margin
* @return the upper right y-coordinate
* @deprecated As of iText 2.0.3, replaced by {@link #getTop(float)},
* scheduled for removal at 2.1.0
*/
public float top(float margin) {
return getTop(margin);
}
/**
* Returns the lower left y-coordinate, considering a given margin.
*
* @param margin
* a margin
* @return the lower left y-coordinate
* @deprecated As of iText 2.0.3, replaced by {@link #getBottom(float)},
* scheduled for removal at 2.1.0
*/
public float bottom(float margin) {
return getBottom(margin);
}
/**
* Returns the height of the rectangle.
*
* @return a height
* @deprecated As of iText 2.0.3, replaced by {@link #getHeight()},
* scheduled for removal at 2.1.0
*/
public float height() {
return getHeight();
}
/**
* Returns the exact type of the border.
*
* @return a value
* @deprecated As of iText 2.0.3, replaced by {@link #getBorder()},
* scheduled for removal at 2.1.0
*/
public int border() {
return getBorder();
}
/**
* Gets the borderwidth.
*
* @return a value
* @deprecated As of iText 2.0.3, replaced by {@link #getBorderWidth()},
* scheduled for removal at 2.1.0
*/
public float borderWidth() {
return getBorderWidth();
}
/**
* Gets the color of the border.
*
* @return a value
* @deprecated As of iText 2.0.3, replaced by {@link #getBorderColor()},
* scheduled for removal at 2.1.0
*/
public Color borderColor() {
return getBorderColor();
}
/**
* Gets the backgroundcolor.
*
* @return a value
* @deprecated As of iText 2.0.3, replaced by {@link #getBackgroundColor()},
* scheduled for removal at 2.1.0
*/
public Color backgroundColor() {
return getBackgroundColor();
}
/**
* Gets the grayscale.
*
* @return a value
* @deprecated As of iText 2.0.3, replaced by {@link #getGrayFill()},
* scheduled for removal at 2.1.0
*/
public float grayFill() {
return getGrayFill();
}
}