Save This Page
Home » jexcelapi_2_6_8 » jxl.biff » [javadoc | source]
jxl.biff
protected static class: HeaderFooter.Contents [javadoc | source]
java.lang.Object
   jxl.biff.HeaderFooter$Contents

Direct Known Subclasses:
    Contents

The contents - a simple wrapper around a string buffer
Constructor:
 protected Contents() 
 protected Contents(String s) 
    Constructor used when reading worksheets. The string contains all the formatting (but not alignment characters
    Parameters:
    s - the format string
 protected Contents(HeaderFooter.Contents copy) 
    Copy constructor
    Parameters:
    copy - the contents to copy
Method from jxl.biff.HeaderFooter$Contents Summary:
append,   appendDate,   appendPageNumber,   appendTime,   appendTotalPages,   appendWorkSheetName,   appendWorkbookName,   clear,   empty,   getContents,   setFontName,   setFontSize,   toggleBold,   toggleDoubleUnderline,   toggleItalics,   toggleOutline,   toggleShadow,   toggleStrikethrough,   toggleSubScript,   toggleSuperScript,   toggleUnderline
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from jxl.biff.HeaderFooter$Contents Detail:
 protected  void append(String txt) 
    Appends the text to the string buffer
 protected  void appendDate() 
    Appends the current date
 protected  void appendPageNumber() 
    Appends the page number
 protected  void appendTime() 
    Appends the current time
 protected  void appendTotalPages() 
    Appends the total number of pages
 protected  void appendWorkSheetName() 
    Appends the worksheet name
 protected  void appendWorkbookName() 
    Appends the workbook name
 protected  void clear() 
    Clears the contents of this portion
 protected boolean empty() 
    Queries if the contents are empty
 protected String getContents() 
    Retrieves a Stringified version of this object
 protected  void setFontName(String fontName) 
    Sets the font of text subsequently appended to this object.. Previously appended text is not affected.

    Note: no checking is performed to determine if fontName is a valid font.

 protected boolean setFontSize(int size) 
    Sets the font size of text subsequently appended to this object. Previously appended text is not affected.

    Valid point sizes are between 1 and 99 (inclusive). If size is outside this range, this method returns false and does not change font size. If size is within this range, the font size is changed and true is returned.

 protected  void toggleBold() 
    Turns bold printing on or off. Bold printing is initially off. Text subsequently appended to this object will be bolded until this method is called again.
 protected  void toggleDoubleUnderline() 
    Turns double-underline printing on or off. Double-underline printing is initially off. Text subsequently appended to this object will be double-underlined until this method is called again.
 protected  void toggleItalics() 
    Turns italics printing on or off. Italics printing is initially off. Text subsequently appended to this object will be italicized until this method is called again.
 protected  void toggleOutline() 
    Turns outline printing on or off (Macintosh only). Outline printing is initially off. Text subsequently appended to this object will be outlined until this method is called again.
 protected  void toggleShadow() 
    Turns shadow printing on or off (Macintosh only). Shadow printing is initially off. Text subsequently appended to this object will be shadowed until this method is called again.
 protected  void toggleStrikethrough() 
    Turns strikethrough printing on or off. Strikethrough printing is initially off. Text subsequently appended to this object will be striked out until this method is called again.
 protected  void toggleSubScript() 
    Turns subscript printing on or off. Subscript printing is initially off. Text subsequently appended to this object will be subscripted until this method is called again.
 protected  void toggleSuperScript() 
    Turns superscript printing on or off. Superscript printing is initially off. Text subsequently appended to this object will be superscripted until this method is called again.
 protected  void toggleUnderline() 
    Turns underline printing on or off. Underline printing is initially off. Text subsequently appended to this object will be underlined until this method is called again.