com.crystaldecisions.sdk.occa.report.definition
Interface IFont

All Superinterfaces:
IClone
All Known Implementing Classes:
Font

public interface IFont
extends IClone

This interface allows you to retrieve or set options for the font used in the report object. Options that are defined by this object, such as font name, are dependent upon the printer driver selected for the report.


Method Summary
 boolean getBold()
          Deprecated.  
 short getCharset()
           Gets the Charset of the font.
 FontStyle getFontStyle()
          Gets the font style, such as normal, bold, or italic.
 boolean getItalic()
          Deprecated.  
 java.lang.String getName()
           Returns the name of the font.
 float getSize()
           Returns the point size of the font.
 boolean getStrikethrough()
           Returns true if the font appears with strikeout lines, and false otherwise.
 boolean getUnderline()
           Returns true if the font is underlined, and false otherwise.
 int getWeight()
           Returns the weight of the font characters.
 void setBold(boolean bold)
          Deprecated.  
 void setCharset(short charset)
           Sets the Charset of the font.
 void setFontStyle(FontStyle fontStyle)
          Sets the style of the font, such as normal, bold or italic.
 void setItalic(boolean italic)
          Deprecated.  
 void setName(java.lang.String name)
           Sets the name of the font.
 void setSize(float size)
           Sets the point size of the font.
 void setStrikethrough(boolean strikethrough)
           Sets whether the font appears with strikeout lines.
 void setUnderline(boolean underline)
           Sets whether the font is underlined.
 void setWeight(int weight)
           Sets the weight of the font characters.
 

Method Detail

getBold

boolean getBold()
Deprecated. 

Returns true if the font is bolded, and false otherwise.

Returns:
true if the font is bolded, and false otherwise.

getCharset

short getCharset()

Gets the Charset of the font.

Returns:
A short value that represents the Charset of the font.

getItalic

boolean getItalic()
Deprecated. 

Returns true if the font is italicized, and false otherwise.

Returns:
true if the font is italicized, and false otherwise.

getName

java.lang.String getName()

Returns the name of the font.

Returns:
A String that specifies the name of the font.

getSize

float getSize()

Returns the point size of the font.

Returns:
A float that specifies the point size of the font.

getStrikethrough

boolean getStrikethrough()

Returns true if the font appears with strikeout lines, and false otherwise.

Returns:
true if the font appears with strikeout lines, and false otherwise.

getUnderline

boolean getUnderline()

Returns true if the font is underlined, and false otherwise.

Returns:
true if the font is underlined, and false otherwise.

getWeight

int getWeight()

Returns the weight of the font characters. The weight refers to the thickness or "boldness" of the characters that make up the font. The higher the value, the bolder the character.

The following are some common weight settings:

Description Value
Normal
400
Bold
700

Returns:
An int that specifies the weight of the font characters.

getFontStyle

FontStyle getFontStyle()
Gets the font style, such as normal, bold, or italic.

Returns:
Returns the font style.

setBold

void setBold(boolean bold)
Deprecated. 

Sets whether the font is bolded.

Parameters:
bold - true if the font is bolded, and false otherwise.

setCharset

void setCharset(short charset)

Sets the Charset of the font.

Parameters:
charset - a short value that specifies the Charset of the font

setItalic

void setItalic(boolean italic)
Deprecated. 

Sets whether the font is italicized.

Parameters:
italic - true if the font is italicized, and false otherwise.

setName

void setName(java.lang.String name)

Sets the name of the font.

Parameters:
name - A String that specifies the name of the font.

setSize

void setSize(float size)

Sets the point size of the font.

Parameters:
size - A float that specifies the point size of the font.

setStrikethrough

void setStrikethrough(boolean strikethrough)

Sets whether the font appears with strikeout lines.

Parameters:
strikethrough - true if the font appears with strikeout lines, and false otherwise.

setUnderline

void setUnderline(boolean underline)

Sets whether the font is underlined.

Parameters:
underline - true if the font is underlined, and false otherwise.

setWeight

void setWeight(int weight)

Sets the weight of the font characters. The weight refers to the thickness or "boldness" of the characters that make up the font. The higher the value, the bolder the character.

The following are some common weight settings:

Description Value
Normal
400
Bold
700

Parameters:
weight - An int that specifies the weight of the font characters.

setFontStyle

void setFontStyle(FontStyle fontStyle)
Sets the style of the font, such as normal, bold or italic.

Parameters:
fontStyle - The font style to set.