Class PrintSetupRecord

java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.PrintSetupRecord

public class PrintSetupRecord extends Record
Title: Print Setup Record

Description: Stores print setup options -- bogus for HSSF (and marked as such)

REFERENCE: PG 385 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:
2.0-pre
Author:
Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)
  • Field Details

  • Constructor Details

    • PrintSetupRecord

      public PrintSetupRecord()
    • PrintSetupRecord

      public PrintSetupRecord(RecordInputStream in)
      Constructs a PrintSetup (SETUP) record and sets its fields appropriately.
      Parameters:
      in - the RecordInputstream to read the record from
  • Method Details

    • validateSid

      protected void validateSid(short id)
      Description copied from class: Record
      called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
      Specified by:
      validateSid in class Record
      Parameters:
      id - alleged id for this record
    • fillFields

      protected void fillFields(RecordInputStream in)
      Description copied from class: Record
      called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
      Specified by:
      fillFields in class Record
      Parameters:
      in - the RecordInputstream to read the record from
    • setPaperSize

      public void setPaperSize(short size)
    • setScale

      public void setScale(short scale)
    • setPageStart

      public void setPageStart(short start)
    • setFitWidth

      public void setFitWidth(short width)
    • setFitHeight

      public void setFitHeight(short height)
    • setOptions

      public void setOptions(short options)
    • setLeftToRight

      public void setLeftToRight(boolean ltor)
    • setLandscape

      public void setLandscape(boolean ls)
    • setValidSettings

      public void setValidSettings(boolean valid)
    • setNoColor

      public void setNoColor(boolean mono)
    • setDraft

      public void setDraft(boolean d)
    • setNotes

      public void setNotes(boolean printnotes)
    • setNoOrientation

      public void setNoOrientation(boolean orientation)
    • setUsePage

      public void setUsePage(boolean page)
    • setHResolution

      public void setHResolution(short resolution)
    • setVResolution

      public void setVResolution(short resolution)
    • setHeaderMargin

      public void setHeaderMargin(double headermargin)
    • setFooterMargin

      public void setFooterMargin(double footermargin)
    • setCopies

      public void setCopies(short copies)
    • getPaperSize

      public short getPaperSize()
    • getScale

      public short getScale()
    • getPageStart

      public short getPageStart()
    • getFitWidth

      public short getFitWidth()
    • getFitHeight

      public short getFitHeight()
    • getOptions

      public short getOptions()
    • getLeftToRight

      public boolean getLeftToRight()
    • getLandscape

      public boolean getLandscape()
    • getValidSettings

      public boolean getValidSettings()
    • getNoColor

      public boolean getNoColor()
    • getDraft

      public boolean getDraft()
    • getNotes

      public boolean getNotes()
    • getNoOrientation

      public boolean getNoOrientation()
    • getUsePage

      public boolean getUsePage()
    • getHResolution

      public short getHResolution()
    • getVResolution

      public short getVResolution()
    • getHeaderMargin

      public double getHeaderMargin()
    • getFooterMargin

      public double getFooterMargin()
    • getCopies

      public short getCopies()
    • toString

      public String toString()
      Description copied from class: Record
      get a string representation of the record (for biffview/debugging)
      Overrides:
      toString in class Record
    • serialize

      public int serialize(int offset, byte[] data)
      Description copied from class: Record
      called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.
      Specified by:
      serialize in class Record
      Parameters:
      offset - to begin writing at
      data - byte array containing instance data
      Returns:
      number of bytes written
    • getRecordSize

      public int getRecordSize()
      Description copied from class: Record
      gives the current serialized size of the record. Should include the sid and reclength (4 bytes).
      Overrides:
      getRecordSize in class Record
    • getSid

      public short getSid()
      Description copied from class: Record
      return the non static version of the id for this record.
      Specified by:
      getSid in class Record
    • clone

      public Object clone()
      Overrides:
      clone in class Record