com.crystaldecisions.sdk.occa.report.definition
Class Font

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.Font
All Implemented Interfaces:
IFont, IClone

public class Font
extends java.lang.Object
implements IFont, IClone

This object 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. When possible, use the IFont interface.


Constructor Summary
Font()
           
Font(IFont src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           For internal use only.
 void doControllerModification(java.lang.Object newObject)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 boolean getBold()
           Returns true if the font is bolded, and false otherwise.
 short getCharset()
          Returns the m_Charset.
 ControllableMixin getControllableMixin()
           
 FontStyle getFontStyle()
          Gets the font style, such as normal, bold, or italic.
 boolean getItalic()
           Returns true if the font is italicized, and false otherwise.
 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.
 boolean hasContent(java.lang.Object srcFont)
           
 boolean isDirectlyControllable()
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           For internal use only.
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
           For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 void setBold(boolean bold)
           Sets whether the font is bolded.
 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)
           Sets whether the font is italicized.
 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.
 boolean skipWritingIdenticalObject()
           For internal use only.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Font

public Font(IFont src)

Font

public Font()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

For internal use only.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


getBold

public boolean getBold()
Description copied from interface: IFont

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

Specified by:
getBold in interface IFont
Returns:
true if the font is bolded, and false otherwise.

getItalic

public boolean getItalic()
Description copied from interface: IFont

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

Specified by:
getItalic in interface IFont
Returns:
true if the font is italicized, and false otherwise.

getName

public java.lang.String getName()
Description copied from interface: IFont

Returns the name of the font.

Specified by:
getName in interface IFont
Returns:
A String that specifies the name of the font.

getSize

public float getSize()
Description copied from interface: IFont

Returns the point size of the font.

Specified by:
getSize in interface IFont
Returns:
A float that specifies the point size of the font.

getStrikethrough

public boolean getStrikethrough()
Description copied from interface: IFont

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

Specified by:
getStrikethrough in interface IFont
Returns:
true if the font appears with strikeout lines, and false otherwise.

getUnderline

public boolean getUnderline()
Description copied from interface: IFont

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

Specified by:
getUnderline in interface IFont
Returns:
true if the font is underlined, and false otherwise.

getWeight

public int getWeight()
Description copied from interface: IFont

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

Specified by:
getWeight in interface IFont
Returns:
An int that specifies the weight of the font characters.

hasContent

public boolean hasContent(java.lang.Object srcFont)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setBold

public void setBold(boolean bold)
Description copied from interface: IFont

Sets whether the font is bolded.

Specified by:
setBold in interface IFont
Parameters:
bold - true if the font is bolded, and false otherwise.

setItalic

public void setItalic(boolean italic)
Description copied from interface: IFont

Sets whether the font is italicized.

Specified by:
setItalic in interface IFont
Parameters:
italic - true if the font is italicized, and false otherwise.

setName

public void setName(java.lang.String name)
Description copied from interface: IFont

Sets the name of the font.

Specified by:
setName in interface IFont
Parameters:
name - A String that specifies the name of the font.

setSize

public void setSize(float size)
Description copied from interface: IFont

Sets the point size of the font.

Specified by:
setSize in interface IFont
Parameters:
size - A float that specifies the point size of the font.

setStrikethrough

public void setStrikethrough(boolean strikethrough)
Description copied from interface: IFont

Sets whether the font appears with strikeout lines.

Specified by:
setStrikethrough in interface IFont
Parameters:
strikethrough - true if the font appears with strikeout lines, and false otherwise.

setUnderline

public void setUnderline(boolean underline)
Description copied from interface: IFont

Sets whether the font is underlined.

Specified by:
setUnderline in interface IFont
Parameters:
underline - true if the font is underlined, and false otherwise.

setWeight

public void setWeight(int weight)
Description copied from interface: IFont

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

Specified by:
setWeight in interface IFont
Parameters:
weight - An int that specifies the weight of the font characters.

skipWritingIdenticalObject

public boolean skipWritingIdenticalObject()

For internal use only.


startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.


getCharset

public short getCharset()
Returns the m_Charset.

Specified by:
getCharset in interface IFont
Returns:
short

setCharset

public void setCharset(short charset)
Description copied from interface: IFont

Sets the Charset of the font.

Specified by:
setCharset in interface IFont
Parameters:
charset - a short value that specifies the Charset of the font

getFontStyle

public FontStyle getFontStyle()
Description copied from interface: IFont
Gets the font style, such as normal, bold, or italic.

Specified by:
getFontStyle in interface IFont
Returns:
Returns the font style.

setFontStyle

public void setFontStyle(FontStyle fontStyle)
Description copied from interface: IFont
Sets the style of the font, such as normal, bold or italic.

Specified by:
setFontStyle in interface IFont
Parameters:
fontStyle - The font style to set.

getControllableMixin

public ControllableMixin getControllableMixin()

doControllerModification

public void doControllerModification(java.lang.Object newObject)

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)