Package com.lowagie.text
Class RectangleReadOnly
java.lang.Object
com.lowagie.text.Rectangle
com.lowagie.text.RectangleReadOnly
- All Implemented Interfaces:
Element
A
RectangleReadOnly
is the representation of a geometric figure. It's the same as a
Rectangle
but immutable. 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)
.- Since:
- 2.1.2
- See Also:
-
Field Summary
Fields inherited from class com.lowagie.text.Rectangle
backgroundColor, border, borderColor, borderColorBottom, borderColorLeft, borderColorRight, borderColorTop, borderWidth, borderWidthBottom, borderWidthLeft, borderWidthRight, borderWidthTop, BOTTOM, BOX, LEFT, llx, lly, NO_BORDER, offsetToTop, RIGHT, rotation, TOP, UNDEFINED, urx, ury, useVariableBorders
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, FOOTNOTE, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MODIFICATIONDATE, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK
-
Constructor Summary
ConstructorsConstructorDescriptionRectangleReadOnly
(float urx, float ury) Constructs aRectangleReadOnly
-object starting from the origin (0, 0).RectangleReadOnly
(float llx, float lly, float urx, float ury) Constructs aRectangleReadOnly
-object.RectangleReadOnly
(Rectangle rect) Constructs aRectangleReadOnly
-object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Copies each of the parameters, except the position, from aRectangle
objectvoid
disableBorderSide
(int side) Disables the border on the specified side.void
enableBorderSide
(int side) Enables the border on the specified side.void
Normalizes the rectangle.void
setBackgroundColor
(Color value) Sets the backgroundcolor of the rectangle.void
setBorder
(int border) Enables/Disables the border on the specified sides.void
setBorderColor
(Color borderColor) Sets the color of the border.void
setBorderColorBottom
(Color borderColorBottom) Sets the color of the bottom border.void
setBorderColorLeft
(Color borderColorLeft) Sets the color of the left border.void
setBorderColorRight
(Color borderColorRight) Sets the color of the right bordervoid
setBorderColorTop
(Color borderColorTop) Sets the color of the top border.void
setBorderWidth
(float borderWidth) Sets the borderwidth of the table.void
setBorderWidthBottom
(float borderWidthBottom) Sets the width of the bottom bordervoid
setBorderWidthLeft
(float borderWidthLeft) Sets the width of the left bordervoid
setBorderWidthRight
(float borderWidthRight) Sets the width of the right bordervoid
setBorderWidthTop
(float borderWidthTop) Sets the width of the top bordervoid
setBottom
(float lly) Sets the lower left y-coordinate.void
setGrayFill
(float value) Sets the grayscale of the rectangle.void
setLeft
(float llx) Sets the lower left x-coordinate.void
setRight
(float urx) Sets the upper right x-coordinate.void
setTop
(float ury) Sets the upper right y-coordinate.void
setUseVariableBorders
(boolean useVariableBorders) Sets a parameter indicating if the rectangle has variable bordersvoid
Copies each of the parameters, except the position, from aRectangle
object if the value is set there.private void
Throws an error because of the read only nature of this object.toString()
Gets the content of the text element.Methods inherited from class com.lowagie.text.Rectangle
getBackgroundColor, getBorder, getBorderColor, getBorderColorBottom, getBorderColorLeft, getBorderColorRight, getBorderColorTop, getBorderWidth, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getBottom, getBottom, getChunks, getGrayFill, getHeight, getLeft, getLeft, getRelativeTop, getRight, getRight, getRotation, getTop, getTop, getWidth, hasBorder, hasBorders, isContent, isNestable, isUseVariableBorders, process, rectangle, rotate, setRelativeTop, setRotation, type
-
Constructor Details
-
RectangleReadOnly
public RectangleReadOnly(float llx, float lly, float urx, float ury) Constructs aRectangleReadOnly
-object.- Parameters:
llx
- lower left xlly
- lower left yurx
- upper right xury
- upper right y
-
RectangleReadOnly
public RectangleReadOnly(float urx, float ury) Constructs aRectangleReadOnly
-object starting from the origin (0, 0).- Parameters:
urx
- upper right xury
- upper right y
-
RectangleReadOnly
Constructs aRectangleReadOnly
-object.- Parameters:
rect
- anotherRectangle
-
-
Method Details
-
throwReadOnlyError
private void throwReadOnlyError()Throws an error because of the read only nature of this object. -
setLeft
public void setLeft(float llx) Sets the lower left x-coordinate. -
setRight
public void setRight(float urx) Sets the upper right x-coordinate. -
setTop
public void setTop(float ury) Sets the upper right y-coordinate. -
setBottom
public void setBottom(float lly) Sets the lower left y-coordinate. -
normalize
public void normalize()Normalizes the rectangle. Switches lower left with upper right if necessary. -
setBackgroundColor
Sets the backgroundcolor of the rectangle.- Overrides:
setBackgroundColor
in classRectangle
- Parameters:
value
- the new value
-
setGrayFill
public void setGrayFill(float value) Sets the grayscale of the rectangle.- Overrides:
setGrayFill
in classRectangle
- Parameters:
value
- the new value
-
setBorder
public void setBorder(int border) Enables/Disables the border on the specified sides. The border is specified as an integer bitwise combination of the constants:LEFT, RIGHT, TOP, BOTTOM
. -
setUseVariableBorders
public void setUseVariableBorders(boolean useVariableBorders) Sets a parameter indicating if the rectangle has variable borders- Overrides:
setUseVariableBorders
in classRectangle
- Parameters:
useVariableBorders
- indication if the rectangle has variable borders
-
enableBorderSide
public void enableBorderSide(int side) Enables the border on the specified side.- Overrides:
enableBorderSide
in classRectangle
- Parameters:
side
- the side to enable. One ofLEFT, RIGHT, TOP, BOTTOM
-
disableBorderSide
public void disableBorderSide(int side) Disables the border on the specified side.- Overrides:
disableBorderSide
in classRectangle
- Parameters:
side
- the side to disable. One ofLEFT, RIGHT, TOP, BOTTOM
-
setBorderWidth
public void setBorderWidth(float borderWidth) Sets the borderwidth of the table.- Overrides:
setBorderWidth
in classRectangle
- Parameters:
borderWidth
- the new value
-
setBorderWidthLeft
public void setBorderWidthLeft(float borderWidthLeft) Sets the width of the left border- Overrides:
setBorderWidthLeft
in classRectangle
- Parameters:
borderWidthLeft
- a width
-
setBorderWidthRight
public void setBorderWidthRight(float borderWidthRight) Sets the width of the right border- Overrides:
setBorderWidthRight
in classRectangle
- Parameters:
borderWidthRight
- a width
-
setBorderWidthTop
public void setBorderWidthTop(float borderWidthTop) Sets the width of the top border- Overrides:
setBorderWidthTop
in classRectangle
- Parameters:
borderWidthTop
- a width
-
setBorderWidthBottom
public void setBorderWidthBottom(float borderWidthBottom) Sets the width of the bottom border- Overrides:
setBorderWidthBottom
in classRectangle
- Parameters:
borderWidthBottom
- a width
-
setBorderColor
Sets the color of the border.- Overrides:
setBorderColor
in classRectangle
- Parameters:
borderColor
- aColor
-
setBorderColorLeft
Sets the color of the left border.- Overrides:
setBorderColorLeft
in classRectangle
- Parameters:
borderColorLeft
- aColor
-
setBorderColorRight
Sets the color of the right border- Overrides:
setBorderColorRight
in classRectangle
- Parameters:
borderColorRight
- aColor
-
setBorderColorTop
Sets the color of the top border.- Overrides:
setBorderColorTop
in classRectangle
- Parameters:
borderColorTop
- aColor
-
setBorderColorBottom
Sets the color of the bottom border.- Overrides:
setBorderColorBottom
in classRectangle
- Parameters:
borderColorBottom
- aColor
-
cloneNonPositionParameters
Copies each of the parameters, except the position, from aRectangle
object- Overrides:
cloneNonPositionParameters
in classRectangle
- Parameters:
rect
-Rectangle
to copy from
-
softCloneNonPositionParameters
Copies each of the parameters, except the position, from aRectangle
object if the value is set there.- Overrides:
softCloneNonPositionParameters
in classRectangle
- Parameters:
rect
-Rectangle
to copy from
-
toString
Description copied from interface:Element
Gets the content of the text element.
-