Package org.apache.poi.hssf.record

Class WindowOneRecord

java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.WindowOneRecord
All Implemented Interfaces:
org.apache.poi.common.Duplicatable, GenericRecord
public final class WindowOneRecord extends StandardRecord
Stores the attributes of the workbook window. This is basically so the gui knows how big to make the window holding the spreadsheet document.

  • Field Details

  • Constructor Details

    • WindowOneRecord

      public WindowOneRecord()

    • WindowOneRecord

      public WindowOneRecord(WindowOneRecord other)

    • WindowOneRecord

      public WindowOneRecord(RecordInputStream in)

  • Method Details

    • setHorizontalHold

      public void setHorizontalHold(short h)
      set the horizontal position of the window (in 1/20ths of a point)
      Parameters:
      h - - horizontal location

    • setVerticalHold

      public void setVerticalHold(short v)
      set the vertical position of the window (in 1/20ths of a point)
      Parameters:
      v - - vertical location

    • setWidth

      public void setWidth(short w)
      set the width of the window
      Parameters:
      w - width

    • setHeight

      public void setHeight(short h)
      set teh height of the window
      Parameters:
      h - height

    • setOptions

      public void setOptions(short o)
      set the options bitmask (see bit setters)
      Parameters:
      o - - the bitmask

    • setHidden

      public void setHidden(boolean ishidden)
      set whether the window is hidden or not
      Parameters:
      ishidden - or not

    • setIconic

      public void setIconic(boolean isiconic)
      set whether the window has been iconized or not
      Parameters:
      isiconic - iconize or not

    • setDisplayHorizonalScrollbar

      public void setDisplayHorizonalScrollbar(boolean scroll)
      set whether to display the horizontal scrollbar or not
      Parameters:
      scroll - display or not

    • setDisplayVerticalScrollbar

      public void setDisplayVerticalScrollbar(boolean scroll)
      set whether to display the vertical scrollbar or not
      Parameters:
      scroll - display or not

    • setDisplayTabs

      public void setDisplayTabs(boolean disptabs)
      set whether to display the tabs or not
      Parameters:
      disptabs - display or not

    • setActiveSheetIndex

      public void setActiveSheetIndex(int index)

    • setFirstVisibleTab

      public void setFirstVisibleTab(int t)
      Sets the first visible sheet in the worksheet tab-bar. This method does not hide, select or focus sheets. It just sets the scroll position in the tab-bar.
      Parameters:
      t - the sheet index of the tab that will become the first in the tab-bar

    • setNumSelectedTabs

      public void setNumSelectedTabs(short n)
      set the number of selected tabs
      Parameters:
      n - number of tabs

    • setTabWidthRatio

      public void setTabWidthRatio(short r)
      ratio of the width of the tabs to the horizontal scrollbar
      Parameters:
      r - ratio

    • getHorizontalHold

      public short getHorizontalHold()
      get the horizontal position of the window (in 1/20ths of a point)
      Returns:
      h - horizontal location

    • getVerticalHold

      public short getVerticalHold()
      get the vertical position of the window (in 1/20ths of a point)
      Returns:
      v - vertical location

    • getWidth

      public short getWidth()
      get the width of the window
      Returns:
      width

    • getHeight

      public short getHeight()
      get the height of the window
      Returns:
      height

    • getOptions

      public short getOptions()
      get the options bitmask (see bit setters)
      Returns:
      o - the bitmask

    • getHidden

      public boolean getHidden()
      get whether the window is hidden or not
      Returns:
      ishidden or not

    • getIconic

      public boolean getIconic()
      get whether the window has been iconized or not
      Returns:
      iconize or not

    • getDisplayHorizontalScrollbar

      public boolean getDisplayHorizontalScrollbar()
      get whether to display the horizontal scrollbar or not
      Returns:
      display or not

    • getDisplayVerticalScrollbar

      public boolean getDisplayVerticalScrollbar()
      get whether to display the vertical scrollbar or not
      Returns:
      display or not

    • getDisplayTabs

      public boolean getDisplayTabs()
      get whether to display the tabs or not
      Returns:
      display or not

    • getActiveSheetIndex

      public int getActiveSheetIndex()
      Returns:
      the index of the currently displayed sheet

    • getFirstVisibleTab

      public int getFirstVisibleTab()
      Returns:
      the first visible sheet in the worksheet tab-bar. I.E. the scroll position of the tab-bar.

    • getNumSelectedTabs

      public short getNumSelectedTabs()
      get the number of selected tabs
      Returns:
      number of tabs

    • getTabWidthRatio

      public short getTabWidthRatio()
      ratio of the width of the tabs to the horizontal scrollbar
      Returns:
      ratio

    • serialize

      public void serialize(LittleEndianOutput out)

    • 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
      Returns:
      he id for this record

    • copy

      public WindowOneRecord copy()
      Specified by:
      copy in interface org.apache.poi.common.Duplicatable
      Specified by:
      copy in class StandardRecord

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()