Class RtfTableCell
java.lang.Object
org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer
org.apache.fop.render.rtf.rtflib.rtfdoc.RtfTableCell
- All Implemented Interfaces:
IRtfExternalGraphicContainer,IRtfListContainer,IRtfParagraphContainer,IRtfTableContainer,IRtfTextrunContainer
public class RtfTableCell
extends RtfContainer
implements IRtfParagraphContainer, IRtfListContainer, IRtfTableContainer, IRtfExternalGraphicContainer, IRtfTextrunContainer
A cell in an RTF table, container for paragraphs, lists, etc.
This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch).
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intdefault cell width (in twips ??)static final intcell merging: this cell is the start of a range of merged cellsstatic final intcell merging: this cell is part of (but not the start of) a range of merged cellsstatic final intcell merging: this cell is not mergedFields inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
attrib, parent, writer -
Method Summary
Modifier and TypeMethodDescriptionvoidfinish()The last paragraph break was just stored before, now the control word is really switchedintgetRow()Get the parent row.Returns the current RtfTextrun object.intbooleanisEmpty()A table cell always contains "useful" content, as it is here to take some space in a row.newImage()Start a new external graphic after closing current paragraph, list and tablenewList(RtfAttributes attrib) Start a new list after closing current paragraph, list and tableStart a new paragraph with default attributes after closing current paragraph, list and tablenewParagraph(RtfAttributes attrs) Start a new paragraph after closing current current paragraph, list and tableStart a new nested table after closing current paragraph, list and tablenewTable(RtfAttributes attrs, ITableColumnsInfo tc) Start a new nested table after closing current paragraph, list and tablevoidsetHMerge(int mergeStatus) Set horizontal cell merging statusvoidsetLastParagraph(RtfParagraphBreak parBreak) The table cell decides whether or not a newly added paragraph break will be used to write the cell-end control word.voidsetVMerge(int mergeStatus) protected voidOverriden to avoid writing any it's a merged cell.protected voidCalled before writeRtfContent; overriden to avoid writing any it's a merged cell.protected voidThe "cell" control word marks the end of a cellMethods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer
addChild, findChildren, getChildCount, getChildren, okToWriteRtf, setChildren, setOptions, toStringMethods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
close, getParentOfClass, getRtfAttributes, newLine, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeStarControlWord, writeStarControlWordNS
-
Field Details
-
DEFAULT_CELL_WIDTH
public static final int DEFAULT_CELL_WIDTHdefault cell width (in twips ??)- See Also:
-
NO_MERGE
public static final int NO_MERGEcell merging: this cell is not merged- See Also:
-
MERGE_START
public static final int MERGE_STARTcell merging: this cell is the start of a range of merged cells- See Also:
-
MERGE_WITH_PREVIOUS
public static final int MERGE_WITH_PREVIOUScell merging: this cell is part of (but not the start of) a range of merged cells- See Also:
-
-
Method Details
-
newParagraph
Start a new paragraph after closing current current paragraph, list and table- Specified by:
newParagraphin interfaceIRtfParagraphContainer- Parameters:
attrs- attributes of new RtfParagraph- Returns:
- new RtfParagraph object
- Throws:
IOException- for I/O problems
-
newImage
Start a new external graphic after closing current paragraph, list and table- Specified by:
newImagein interfaceIRtfExternalGraphicContainer- Returns:
- new RtfExternalGraphic object
- Throws:
IOException- for I/O problems
-
newParagraph
Start a new paragraph with default attributes after closing current paragraph, list and table- Specified by:
newParagraphin interfaceIRtfParagraphContainer- Returns:
- new RtfParagraph object
- Throws:
IOException- for I/O problems
-
newList
Start a new list after closing current paragraph, list and table- Specified by:
newListin interfaceIRtfListContainer- Parameters:
attrib- attributes for new RtfList- Returns:
- new RtfList object
- Throws:
IOException- for I/O problems
-
newTable
Start a new nested table after closing current paragraph, list and table- Specified by:
newTablein interfaceIRtfTableContainer- Parameters:
tc- table column info for new RtfTable- Returns:
- new RtfTable object
- Throws:
IOException- for I/O problems
-
newTable
Start a new nested table after closing current paragraph, list and table- Specified by:
newTablein interfaceIRtfTableContainer- Parameters:
attrs- attributes of new RtfTabletc- table column info for new RtfTable- Returns:
- new RtfTable object
- Throws:
IOException- for I/O problems
-
writeRtfContent
Overriden to avoid writing any it's a merged cell.- Overrides:
writeRtfContentin classRtfContainer- Throws:
IOException- for I/O problems
-
writeRtfPrefix
Called before writeRtfContent; overriden to avoid writing any it's a merged cell.- Overrides:
writeRtfPrefixin classRtfElement- Throws:
IOException- for I/O problems
-
writeRtfSuffix
The "cell" control word marks the end of a cell- Overrides:
writeRtfSuffixin classRtfElement- Throws:
IOException- for I/O problems
-
setVMerge
public void setVMerge(int mergeStatus) - Parameters:
mergeStatus- vertical cell merging status to set
-
getVMerge
public int getVMerge()- Returns:
- vertical cell merging status
-
setHMerge
public void setHMerge(int mergeStatus) Set horizontal cell merging status- Parameters:
mergeStatus- mergeStatus to set
-
getHMerge
public int getHMerge()- Returns:
- horizontal cell merging status
-
isEmpty
public boolean isEmpty()A table cell always contains "useful" content, as it is here to take some space in a row. Use containsText() to find out if there is really some useful content in the cell. TODO: containsText could use the original isEmpty implementation?- Overrides:
isEmptyin classRtfContainer- Returns:
- false (always)
-
getTextrun
Returns the current RtfTextrun object. Opens a new one if necessary.- Specified by:
getTextrunin interfaceIRtfTextrunContainer- Returns:
- The RtfTextrun object
- Throws:
IOException- Thrown when an IO-problem occurs
-
getRow
Get the parent row.- Returns:
- The parent row.
-
setLastParagraph
The table cell decides whether or not a newly added paragraph break will be used to write the cell-end control word. For nested tables it is not necessary.- Parameters:
parBreak- the paragraph break element
-
finish
public void finish()The last paragraph break was just stored before, now the control word is really switched
-