Package org.apache.poi.hwpf.model.types
Class TCAbstractType
java.lang.Object
org.apache.poi.hwpf.model.types.TCAbstractType
- Direct Known Subclasses:
TableCellDescriptor
Table Cell Descriptor.
NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/types/definitions.
This class is internal. It content or properties may change without notice due to changes in our knowledge of internal Microsoft Word binary structures.
- Author:
- S. Ryan Ackley. Field descriptions are quoted from Microsoft Office Word 97-2007 Binary File Format (.doc) Specification
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected shortprotected byteprotected byteprotected shortprotected shortprotected shortprotected shortprotected byteprotected byteprotected byteprotected byteprotected shortprotected BorderCodeprotected BorderCodeprotected BorderCodeprotected BorderCodeprotected ShadingDescriptorprotected shortprotected shortprotected shortprotected shortprotected byteprotected byte -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionBottom border.Left border.Right border.Top border.byteBottom cell margin/padding units.byteLeft cell margin/padding units.byteRight cell margin/padding units.byteTop cell margin/padding units.byteBottom cell spacing units.byteLeft cell spacing units.byteRight cell spacing units.byteTop cell spacing units.byteUnits for wWidthbyteNot usedshortgetRgf()Get the rgf field for the TC record.getShd()Cell shading.byteSpecifies the alignment of the cell contents relative to text flow (e.g.shortBottom cell margin/padding.shortLeft cell margin/padding.shortRight cell margin/padding.shortTop cell margin/padding.shortBottom cell spacing.shortLeft cell spacing.shortRight cell spacing.shortTop cell spacing.shortPreferred cell width.booleanFor a vertical table cell, text flow is bottom to top when 1 and is bottom to top when 0booleanWhen 1, cell is first cell of a range of cells that have been merged.booleanWhen 1, make the text fit the table cellbooleanWhen 1, cell has been merged with preceding cellbooleanWhen 1, do not allow text to wrap in the table cellbooleanWhen 1, cell has rotated characters (i.e.booleanWhen 1, cell has vertical text flowbooleanWhen 1, cell is vertically merged with the cell(s) above and/or below.booleanWhen 1, the cell is the first of a set of vertically merged cells.voidsetBrcBottom(BorderCode field_22_brcBottom) Bottom border.voidsetBrcLeft(BorderCode field_21_brcLeft) Left border.voidsetBrcRight(BorderCode field_23_brcRight) Right border.voidsetBrcTop(BorderCode field_20_brcTop) Top border.voidsetFBackward(boolean value) Sets the fBackward field value.voidsetFFirstMerged(boolean value) Sets the fFirstMerged field value.voidsetFFitText(boolean value) Sets the fFitText field value.voidsetFMerged(boolean value) Sets the fMerged field value.voidsetFNoWrap(boolean value) Sets the fNoWrap field value.voidsetFRotateFont(boolean value) Sets the fRotateFont field value.voidsetFtsCellPaddingBottom(byte field_10_ftsCellPaddingBottom) Bottom cell margin/padding units.voidsetFtsCellPaddingLeft(byte field_8_ftsCellPaddingLeft) Left cell margin/padding units.voidsetFtsCellPaddingRight(byte field_11_ftsCellPaddingRight) Right cell margin/padding units.voidsetFtsCellPaddingTop(byte field_9_ftsCellPaddingTop) Top cell margin/padding units.voidsetFtsCellSpacingBottom(byte field_18_ftsCellSpacingBottom) Bottom cell spacing units.voidsetFtsCellSpacingLeft(byte field_16_ftsCellSpacingLeft) Left cell spacing units.voidsetFtsCellSpacingRight(byte field_19_ftsCellSpacingRight) Right cell spacing units.voidsetFtsCellSpacingTop(byte field_17_ftsCellSpacingTop) Top cell spacing units.voidsetFtsWidth(byte value) Sets the ftsWidth field value.voidsetFUnused(byte value) Sets the fUnused field value.voidsetFVertical(boolean value) Sets the fVertical field value.voidsetFVertMerge(boolean value) Sets the fVertMerge field value.voidsetFVertRestart(boolean value) Sets the fVertRestart field value.voidsetRgf(short field_1_rgf) Set the rgf field for the TC record.voidsetShd(ShadingDescriptor field_3_shd) Cell shading.voidsetVertAlign(byte value) Sets the vertAlign field value.voidsetWCellPaddingBottom(short field_6_wCellPaddingBottom) Bottom cell margin/padding.voidsetWCellPaddingLeft(short field_4_wCellPaddingLeft) Left cell margin/padding.voidsetWCellPaddingRight(short field_7_wCellPaddingRight) Right cell margin/padding.voidsetWCellPaddingTop(short field_5_wCellPaddingTop) Top cell margin/padding.voidsetWCellSpacingBottom(short field_14_wCellSpacingBottom) Bottom cell spacing.voidsetWCellSpacingLeft(short field_12_wCellSpacingLeft) Left cell spacing.voidsetWCellSpacingRight(short field_15_wCellSpacingRight) Right cell spacing.voidsetWCellSpacingTop(short field_13_wCellSpacingTop) Top cell spacing.voidsetWWidth(short field_2_wWidth) Preferred cell width.toString()
-
Field Details
-
field_1_rgf
protected short field_1_rgf -
field_2_wWidth
protected short field_2_wWidth -
field_3_shd
-
field_4_wCellPaddingLeft
protected short field_4_wCellPaddingLeft -
field_5_wCellPaddingTop
protected short field_5_wCellPaddingTop -
field_6_wCellPaddingBottom
protected short field_6_wCellPaddingBottom -
field_7_wCellPaddingRight
protected short field_7_wCellPaddingRight -
field_8_ftsCellPaddingLeft
protected byte field_8_ftsCellPaddingLeft -
field_9_ftsCellPaddingTop
protected byte field_9_ftsCellPaddingTop -
field_10_ftsCellPaddingBottom
protected byte field_10_ftsCellPaddingBottom -
field_11_ftsCellPaddingRight
protected byte field_11_ftsCellPaddingRight -
field_12_wCellSpacingLeft
protected short field_12_wCellSpacingLeft -
field_13_wCellSpacingTop
protected short field_13_wCellSpacingTop -
field_14_wCellSpacingBottom
protected short field_14_wCellSpacingBottom -
field_15_wCellSpacingRight
protected short field_15_wCellSpacingRight -
field_16_ftsCellSpacingLeft
protected byte field_16_ftsCellSpacingLeft -
field_17_ftsCellSpacingTop
protected byte field_17_ftsCellSpacingTop -
field_18_ftsCellSpacingBottom
protected byte field_18_ftsCellSpacingBottom -
field_19_ftsCellSpacingRight
protected byte field_19_ftsCellSpacingRight -
field_20_brcTop
-
field_21_brcLeft
-
field_22_brcBottom
-
field_23_brcRight
-
-
Constructor Details
-
TCAbstractType
protected TCAbstractType()
-
-
Method Details
-
toString
-
getRgf
Get the rgf field for the TC record. -
setRgf
Set the rgf field for the TC record. -
getWWidth
Preferred cell width. -
setWWidth
Preferred cell width. -
getShd
Cell shading. -
setShd
Cell shading. -
getWCellPaddingLeft
Left cell margin/padding. -
setWCellPaddingLeft
Left cell margin/padding. -
getWCellPaddingTop
Top cell margin/padding. -
setWCellPaddingTop
Top cell margin/padding. -
getWCellPaddingBottom
Bottom cell margin/padding. -
setWCellPaddingBottom
Bottom cell margin/padding. -
getWCellPaddingRight
Right cell margin/padding. -
setWCellPaddingRight
Right cell margin/padding. -
getFtsCellPaddingLeft
Left cell margin/padding units. -
setFtsCellPaddingLeft
Left cell margin/padding units. -
getFtsCellPaddingTop
Top cell margin/padding units. -
setFtsCellPaddingTop
Top cell margin/padding units. -
getFtsCellPaddingBottom
Bottom cell margin/padding units. -
setFtsCellPaddingBottom
Bottom cell margin/padding units. -
getFtsCellPaddingRight
Right cell margin/padding units. -
setFtsCellPaddingRight
Right cell margin/padding units. -
getWCellSpacingLeft
Left cell spacing. -
setWCellSpacingLeft
Left cell spacing. -
getWCellSpacingTop
Top cell spacing. -
setWCellSpacingTop
Top cell spacing. -
getWCellSpacingBottom
Bottom cell spacing. -
setWCellSpacingBottom
Bottom cell spacing. -
getWCellSpacingRight
Right cell spacing. -
setWCellSpacingRight
Right cell spacing. -
getFtsCellSpacingLeft
Left cell spacing units. -
setFtsCellSpacingLeft
Left cell spacing units. -
getFtsCellSpacingTop
Top cell spacing units. -
setFtsCellSpacingTop
Top cell spacing units. -
getFtsCellSpacingBottom
Bottom cell spacing units. -
setFtsCellSpacingBottom
Bottom cell spacing units. -
getFtsCellSpacingRight
Right cell spacing units. -
setFtsCellSpacingRight
Right cell spacing units. -
getBrcTop
Top border. -
setBrcTop
Top border. -
getBrcLeft
Left border. -
setBrcLeft
Left border. -
getBrcBottom
Bottom border. -
setBrcBottom
Bottom border. -
getBrcRight
Right border. -
setBrcRight
Right border. -
setFFirstMerged
Sets the fFirstMerged field value. When 1, cell is first cell of a range of cells that have been merged. When a cell is merged, the display areas of the merged cells are consolidated and the text within the cells is interpreted as belonging to one text stream for purposes of calculating line breaks. -
isFFirstMerged
When 1, cell is first cell of a range of cells that have been merged. When a cell is merged, the display areas of the merged cells are consolidated and the text within the cells is interpreted as belonging to one text stream for purposes of calculating line breaks.- Returns:
- the fFirstMerged field value.
-
setFMerged
Sets the fMerged field value. When 1, cell has been merged with preceding cell -
isFMerged
When 1, cell has been merged with preceding cell- Returns:
- the fMerged field value.
-
setFVertical
Sets the fVertical field value. When 1, cell has vertical text flow -
isFVertical
When 1, cell has vertical text flow- Returns:
- the fVertical field value.
-
setFBackward
Sets the fBackward field value. For a vertical table cell, text flow is bottom to top when 1 and is bottom to top when 0 -
isFBackward
For a vertical table cell, text flow is bottom to top when 1 and is bottom to top when 0- Returns:
- the fBackward field value.
-
setFRotateFont
Sets the fRotateFont field value. When 1, cell has rotated characters (i.e. uses @font) -
isFRotateFont
When 1, cell has rotated characters (i.e. uses @font)- Returns:
- the fRotateFont field value.
-
setFVertMerge
Sets the fVertMerge field value. When 1, cell is vertically merged with the cell(s) above and/or below. When cells are vertically merged, the display area of the merged cells are consolidated. The consolidated area is used to display the contents of the first vertically merged cell (the cell with fVertRestart set to 1), and all other vertically merged cells (those with fVertRestart set to 0) must be empty. Cells can only be merged vertically if their left and right boundaries are (nearly) identical (i.e. if corresponding entries in rgdxaCenter of the table rows differ by at most 3). -
isFVertMerge
When 1, cell is vertically merged with the cell(s) above and/or below. When cells are vertically merged, the display area of the merged cells are consolidated. The consolidated area is used to display the contents of the first vertically merged cell (the cell with fVertRestart set to 1), and all other vertically merged cells (those with fVertRestart set to 0) must be empty. Cells can only be merged vertically if their left and right boundaries are (nearly) identical (i.e. if corresponding entries in rgdxaCenter of the table rows differ by at most 3).- Returns:
- the fVertMerge field value.
-
setFVertRestart
Sets the fVertRestart field value. When 1, the cell is the first of a set of vertically merged cells. The contents of a cell with fVertStart set to 1 are displayed in the consolidated area belonging to the entire set of vertically merged cells. Vertically merged cells with fVertRestart set to 0 must be empty. -
isFVertRestart
When 1, the cell is the first of a set of vertically merged cells. The contents of a cell with fVertStart set to 1 are displayed in the consolidated area belonging to the entire set of vertically merged cells. Vertically merged cells with fVertRestart set to 0 must be empty.- Returns:
- the fVertRestart field value.
-
setVertAlign
Sets the vertAlign field value. Specifies the alignment of the cell contents relative to text flow (e.g. in a cell with bottom to top text flow and bottom vertical alignment, the text is shifted horizontally to match the cell's right boundary) -
getVertAlign
Specifies the alignment of the cell contents relative to text flow (e.g. in a cell with bottom to top text flow and bottom vertical alignment, the text is shifted horizontally to match the cell's right boundary)- Returns:
- the vertAlign field value.
-
setFtsWidth
Sets the ftsWidth field value. Units for wWidth -
getFtsWidth
Units for wWidth- Returns:
- the ftsWidth field value.
-
setFFitText
Sets the fFitText field value. When 1, make the text fit the table cell -
isFFitText
When 1, make the text fit the table cell- Returns:
- the fFitText field value.
-
setFNoWrap
Sets the fNoWrap field value. When 1, do not allow text to wrap in the table cell -
isFNoWrap
When 1, do not allow text to wrap in the table cell- Returns:
- the fNoWrap field value.
-
setFUnused
Sets the fUnused field value. Not used -
getFUnused
Not used- Returns:
- the fUnused field value.
-