Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.cf.FontFormatting

Field Summary

Modifier and Type	Field and Description
private final byte[]	_rawData
private static final BitField	CANCELLATION
public static final int	FONT_CELL_HEIGHT_PRESERVED
private static final short	FONT_WEIGHT_BOLD Bold boldness (bold)
private static final short	FONT_WEIGHT_NORMAL Normal boldness (not bold)
private static final int	OFFSET_ESCAPEMENT_TYPE
private static final int	OFFSET_ESCAPEMENT_TYPE_MODIFIED
private static final int	OFFSET_FONT_COLOR_INDEX
private static final int	OFFSET_FONT_FORMATING_END
private static final int	OFFSET_FONT_HEIGHT
private static final int	OFFSET_FONT_NAME
private static final int	OFFSET_FONT_OPTIONS
private static final int	OFFSET_FONT_WEIGHT
private static final int	OFFSET_FONT_WEIGHT_MODIFIED
private static final int	OFFSET_NOT_USED1
private static final int	OFFSET_NOT_USED2
private static final int	OFFSET_NOT_USED3
private static final int	OFFSET_OPTION_FLAGS
private static final int	OFFSET_UNDERLINE_TYPE
private static final int	OFFSET_UNDERLINE_TYPE_MODIFIED
private static final BitField	OUTLINE
private static final BitField	POSTURE
private static final int	RAW_DATA_SIZE
private static final BitField	SHADOW

Constructor Summary

Access	Constructor and Description
public	FontFormatting()
public	FontFormatting(FontFormatting other)
public	FontFormatting(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public FontFormatting	copy() Implements org.apache.poi.common.Duplicatable.copy.
public int	getDataLength()
public short	Returns: super or subscript option getEscapementType() get the type of super or subscript for the font
public short	getFontColorIndex()
public int	Returns: fontheight (in points/20); or -1 if not modified getFontHeight() gets the height of the font in 1/20th point units
private boolean	getFontOption(BitField field)
public short	Returns: bw - a number between 100-1000 for the fonts "boldness" getFontWeight() get the font weight for this font (100-1000dec or 0x64-0x3e8).
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
private int	getInt(int offset)
private boolean	getOptionFlag(BitField field)
public byte[]	getRawRecord()
private short	getShort(int offset)
public short	Returns: font underlining type getUnderlineType() get the type of underlining for the font
public boolean	Returns: bold - whether the font is bold or not isBold() get whether the font weight is set to bold or not
public boolean	isEscapementTypeModified()
public boolean	isFontCancellationModified()
public boolean	isFontOutlineModified()
public boolean	isFontShadowModified()
public boolean	isFontStyleModified()
public boolean	isFontWeightModified()
public boolean	Returns: italics - whether the font is italics or not isItalic() get whether the font is to be italics or not
public boolean	isOutlineOn()
public boolean	isShadowOn()
public boolean	Returns: strike - whether the font is stricken out or not isStruckout() get whether the font is to be stricken out or not
public boolean	isUnderlineTypeModified()
public void	setBold(boolean - set font weight to bold if true; to normal otherwise bold) set the font weight to bold (weight=700) or to normal(weight=400) boldness.
public void	setEscapementType(short super or subscript option escapementType) set the escapement type for the font
public void	setEscapementTypeModified(boolean modified)
public void	setFontCancellationModified(boolean modified)
public void	setFontColorIndex(short fci)
public void	setFontHeight(int fontheight (in points/20); or -1 to preserve the cell font height height) sets the height of the font in 1/20th point units
private void	setFontOption(boolean option, BitField field)
public void	setFontOutlineModified(boolean modified)
public void	setFontShadowModified(boolean modified)
public void	setFontStyleModified(boolean modified)
private void	setFontWeight(short - a number between 100-1000 for the fonts "boldness" bw) set the font weight (100-1000dec or 0x64-0x3e8).
public void	setFontWieghtModified(boolean modified)
private void	setInt(int offset, int value)
public void	setItalic(boolean - whether the font is italics or not italic) set the font to be italics or not
private void	setOptionFlag(boolean modified, BitField field)
public void	setOutline(boolean on)
public void	setShadow(boolean on)
private void	setShort(int offset, int value)
public void	setStrikeout(boolean - whether the font is stricken out or not strike) set the font to be stricken out or not
public void	setUnderlineType(short underline option underlineType) set the type of underlining type for the font
public void	setUnderlineTypeModified(boolean modified)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

_rawData	back to summary
private final byte[] _rawData

CANCELLATION	back to summary
private static final BitField CANCELLATION

FONT_CELL_HEIGHT_PRESERVED	back to summary
public static final int FONT_CELL_HEIGHT_PRESERVED

FONT_WEIGHT_BOLD	back to summary
private static final short FONT_WEIGHT_BOLD Bold boldness (bold)

FONT_WEIGHT_NORMAL	back to summary
private static final short FONT_WEIGHT_NORMAL Normal boldness (not bold)

OFFSET_ESCAPEMENT_TYPE	back to summary
private static final int OFFSET_ESCAPEMENT_TYPE

OFFSET_ESCAPEMENT_TYPE_MODIFIED	back to summary
private static final int OFFSET_ESCAPEMENT_TYPE_MODIFIED

OFFSET_FONT_COLOR_INDEX	back to summary
private static final int OFFSET_FONT_COLOR_INDEX

OFFSET_FONT_FORMATING_END	back to summary
private static final int OFFSET_FONT_FORMATING_END

OFFSET_FONT_HEIGHT	back to summary
private static final int OFFSET_FONT_HEIGHT

OFFSET_FONT_NAME	back to summary
private static final int OFFSET_FONT_NAME

OFFSET_FONT_OPTIONS	back to summary
private static final int OFFSET_FONT_OPTIONS

OFFSET_FONT_WEIGHT	back to summary
private static final int OFFSET_FONT_WEIGHT

OFFSET_FONT_WEIGHT_MODIFIED	back to summary
private static final int OFFSET_FONT_WEIGHT_MODIFIED

OFFSET_NOT_USED1	back to summary
private static final int OFFSET_NOT_USED1

OFFSET_NOT_USED2	back to summary
private static final int OFFSET_NOT_USED2

OFFSET_NOT_USED3	back to summary
private static final int OFFSET_NOT_USED3

OFFSET_OPTION_FLAGS	back to summary
private static final int OFFSET_OPTION_FLAGS

OFFSET_UNDERLINE_TYPE	back to summary
private static final int OFFSET_UNDERLINE_TYPE

OFFSET_UNDERLINE_TYPE_MODIFIED	back to summary
private static final int OFFSET_UNDERLINE_TYPE_MODIFIED

OUTLINE	back to summary
private static final BitField OUTLINE

POSTURE	back to summary
private static final BitField POSTURE

RAW_DATA_SIZE	back to summary
private static final int RAW_DATA_SIZE

SHADOW	back to summary
private static final BitField SHADOW

Constructor Detail

FontFormatting	back to summary
public FontFormatting()

FontFormatting	back to summary
public FontFormatting(FontFormatting other)

FontFormatting	back to summary
public FontFormatting(RecordInputStream in)

Method Detail

copy	back to summary
public FontFormatting copy() Implements org.apache.poi.common.Duplicatable.copy. Returns:FontFormatting Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public FontFormatting copy()

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

Returns:FontFormatting

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

getDataLength	back to summary
public int getDataLength()

getEscapementType back to summary

getEscapementType	back to summary
public short getEscapementType() get the type of super or subscript for the font Returns:short super or subscript option See Also `org.apache.poi.ss.usermodel.Font#SS_NONE`, `org.apache.poi.ss.usermodel.Font#SS_SUPER`, `org.apache.poi.ss.usermodel.Font#SS_SUB`

public short getEscapementType()

get the type of super or subscript for the font

Returns:short: super or subscript option
See Also: org.apache.poi.ss.usermodel.Font#SS_NONE, org.apache.poi.ss.usermodel.Font#SS_SUPER, org.apache.poi.ss.usermodel.Font#SS_SUB

getFontColorIndex	back to summary
public short getFontColorIndex()

getFontHeight	back to summary
public int getFontHeight() gets the height of the font in 1/20th point units Returns:int fontheight (in points/20); or -1 if not modified

getFontHeight

back to summary

public int getFontHeight()

gets the height of the font in 1/20th point units

Returns:int: fontheight (in points/20); or -1 if not modified

getFontOption	back to summary
private boolean getFontOption(BitField field)

getFontWeight	back to summary
public short getFontWeight() get the font weight for this font (100-1000dec or 0x64-0x3e8). Default is 0x190 for normal and 0x2bc for bold Returns:short bw - a number between 100-1000 for the fonts "boldness"

getFontWeight

back to summary

public short getFontWeight()

get the font weight for this font (100-1000dec or 0x64-0x3e8). Default is 0x190 for normal and 0x2bc for bold

Returns:short: bw - a number between 100-1000 for the fonts "boldness"

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

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

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

Annotations

@Override

getInt	back to summary
private int getInt(int offset)

getOptionFlag	back to summary
private boolean getOptionFlag(BitField field)

getRawRecord	back to summary
public byte[] getRawRecord()

getShort	back to summary
private short getShort(int offset)

getUnderlineType back to summary

getUnderlineType	back to summary
public short getUnderlineType() get the type of underlining for the font Returns:short font underlining type See Also `org.apache.poi.ss.usermodel.Font#U_NONE`, `org.apache.poi.ss.usermodel.Font#U_SINGLE`, `org.apache.poi.ss.usermodel.Font#U_DOUBLE`, `org.apache.poi.ss.usermodel.Font#U_SINGLE_ACCOUNTING`, `org.apache.poi.ss.usermodel.Font#U_DOUBLE_ACCOUNTING`

public short getUnderlineType()

get the type of underlining for the font

Returns:short: font underlining type
See Also: org.apache.poi.ss.usermodel.Font#U_NONE, org.apache.poi.ss.usermodel.Font#U_SINGLE, org.apache.poi.ss.usermodel.Font#U_DOUBLE, org.apache.poi.ss.usermodel.Font#U_SINGLE_ACCOUNTING, org.apache.poi.ss.usermodel.Font#U_DOUBLE_ACCOUNTING

isBold	back to summary
public boolean isBold() get whether the font weight is set to bold or not Returns:boolean bold - whether the font is bold or not

isBold

back to summary

public boolean isBold()

get whether the font weight is set to bold or not

Returns:boolean: bold - whether the font is bold or not

isEscapementTypeModified	back to summary
public boolean isEscapementTypeModified()

isFontCancellationModified	back to summary
public boolean isFontCancellationModified()

isFontOutlineModified	back to summary
public boolean isFontOutlineModified()

isFontShadowModified	back to summary
public boolean isFontShadowModified()

isFontStyleModified	back to summary
public boolean isFontStyleModified()

isFontWeightModified	back to summary
public boolean isFontWeightModified()

isItalic back to summary

public boolean isItalic()

get whether the font is to be italics or not

Returns:boolean: italics - whether the font is italics or not
See Also: getFontOption(org.apache.poi.util.BitField)

isOutlineOn	back to summary
public boolean isOutlineOn()

isShadowOn	back to summary
public boolean isShadowOn()

isStruckout back to summary

public boolean isStruckout()

get whether the font is to be stricken out or not

Returns:boolean: strike - whether the font is stricken out or not
See Also: getFontOption(org.apache.poi.util.BitField)

isUnderlineTypeModified	back to summary
public boolean isUnderlineTypeModified()

setBold

back to summary

public void setBold(boolean bold)

set the font weight to bold (weight=700) or to normal(weight=400) boldness.

Parameters

bold:boolean: - set font weight to bold if true; to normal otherwise

setEscapementType back to summary

public void setEscapementType(short escapementType)

set the escapement type for the font

Parameters

escapementType:short: super or subscript option

setEscapementTypeModified	back to summary
public void setEscapementTypeModified(boolean modified)

setFontCancellationModified	back to summary
public void setFontCancellationModified(boolean modified)

setFontColorIndex	back to summary
public void setFontColorIndex(short fci)

setFontHeight

back to summary

public void setFontHeight(int height)

sets the height of the font in 1/20th point units

Parameters

height:int: fontheight (in points/20); or -1 to preserve the cell font height

setFontOption	back to summary
private void setFontOption(boolean option, BitField field)

setFontOutlineModified	back to summary
public void setFontOutlineModified(boolean modified)

setFontShadowModified	back to summary
public void setFontShadowModified(boolean modified)

setFontStyleModified	back to summary
public void setFontStyleModified(boolean modified)

setFontWeight

back to summary

private void setFontWeight(short bw)

set the font weight (100-1000dec or 0x64-0x3e8). Default is 0x190 for normal and 0x2bc for bold

Parameters

bw:short: - a number between 100-1000 for the fonts "boldness"

setFontWieghtModified	back to summary
public void setFontWieghtModified(boolean modified)

setInt	back to summary
private void setInt(int offset, int value)

setItalic back to summary

public void setItalic(boolean italic)

set the font to be italics or not

Parameters

italic:boolean: - whether the font is italics or not

setOptionFlag	back to summary
private void setOptionFlag(boolean modified, BitField field)

setOutline	back to summary
public void setOutline(boolean on)

setShadow	back to summary
public void setShadow(boolean on)

setShort	back to summary
private void setShort(int offset, int value)

setStrikeout

back to summary

public void setStrikeout(boolean strike)

set the font to be stricken out or not

Parameters

strike:boolean: - whether the font is stricken out or not

setUnderlineType back to summary

public void setUnderlineType(short underlineType)

set the type of underlining type for the font

Parameters

underlineType:short: underline option

setUnderlineTypeModified	back to summary
public void setUnderlineTypeModified(boolean modified)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

public final Class FontFormatting

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail