|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.lowagie.text.Rectangle
A Rectangle is the representation of a geometric figure.
Rectangles support constant width borders using
setBorderWidth(float)and setBorder(int). They also
support borders that vary in width/color on each side using methods like
setBorderWidthLeft(float)or
setBorderColorLeft(java.awt.Color).
Element,
Table,
Cell,
HeaderFooter| Field Summary | |
static int |
BOTTOM
This represents one side of the border of the Rectangle. |
static int |
BOX
This represents a type of border. |
static int |
LEFT
This represents one side of the border of the Rectangle. |
static int |
NO_BORDER
This represents a rectangle without borders. |
static int |
RIGHT
This represents one side of the border of the Rectangle. |
static int |
TOP
This represents one side of the border of the Rectangle. |
static int |
UNDEFINED
This is the value that will be used as undefined . |
| Fields inherited from interface com.lowagie.text.Element |
ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, HEADER, IMGRAW, IMGTEMPLATE, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK |
| Constructor Summary | |
Rectangle(float urx,
float ury)
Constructs a Rectangle -object starting from the origin
(0, 0). |
|
Rectangle(float llx,
float lly,
float urx,
float ury)
Constructs a Rectangle -object. |
|
Rectangle(Rectangle rect)
Constructs a Rectangle -object. |
|
| Method Summary | |
void |
cloneNonPositionParameters(Rectangle rect)
Copies all of the parameters from a Rectangle object
except the position. |
void |
disableBorderSide(int side)
Disables the border on the specified side. |
void |
enableBorderSide(int side)
Enables the border on the specified side. |
Color |
getBackgroundColor()
Gets the backgroundcolor. |
int |
getBorder()
Returns the exact type of the border. |
Color |
getBorderColor()
Gets the color of the border. |
Color |
getBorderColorBottom()
Gets the color of a border. |
Color |
getBorderColorLeft()
Gets the color of a border. |
Color |
getBorderColorRight()
Gets the color of a border. |
Color |
getBorderColorTop()
Gets the color of a border. |
float |
getBorderWidth()
Gets the borderwidth. |
float |
getBorderWidthBottom()
Gets the width of a border. |
float |
getBorderWidthLeft()
Gets the width of a border. |
float |
getBorderWidthRight()
Gets the width of a border. |
float |
getBorderWidthTop()
Gets the width of a border. |
float |
getBottom()
Returns the lower left y-coordinate. |
float |
getBottom(float margin)
Returns the lower left y-coordinate, considering a given margin. |
ArrayList |
getChunks()
Gets all the chunks in this element. |
float |
getGrayFill()
Gets the grayscale. |
float |
getHeight()
Returns the height of the rectangle. |
float |
getLeft()
Returns the lower left x-coordinate. |
float |
getLeft(float margin)
Returns the lower left x-coordinate, considering a given margin. |
float |
getRight()
Returns the upper right x-coordinate. |
float |
getRight(float margin)
Returns the upper right x-coordinate, considering a given margin. |
int |
getRotation()
Gets the rotation of the rectangle |
float |
getTop()
Returns the upper right y-coordinate. |
float |
getTop(float margin)
Returns the upper right y-coordinate, considering a given margin. |
float |
getWidth()
Returns the width of the rectangle. |
boolean |
hasBorder(int type)
Indicates if the table has a some type of border. |
boolean |
hasBorders()
Indicates if the table has borders. |
boolean |
isContent()
Checks if this element is a content object. |
boolean |
isNestable()
Checks if this element is nestable. |
boolean |
isUseVariableBorders()
Indicates whether variable width borders are being used. |
void |
normalize()
Switches lowerleft with upperright |
boolean |
process(ElementListener listener)
Processes the element by adding it (or the different parts) to an
ElementListener. |
Rectangle |
rectangle(float top,
float bottom)
Gets a Rectangle that is altered to fit on the page. |
Rectangle |
rotate()
Swaps the values of urx and ury and of lly and llx in order to rotate the rectangle. |
void |
setBackgroundColor(Color value)
Sets the backgroundcolor of the rectangle. |
void |
setBorder(int value)
Enables/Disables the border on the specified sides. |
void |
setBorderColor(Color value)
Sets the color of the border. |
void |
setBorderColorBottom(Color value)
Sets the value of the border color |
void |
setBorderColorLeft(Color value)
Sets the value of the border color |
void |
setBorderColorRight(Color value)
Sets the value of the border color |
void |
setBorderColorTop(Color value)
Sets the value of the border color |
void |
setBorderWidth(float value)
Sets the borderwidth of the table. |
void |
setBorderWidthBottom(float borderWidthBottom)
Sets the width of a border |
void |
setBorderWidthLeft(float borderWidthLeft)
Sets the width of a border |
void |
setBorderWidthRight(float borderWidthRight)
Sets the width of a border |
void |
setBorderWidthTop(float borderWidthTop)
Sets the width of a border |
void |
setBottom(float value)
Sets the lower left y-coordinate. |
void |
setGrayFill(float value)
Sets the grayscale of the rectangle. |
void |
setLeft(float value)
Sets the lower left x-coordinate. |
void |
setRight(float value)
Sets the upper right x-coordinate. |
void |
setTop(float value)
Sets the upper right y-coordinate. |
void |
setUseVariableBorders(boolean useVariableBorders)
Sets a parameter indicating if the rectangle has variable borders |
void |
softCloneNonPositionParameters(Rectangle rect)
Copies all of the parameters from a Rectangle object
except the position. |
String |
toString()
Gets the content of the text element. |
int |
type()
Gets the type of the text element. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
public static final int UNDEFINED
public static final int TOP
Rectangle.
public static final int BOTTOM
Rectangle.
public static final int LEFT
Rectangle.
public static final int RIGHT
Rectangle.
public static final int NO_BORDER
public static final int BOX
| Constructor Detail |
public Rectangle(float llx,
float lly,
float urx,
float ury)
Rectangle -object.
llx - lower left xlly - lower left yurx - upper right xury - upper right y
public Rectangle(float urx,
float ury)
Rectangle -object starting from the origin
(0, 0).
urx - upper right xury - upper right ypublic Rectangle(Rectangle rect)
Rectangle -object.
rect - another Rectangle| Method Detail |
public boolean process(ElementListener listener)
ElementListener.
process in interface Elementlistener - an ElementListener
true if the element was processed successfullypublic int type()
type in interface Elementpublic ArrayList getChunks()
getChunks in interface ElementArrayListpublic boolean isContent()
Element
isContent in interface ElementElement.isContent()public boolean isNestable()
Element
isNestable in interface ElementElement.isNestable()public void setLeft(float value)
value - the new valuepublic float getLeft()
public float getLeft(float margin)
margin - a margin
public void setRight(float value)
value - the new valuepublic float getRight()
public float getRight(float margin)
margin - a margin
public float getWidth()
public void setTop(float value)
value - the new valuepublic float getTop()
public float getTop(float margin)
margin - a margin
public void setBottom(float value)
value - the new valuepublic float getBottom()
public float getBottom(float margin)
margin - a margin
public float getHeight()
public void normalize()
public int getRotation()
public Rectangle rotate()
Rectanglepublic int getBorder()
public boolean hasBorders()
public boolean hasBorder(int type)
type - the type of border
public void setBorder(int value)
LEFT, RIGHT, TOP, BOTTOM.
value - the new valueenableBorderSide(int),
disableBorderSide(int)public void enableBorderSide(int side)
side - the side to enable. One of LEFT, RIGHT, TOP, BOTTOM
public void disableBorderSide(int side)
side - the side to disable. One of LEFT, RIGHT, TOP, BOTTOM
public float getBorderWidth()
public void setBorderWidth(float value)
value - the new valuepublic Color getBorderColor()
public void setBorderColor(Color value)
value - the new valuepublic Color getBackgroundColor()
public void setBackgroundColor(Color value)
value - the new valuepublic float getGrayFill()
public void setGrayFill(float value)
value - the new valuepublic boolean isUseVariableBorders()
setBorderWidthLeft, setBorderWidthRight, setBorderWidthTop, or
setBorderWidthBottom has been called.
public void setUseVariableBorders(boolean useVariableBorders)
useVariableBorders - indication if the rectangle has variable borderspublic float getBorderWidthLeft()
public void setBorderWidthLeft(float borderWidthLeft)
borderWidthLeft - a widthpublic float getBorderWidthRight()
public void setBorderWidthRight(float borderWidthRight)
borderWidthRight - a widthpublic float getBorderWidthTop()
public void setBorderWidthTop(float borderWidthTop)
borderWidthTop - a widthpublic float getBorderWidthBottom()
public void setBorderWidthBottom(float borderWidthBottom)
borderWidthBottom - a widthpublic Color getBorderColorLeft()
public void setBorderColorLeft(Color value)
value - a color valuepublic Color getBorderColorRight()
public void setBorderColorRight(Color value)
value - a color valuepublic Color getBorderColorTop()
public void setBorderColorTop(Color value)
value - a color valuepublic Color getBorderColorBottom()
public void setBorderColorBottom(Color value)
value - a color value
public Rectangle rectangle(float top,
float bottom)
top - the top positionbottom - the bottom position
Rectanglepublic void cloneNonPositionParameters(Rectangle rect)
Rectangle object
except the position.
rect - Rectangle to copy frompublic void softCloneNonPositionParameters(Rectangle rect)
Rectangle object
except the position.
rect - Rectangle to copy frompublic String toString()
Element
toString in interface ElementObject.toString()
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||