public final Class HSSFFont

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Implements org.apache.poi.ss.usermodel.Font.getBold.

get if the font is bold or not

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Font.getCharSet.

get character-set to use.

Returns:int

character-set

Annotations

@Override

See Also

ANSI_CHARSET, DEFAULT_CHARSET, SYMBOL_CHARSET

Implements org.apache.poi.ss.usermodel.Font.getColor.

get the color for the font

Returns:short

color to use

Annotations

@Override

See Also

COLOR_NORMAL, COLOR_RED, org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)

Implements org.apache.poi.ss.usermodel.Font.getFontHeight.

get the font height in unit's of 1/20th of a point. Maybe you might want to use the getFontHeightInPoints which matches to the familiar 10, 12, 14 etc..

Returns:short

short - height in 1/20ths of a point

Annotations

@Override

See Also

getFontHeightInPoints()

Implements org.apache.poi.ss.usermodel.Font.getFontHeightInPoints.

get the font height

Returns:short

short - height in the familiar unit of measure - points

Annotations

@Override

See Also

getFontHeight()

Implements org.apache.poi.ss.usermodel.Font.getFontName.

get the name for the font (i.e. Arial)

Returns:String

String representing the name of the font to use

Annotations

@Override

See Also

FONT_ARIAL

get the color value for the font

Implements org.apache.poi.ss.usermodel.Font.getIndex.

Doc from org.apache.poi.ss.usermodel.Font.getIndex.

get the index within the XSSFWorkbook (sequence within the collection of Font objects)

Returns:int

unique index number of the underlying record this Font represents (probably you don't care unless you're comparing which one is which)

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Font.getIndexAsInt.

Doc from org.apache.poi.ss.usermodel.Font.getIndexAsInt.

get the index within the XSSFWorkbook (sequence within the collection of Font objects)

Returns:int

unique index number of the underlying record this Font represents (probably you don't care unless you're comparing which one is which)

Annotations

@Deprecated

@Removal

version:6.0.0

@Override

Implements org.apache.poi.ss.usermodel.Font.getItalic.

get whether to use italics or not

Returns:boolean

italics or not

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Font.getStrikeout.

get whether to use a strikeout horizontal line through the text or not

Returns:boolean

strikeout or not

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Font.getTypeOffset.

get normal,super or subscript.

Returns:short

offset type to use (none,super,sub)

Annotations

@Override

See Also

SS_NONE, SS_SUPER, SS_SUB

Implements org.apache.poi.ss.usermodel.Font.getUnderline.

get type of text underlining to use

Returns:byte

underlining type

Annotations

@Override

See Also

U_NONE, U_SINGLE, U_DOUBLE, U_SINGLE_ACCOUNTING, U_DOUBLE_ACCOUNTING

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Implements org.apache.poi.ss.usermodel.Font.setBold.

sets the font to be bold or not

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Font.setCharSet.

set character-set to use.

Annotations

@Override

See Also

ANSI_CHARSET, DEFAULT_CHARSET, SYMBOL_CHARSET

Implements org.apache.poi.ss.usermodel.Font.setCharSet.

set character-set to use.

Annotations

@Override

See Also

ANSI_CHARSET, DEFAULT_CHARSET, SYMBOL_CHARSET

Implements org.apache.poi.ss.usermodel.Font.setColor.

set the color for the font

Parameters

color:short

to use

Annotations

@Override

See Also

Note: Use this rather than HSSFColor.AUTOMATIC for default font color, COLOR_RED

Implements org.apache.poi.ss.usermodel.Font.setFontHeight.

set the font height in unit's of 1/20th of a point. Maybe you might want to use the setFontHeightInPoints which matches to the familiar 10, 12, 14 etc..

Parameters

height:short

height in 1/20ths of a point

Annotations

@Override

See Also

setFontHeightInPoints(short)

Implements org.apache.poi.ss.usermodel.Font.setFontHeightInPoints.

set the font height

Parameters

height:short

height in the familiar unit of measure - points

Annotations

@Override

See Also

setFontHeight(short)

Implements org.apache.poi.ss.usermodel.Font.setFontName.

set the name for the font (i.e. Arial)

Parameters

name:String

String representing the name of the font to use

Annotations

@Override

See Also

FONT_ARIAL

Implements org.apache.poi.ss.usermodel.Font.setItalic.

set whether to use italics or not

Parameters

italic:boolean

italics or not

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Font.setStrikeout.

set whether to use a strikeout horizontal line through the text or not

Parameters

strikeout:boolean

or not

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Font.setTypeOffset.

set normal,super or subscript.

Parameters

offset:short

type to use (none,super,sub)

Annotations

@Override

See Also

SS_NONE, SS_SUPER, SS_SUB

Implements org.apache.poi.ss.usermodel.Font.setUnderline.

set type of text underlining to use

Parameters

underline:byte

type

Annotations

@Override

See Also

U_NONE, U_SINGLE, U_DOUBLE, U_SINGLE_ACCOUNTING, U_DOUBLE_ACCOUNTING

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