Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class ExtendedFormatRecord

extends StandardRecord
Class Inheritance
Static Imports
org.apache.poi.util.GenericRecordUtil.getBitsAsString, .GenericRecordUtil.getEnumBitsAsString
Probably one of the more complex records.

There are two breeds: Style and Cell.

It should be noted that fields in the extended format record are somewhat arbitrary. Almost all of the fields are bit-level, but we name them as best as possible by functional group. In some places this is better than others.

Since
2.0-pre

Field Summary

Modifier and TypeField and Description
private static final BitField
_123_prefix

private static final BitField
_adtl_diag

private static final BitField
_adtl_diag_line_style

private static final BitField
_adtl_fill_pattern

private static final BitField
_alignment

private static final BitField
_border_bottom

private static final BitField
_border_left

private static final BitField
_border_right

private static final BitField
_border_top

private static final BitField
_bottom_border_palette_idx

private static final BitField
_diag

private static final BitField
_fill_background

private static final BitField
_fill_foreground

private static final BitField
_hidden

private static final BitField
_indent

private static final BitField
_indent_not_parent_alignment

private static final BitField
_indent_not_parent_border

private static final BitField
_indent_not_parent_cell_options

private static final BitField
_indent_not_parent_font

private static final BitField
_indent_not_parent_format

private static final BitField
_indent_not_parent_pattern

private static final BitField
_justify_last

private static final BitField
_left_border_palette_idx

private static final BitField
_locked

private static final BitField
_merge_cells

private static final BitField
_parent_index

private static final BitField
_reading_order

private static final BitField
_right_border_palette_idx

private static final BitField
_rotation

private static final BitField
_shrink_to_fit

private static final BitField
_top_border_palette_idx

private static final BitField
_vertical_alignment

private static final BitField
_wrap_text

private static final BitField
_xf_type

public static final short
ALT_BARS

public static final short
BIG_SPOTS

public static final short
BRICKS

public static final short
CENTER

public static final short
CENTER_SELECTION

public static final short
DASH_DOT

public static final short
DASH_DOT_DOT

public static final short
DASHED

public static final short
DIAMONDS

public static final short
DOTTED

public static final short
DOUBLE

private short
field_1_font_index

private short
field_2_format_index

private short
field_3_cell_options

private short
field_4_alignment_options

private short
field_5_indention_options

private short
field_6_border_options

private short
field_7_palette_options

private int
field_8_adtl_palette_options

private short
field_9_fill_palette_options

public static final short
FILL

public static final short
FINE_DOTS

public static final short
GENERAL

public static final short
HAIR

public static final short
JUSTIFY

public static final short
LEFT

public static final short
MEDIUM

public static final short
MEDIUM_DASH_DOT

public static final short
MEDIUM_DASH_DOT_DOT

public static final short
MEDIUM_DASHED

public static final short
NO_FILL

public static final short
NONE

public static final short
NULL

public static final short
RIGHT

public static final short
sid

public static final short
SLANTED_DASH_DOT

public static final short
SOLID_FILL

public static final short
SPARSE_DOTS

public static final short
SQUARES

public static final short
THICK

public static final short
THICK_BACKWARD_DIAG

public static final short
THICK_FORWARD_DIAG

public static final short
THICK_HORZ_BANDS

public static final short
THICK_VERT_BANDS

public static final short
THIN

public static final short
THIN_BACKWARD_DIAG

public static final short
THIN_FORWARD_DIAG

public static final short
THIN_HORZ_BANDS

public static final short
THIN_VERT_BANDS

public static final short
VERTICAL_BOTTOM

public static final short
VERTICAL_CENTER

public static final short
VERTICAL_JUSTIFY

public static final short
VERTICAL_TOP

public static final short
XF_CELL

public static final short
XF_STYLE

Constructor Summary

AccessConstructor and Description
public
ExtendedFormatRecord()

public
ExtendedFormatRecord(ExtendedFormatRecord other)

public
ExtendedFormatRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
private static BitField
bf(int i)

public void
cloneStyleFrom(ExtendedFormatRecord
the ExtendedFormatRecord to copy from
source)

Clones all the style information from another ExtendedFormatRecord, onto this one.

public ExtendedFormatRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Will consider two different records with the same contents as equals, as the various indexes that matter are embedded in the records

public boolean

Returns:

prefix - the lotus thing
get123Prefix()

get some old holdover from lotus 123.

public short

Returns:

diag - the palette index?
getAdtlDiag()

get for diagonal borders?

public short

Returns:

diag - the line style
getAdtlDiagLineStyle()

get the diagonal border line style?

public short

Returns:

fill - fill pattern??
getAdtlFillPattern()

get the additional fill pattern

public int

Returns:

options - bitmask to set
getAdtlPaletteOptions()

get the additional palette options bitmask (see individual bit getter methods that reference this method)

public short

Returns:

align - how to align the cell (see constants)
getAlignment()

get the horizontal alignment of the cell.

public short

Returns:

options - the bitmask
getAlignmentOptions()

get the alignment options bitmask.

public short

Returns:

border - type of border for the bottom of the cell
getBorderBottom()

get the borderline style for the bottom border

public short

Returns:

border - type of border for the left side of the cell
getBorderLeft()

get the borderline style for the left border

public short

Returns:

options - the bit mask to set
getBorderOptions()

get the border options bitmask (see the corresponding bit getter methods that reference back to this one)

public short

Returns:

border - type of border for the right side of the cell
getBorderRight()

get the borderline style for the right border

public short

Returns:

border - type of border for the top of the cell
getBorderTop()

get the borderline style for the top border

public short

Returns:

border - palette index
getBottomBorderPaletteIdx()

get the palette index for the bottom border

public short

Returns:

options bitmask
getCellOptions()

gets the options bitmask - you can also use corresponding option bit getters (see other methods that reference this one)

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

public short

Returns:

diag - whatever it is that this is.
getDiag()

Not sure what this is for (maybe fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..

public short

Returns:

color palette index
getFillBackground()

get the background palette color index

public short

Returns:

color - palette index
getFillForeground()

get the foreground palette color index

public short

Returns:

options
getFillPaletteOptions()

get the fill palette options bitmask (see indivdual bit getters that reference this method)

public short

Returns:

index to the font
getFontIndex()

get the index to the FONT record (which font to use 0 based)

public short

Returns:

index to the format record
getFormatIndex()

get the index to the Format record (which FORMAT to use 0-based)

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public short

Returns:

indent - how far to indent the cell
getIndent()

get indention (not sure of the units, think its spaces)

public short

Returns:

options bitmask
getIndentionOptions()

get the indent options bitmask (see corresponding bit getters that reference this field)

public short

Returns:

justify
getJustifyLast()

Dunno.

public short

Returns:

border - palette index
getLeftBorderPaletteIdx()

get the palette index for the left border color

public boolean

Returns:

merge - merge cells or not
getMergeCells()

get whether to merge cells

public short

Returns:

options - the bitmask
getPaletteOptions()

get the palette options bitmask (see the individual bit getter methods that reference this one)

public short

Returns:

index of parent XF
getParentIndex()

for cell XF types this is the parent style (usually 0/normal).

public short

Returns:

order - the reading order (0,1,2)
getReadingOrder()

get the reading order for far east versions (0 - Context, 1 - Left to right, 2 - right to left) - We could use some help with support for the far east.

public short

Returns:

border - palette index
getRightBorderPaletteIdx()

get the palette index for the right border color

public short

Returns:

rotation - the degree of rotation
getRotation()

get the degree of rotation.

public boolean

Returns:

shrink - shrink to fit or not
getShrinkToFit()

get whether to shrink the text to fit

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public short

Returns:

border - palette index
getTopBorderPaletteIdx()

get the palette index for the top border

public short

Returns:

where to align the text
getVerticalAlignment()

get the vertical alignment of text in the cell

public boolean

Returns:

wrapped - whether or not to wrap the cell text
getWrapText()

get whether to wrap the text in the cell

public short

Returns:

type - cell or style (0/1)
getXFType()

get whether the cell is a cell or style XFRecord

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean

Returns:

hidden - if the cell is hidden
isHidden()

get whether the cell is hidden or not

public boolean

Returns:

alignment true if this XF has a different alignment value than its parent, false otherwise.
isIndentNotParentAlignment()

get whether or not to use the alignment in this XF instead of the parent XF.

public boolean

Returns:

border - true if this XF has a different border value than its parent, false otherwise.
isIndentNotParentBorder()

get whether or not to use the border in this XF instead of the parent XF.

public boolean

Returns:

options- true if this XF has a different locking or hidden value than its parent, false otherwise.
isIndentNotParentCellOptions()

get whether or not to use the locking/hidden in this XF instead of the parent XF.

public boolean

Returns:

font - true if this XF has a different font value than its parent, false otherwise.
isIndentNotParentFont()

get whether or not to use the font in this XF instead of the parent XF.

public boolean

Returns:

parent - true if this XF has a different format value than its parent, false otherwise.
isIndentNotParentFormat()

get whether or not to use the format in this XF instead of the parent XF.

public boolean

Returns:

pattern- true if this XF has a different pattern value than its parent, false otherwise.
isIndentNotParentPattern()

get whether or not to use the pattern in this XF instead of the parent XF.

public boolean

Returns:

locked - if the cell is locked
isLocked()

get whether the cell is locked or not

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
set123Prefix(boolean
- the lotus thing to set.
prefix)

set some old holdover from lotus 123.

public void
setAdtlDiag(short
- the palette index?
diag)

set for diagonal borders?

public void
setAdtlDiagLineStyle(short
- the line style
diag)

set the diagonal border line style?

public void
setAdtlFillPattern(short
- fill pattern??
fill)

set the fill pattern

public void
setAdtlPaletteOptions(short
- bitmask to set
options)

set the additional palette options bitmask (see individual bitsetter methods that reference this method)

public void
setAlignment(short
- how to align the cell (see constants)
align)

set the horizontal alignment of the cell.

public void
setAlignmentOptions(short
- the bitmask to set
options)

set the alignment options bitmask.

public void
setBorderBottom(short
- type of border for the bottom of the cell
border)

set the border line style for the bottom border

public void
setBorderLeft(short
- type of border for the left side of the cell
border)

set the borderline style for the left border

public void
setBorderOptions(short
- the bit mask to set
options)

set the border options bitmask (see the corresponding bitsetter methods that reference back to this one)

public void
setBorderRight(short
- type of border for the right side of the cell
border)

set the border line style for the right border

public void
setBorderTop(short
- type of border for the top of the cell
border)

set the border line style for the top border

public void
setBottomBorderPaletteIdx(short
- palette index
border)

set the palette index for the bottom border

public void
setCellOptions(short
bitmask to set
options)

sets the options bitmask - you can also use corresponding option bit setters (see other methods that reference this one)

public void
setDiag(short
- set whatever it is that this is.
diag)

Not sure what this is for (maybe fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..

public void
setFillBackground(short
- palette index
color)

set the background palette color index

public void
setFillForeground(short
- palette index
color)

set the foreground palette color index

public void
setFillPaletteOptions(short
the palette options
options)

set the fill palette options bitmask (see bitfields for additional palette options)

public void
setFontIndex(short
to the font
index)

set the index to the FONT record (which font to use 0 based)

public void
setFormatIndex(short
to the format record
index)

set the index to the Format record (which FORMAT to use 0-based)

public void
setHidden(boolean
- if the cell is hidden
hidden)

set whether the cell is hidden or not

public void
setIndent(short
- how far to indent the cell
indent)

set indention (not sure of the units, think its spaces)

public void
setIndentionOptions(short
bitmask to set.
options)

set the indent options bitmask (see corresponding bitmask setters that reference this field)

public void
setIndentNotParentAlignment(boolean
true if this XF has a different alignment value than its parent, false otherwise.
alignment)

set whether or not to use the alignment in this XF instead of the parent XF.

public void
setIndentNotParentBorder(boolean
- true if this XF has a different border value than its parent, false otherwise.
border)

set whether or not to use the border in this XF instead of the parent XF.

public void
setIndentNotParentCellOptions(boolean
true if this XF has a different locking or hidden value than its parent, false otherwise.
options)

set whether or not to use the locking/hidden in this XF instead of the parent XF.

public void
setIndentNotParentFont(boolean
- true if this XF has a different font value than its parent, false otherwise.
font)

set whether or not to use the font in this XF instead of the parent XF.

public void
setIndentNotParentFormat(boolean
- true if this XF has a different format value than its parent, false otherwise.
parent)

set whether or not to use the format in this XF instead of the parent XF.

public void
setIndentNotParentPattern(boolean
true if this XF has a different pattern value than its parent, false otherwise.
pattern)

Sets whether or not to use the pattern in this XF instead of the parent XF (foreground/background).

public void
setJustifyLast(short
use 0 for US
justify)

Dunno.

public void
setLeftBorderPaletteIdx(short
- palette index
border)

set the palette index for the left border color

public void
setLocked(boolean
- if the cell is locked
locked)

set whether the cell is locked or not

public void
setMergeCells(boolean
- merge cells or not
merge)

set whether to merge cells

public void
setPaletteOptions(short
- the bitmask to set
options)

set the palette options bitmask (see the individual bitsetter methods that reference this one)

public void
setParentIndex(short
index of parent XF
parent)

for cell XF types this is the parent style (usually 0/normal).

public void
setReadingOrder(short
- the reading order (0,1,2)
order)

set the reading order for far east versions (0 - Context, 1 - Left to right, 2 - right to left) - We could use some help with support for the far east.

public void
setRightBorderPaletteIdx(short
- palette index
border)

set the palette index for the right border color

public void
setRotation(short
the degree of rotation
rotation)

set the degree of rotation.

public void
setShrinkToFit(boolean
- shrink to fit or not
shrink)

set whether to shrink the text to fit

public void
setTopBorderPaletteIdx(short
- palette index
border)

set the palette index for the top border

public void
setVerticalAlignment(short
where to align the text
align)

set the vertical alignment of text in the cell

public void
setWrapText(boolean
- whether or not to wrap the cell text
wrapped)

set whether to wrap the text in the cell

public void
setXFType(short
- cell or style (0/1)
type)

set whether the cell is a cell or style XFRecord

public int[]
stateSummary()

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize