Package com.lowagie.text.rtf.table
Class RtfBorderGroup
java.lang.Object
com.lowagie.text.rtf.RtfElement
com.lowagie.text.rtf.table.RtfBorderGroup
- All Implemented Interfaces:
RtfBasicElement
,com.lowagie.text.RtfElementInterface
The RtfBorderGroup represents a collection of RtfBorders to use in a RtfCell
or RtfTable.
- Version:
- $Id: RtfBorderGroup.java 3427 2008-05-24 18:32:31Z xlv $
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe borders in this RtfBorderGroupprivate int
The type of borders this RtfBorderGroup contains.Fields inherited from class com.lowagie.text.rtf.RtfElement
document, inHeader, inTable
Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR
-
Constructor Summary
ConstructorsModifierConstructorDescriptionConstructs an empty RtfBorderGroup.RtfBorderGroup
(int bordersToAdd, int borderStyle, float borderWidth, Color borderColor) Constructs a RtfBorderGroup with on border style for multiple borders.protected
RtfBorderGroup
(RtfDocument doc, int borderType, int bordersToUse, float borderWidth, Color borderColor) Constructs a RtfBorderGroup with certain bordersprotected
RtfBorderGroup
(RtfDocument doc, int borderType, RtfBorderGroup borderGroup) Constructs a RtfBorderGroup based on another RtfBorderGroup. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds borders to the RtfBorderGroupGets the RtfBorders of this RtfBorderGroupvoid
removeBorder
(int bordersToRemove) Removes borders from the list of bordersprivate void
Sets a border in the Hashtable of bordersvoid
writeContent
(OutputStream result) Writes the borders of this RtfBorderGroupMethods inherited from class com.lowagie.text.rtf.RtfElement
intToByteArray, isInTable, setInHeader, setInTable, setRtfDocument
-
Field Details
-
borderType
private int borderTypeThe type of borders this RtfBorderGroup contains. RtfBorder.ROW_BORDER or RtfBorder.CELL_BORDER -
borders
The borders in this RtfBorderGroup
-
-
Constructor Details
-
RtfBorderGroup
public RtfBorderGroup()Constructs an empty RtfBorderGroup. -
RtfBorderGroup
Constructs a RtfBorderGroup with on border style for multiple borders.- Parameters:
bordersToAdd
- The borders to add (Rectangle.LEFT, Rectangle.RIGHT, Rectangle.TOP, Rectangle.BOTTOM, Rectangle.BOX)borderStyle
- The style of border to add (from RtfBorder)borderWidth
- The border width to useborderColor
- The border color to use
-
RtfBorderGroup
Constructs a RtfBorderGroup based on another RtfBorderGroup.- Parameters:
doc
- The RtfDocument this RtfBorderGroup belongs toborderType
- The type of borders this RtfBorderGroup containsborderGroup
- The RtfBorderGroup to use as a base
-
RtfBorderGroup
protected RtfBorderGroup(RtfDocument doc, int borderType, int bordersToUse, float borderWidth, Color borderColor) Constructs a RtfBorderGroup with certain borders- Parameters:
doc
- The RtfDocument this RtfBorderGroup belongs toborderType
- The type of borders this RtfBorderGroup containsbordersToUse
- The borders to add (Rectangle.LEFT, Rectangle.RIGHT, Rectangle.TOP, Rectangle.BOTTOM, Rectangle.BOX)borderWidth
- The border width to useborderColor
- The border color to use
-
-
Method Details
-
setBorder
Sets a border in the Hashtable of borders- Parameters:
borderPosition
- The position of this RtfBorderborderStyle
- The type of borders this RtfBorderGroup containsborderWidth
- The border width to useborderColor
- The border color to use
-
addBorder
Adds borders to the RtfBorderGroup- Parameters:
bordersToAdd
- The borders to add (Rectangle.LEFT, Rectangle.RIGHT, Rectangle.TOP, Rectangle.BOTTOM, Rectangle.BOX)borderStyle
- The style of border to add (from RtfBorder)borderWidth
- The border width to useborderColor
- The border color to use
-
removeBorder
public void removeBorder(int bordersToRemove) Removes borders from the list of borders- Parameters:
bordersToRemove
- The borders to remove (from Rectangle)
-
writeContent
Writes the borders of this RtfBorderGroup- Specified by:
writeContent
in interfaceRtfBasicElement
- Specified by:
writeContent
in classRtfElement
- Parameters:
result
- TheOutputStream
to write the content to- Throws:
IOException
-
getBorders
Gets the RtfBorders of this RtfBorderGroup- Returns:
- The RtfBorders of this RtfBorderGroup
-