FileDocCategorySizeDatePackage
HSSFWorkbook.javaAPI DocApache Poi 3.0.146498Mon Jun 04 19:06:30 BST 2007org.apache.poi.hssf.usermodel

HSSFWorkbook

public class HSSFWorkbook extends Object
High level representation of a workbook. This is the first object most users will construct whether they are reading or writing a workbook. It is also the top level object for creating new sheets/etc.
see
org.apache.poi.hssf.model.Workbook
see
org.apache.poi.hssf.usermodel.HSSFSheet
author
Andrew C. Oliver (acoliver at apache dot org)
author
Glen Stampoultzis (glens at apache.org)
author
Shawn Laubach (slaubach at apache dot org)
version
2.0-pre

Fields Summary
private static final int
DEBUG
public static final int
INITIAL_CAPACITY
used for compile-time performance/memory optimization. This determines the initial capacity for the sheet collection. Its currently set to 3. Changing it in this release will decrease performance since you're never allowed to have more or less than three sheets!
private org.apache.poi.hssf.model.Workbook
workbook
this is the reference to the low level Workbook object
protected ArrayList
sheets
this holds the HSSFSheet objects attached to this workbook
private ArrayList
names
this holds the HSSFName objects attached to this workbook
private boolean
preserveNodes
holds whether or not to preserve other nodes in the POIFS. Used for macros and embedded objects.
private POIFSFileSystem
poifs
if you do preserve the nodes, you'll need to hold the whole POIFS in memory.
private HSSFDataFormat
formatter
Used to keep track of the data formatter so that all createDataFormatter calls return the same one for a given book. This ensures that updates from one places is visible someplace else.
public static final int
PICTURE_TYPE_EMF
Extended windows meta file
public static final int
PICTURE_TYPE_WMF
Windows Meta File
public static final int
PICTURE_TYPE_PICT
Mac PICT format
public static final int
PICTURE_TYPE_JPEG
JPEG format
public static final int
PICTURE_TYPE_PNG
PNG format
public static final int
PICTURE_TYPE_DIB
Device independant bitmap
private static POILogger
log
public static final byte
ENCODING_COMPRESSED_UNICODE
public static final byte
ENCODING_UTF_16
Constructors Summary
public HSSFWorkbook()
Creates new HSSFWorkbook from scratch (start here!)




                
     
    
        this(Workbook.createWorkbook());
    
protected HSSFWorkbook(org.apache.poi.hssf.model.Workbook book)

        workbook = book;
        sheets = new ArrayList( INITIAL_CAPACITY );
        names = new ArrayList( INITIAL_CAPACITY );
    
public HSSFWorkbook(POIFSFileSystem fs)

      this(fs,true);
    
public HSSFWorkbook(POIFSFileSystem fs, boolean preserveNodes)
given a POI POIFSFileSystem object, read in its Workbook and populate the high and low level models. If you're reading in a workbook...start here.

param
fs the POI filesystem that contains the Workbook stream.
param
preserveNodes whether to preseve other nodes, such as macros. This takes more memory, so only say yes if you need to.
see
org.apache.poi.poifs.filesystem.POIFSFileSystem
exception
IOException if the stream cannot be read

        this.preserveNodes = preserveNodes;

        if (preserveNodes) {
           this.poifs = fs;
        }

        sheets = new ArrayList(INITIAL_CAPACITY);
        names  = new ArrayList(INITIAL_CAPACITY);
        
        // Normally, the Workbook will be in a POIFS Stream
        //  called "Workbook". However, some wierd XLS generators
        //  put theirs in one called "WORKBOOK"
        String workbookName = "Workbook";
        try {
        	fs.getRoot().getEntry(workbookName);
        	// Is the default name
        } catch(FileNotFoundException fe) {
        	// Try the upper case form
        	try {
        		workbookName = "WORKBOOK";
        		fs.getRoot().getEntry(workbookName);
        	} catch(FileNotFoundException wfe) {
        		// Doesn't contain it in either form
        		throw new IllegalArgumentException("The supplied POIFSFileSystem contained neither a 'Workbook' entry, nor a 'WORKBOOK' entry. Is it really an excel file?");
        	}
        }

        
        // Grab the data from the workbook stream, however
        //  it happens to be spelt.
        InputStream stream = fs.createDocumentInputStream(workbookName);

        EventRecordFactory factory = new EventRecordFactory();

        List records = RecordFactory.createRecords(stream);

        workbook = Workbook.createWorkbook(records);
        setPropertiesFromWorkbook(workbook);
        int recOffset = workbook.getNumRecords();
        int sheetNum = 0;
        
        // convert all LabelRecord records to LabelSSTRecord
        convertLabelRecords(records, recOffset);        
        while (recOffset < records.size())
        {
            Sheet sheet = Sheet.createSheet(records, sheetNum++, recOffset );

            recOffset = sheet.getEofLoc()+1;
            if (recOffset == 1)
            {
                break;
            }

            HSSFSheet hsheet = new HSSFSheet(workbook, sheet);

            sheets.add(hsheet);

            // workbook.setSheetName(sheets.size() -1, "Sheet"+sheets.size());
        }

        for (int i = 0 ; i < workbook.getNumNames() ; ++i){
            HSSFName name = new HSSFName(workbook, workbook.getNameRecord(i));
            names.add(name);
        }
    
public HSSFWorkbook(InputStream s)

         this(s,true);
     
public HSSFWorkbook(InputStream s, boolean preserveNodes)
Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around your inputstream.

param
s the POI filesystem that contains the Workbook stream.
param
preserveNodes whether to preseve other nodes, such as macros. This takes more memory, so only say yes if you need to.
see
org.apache.poi.poifs.filesystem.POIFSFileSystem
see
#HSSFWorkbook(POIFSFileSystem)
exception
IOException if the stream cannot be read

        this(new POIFSFileSystem(s), preserveNodes);
    
Methods Summary
public intaddPicture(byte[] pictureData, int format)
Adds a picture to the workbook.

param
pictureData The bytes of the picture
param
format The format of the picture. One of PICTURE_TYPE_*
return
the index to this picture (1 based).

        byte[] uid = newUID();
        EscherBitmapBlip blipRecord = new EscherBitmapBlip();
        blipRecord.setRecordId( (short) ( EscherBitmapBlip.RECORD_ID_START + format ) );
        switch (format)
        {
            case PICTURE_TYPE_EMF:
                blipRecord.setOptions(HSSFPictureData.MSOBI_EMF);
                break;
            case PICTURE_TYPE_WMF:
                blipRecord.setOptions(HSSFPictureData.MSOBI_WMF);
                break;
            case PICTURE_TYPE_PICT:
                blipRecord.setOptions(HSSFPictureData.MSOBI_PICT);
                break;
            case PICTURE_TYPE_PNG:
                blipRecord.setOptions(HSSFPictureData.MSOBI_PNG);
                break;
            case HSSFWorkbook.PICTURE_TYPE_JPEG:
                blipRecord.setOptions(HSSFPictureData.MSOBI_JPEG);
                break;
            case HSSFWorkbook.PICTURE_TYPE_DIB:
                blipRecord.setOptions(HSSFPictureData.MSOBI_DIB);
                break;
        }

        blipRecord.setUID( uid );
        blipRecord.setMarker( (byte) 0xFF );
        blipRecord.setPictureData( pictureData );

        EscherBSERecord r = new EscherBSERecord();
        r.setRecordId( EscherBSERecord.RECORD_ID );
        r.setOptions( (short) ( 0x0002 | ( format << 4 ) ) );
        r.setBlipTypeMacOS( (byte) format );
        r.setBlipTypeWin32( (byte) format );
        r.setUid( uid );
        r.setTag( (short) 0xFF );
        r.setSize( pictureData.length + 25 );
        r.setRef( 1 );
        r.setOffset( 0 );
        r.setBlipRecord( blipRecord );

        return workbook.addBSERecord( r );
    
public intaddSSTString(java.lang.String string)

deprecated
Do not call this method from your applications. Use the methods available in the HSSFRow to add string HSSFCells

        return workbook.addSSTString(new UnicodeString(string));
    
public org.apache.poi.hssf.usermodel.HSSFSheetcloneSheet(int sheetNum)
create an HSSFSheet from an existing sheet in the HSSFWorkbook.

return
HSSFSheet representing the cloned sheet.

      HSSFSheet srcSheet = (HSSFSheet)sheets.get(sheetNum);
      String srcName = workbook.getSheetName(sheetNum);
      if (srcSheet != null) {
        HSSFSheet clonedSheet = srcSheet.cloneSheet(workbook);
        WindowTwoRecord windowTwo = (WindowTwoRecord) clonedSheet.getSheet().findFirstRecordBySid(WindowTwoRecord.sid);
        windowTwo.setSelected(sheets.size() == 1);
        windowTwo.setPaged(sheets.size() == 1);

        sheets.add(clonedSheet);
        int i=1;
        while (true) {
        	//Try and find the next sheet name that is unique
        	String name = srcName;
        	String index = Integer.toString(i++);
        	if (name.length()+index.length()+2<31)
        	  name = name + "("+index+")";
        	else name = name.substring(0, 31-index.length()-2)+"("+index+")";
        	
        	//If the sheet name is unique, then set it otherwise move on to the next number.
        	if (workbook.getSheetIndex(name) == -1) {
              workbook.setSheetName(sheets.size()-1, name);
              break;
        	}
        }
        return clonedSheet;
      }
      return null;
    
private voidconvertLabelRecords(java.util.List records, int offset)
This is basically a kludge to deal with the now obsolete Label records. If you have to read in a sheet that contains Label records, be aware that the rest of the API doesn't deal with them, the low level structure only provides read-only semi-immutable structures (the sets are there for interface conformance with NO impelmentation). In short, you need to call this function passing it a reference to the Workbook object. All labels will be converted to LabelSST records and their contained strings will be written to the Shared String tabel (SSTRecord) within the Workbook.

param
wb sheet's matching low level Workbook structure containing the SSTRecord.
see
org.apache.poi.hssf.record.LabelRecord
see
org.apache.poi.hssf.record.LabelSSTRecord
see
org.apache.poi.hssf.record.SSTRecord

         if (log.check( POILogger.DEBUG ))
             log.log(POILogger.DEBUG, "convertLabelRecords called");
         for (int k = offset; k < records.size(); k++)
         {
             Record rec = ( Record ) records.get(k);

             if (rec.getSid() == LabelRecord.sid)
             {
                 LabelRecord oldrec = ( LabelRecord ) rec;

                 records.remove(k);
                 LabelSSTRecord newrec   = new LabelSSTRecord();
                 int            stringid =
                     workbook.addSSTString(new UnicodeString(oldrec.getValue()));

                 newrec.setRow(oldrec.getRow());
                 newrec.setColumn(oldrec.getColumn());
                 newrec.setXFIndex(oldrec.getXFIndex());
                 newrec.setSSTIndex(stringid);
                       records.add(k, newrec);
             }
         }
         if (log.check( POILogger.DEBUG ))
             log.log(POILogger.DEBUG, "convertLabelRecords exit");
     
private voidcopyNodeRecursively(org.apache.poi.poifs.filesystem.Entry entry, org.apache.poi.poifs.filesystem.DirectoryEntry target)

       //System.err.println("copyNodeRecursively called with "+entry.getName()+
       //                   ","+target.getName());
       DirectoryEntry newTarget = null;
       if (entry.isDirectoryEntry()) {
           newTarget = target.createDirectory(entry.getName());
           Iterator entries = ((DirectoryEntry)entry).getEntries();

           while (entries.hasNext()) {
              copyNodeRecursively((Entry)entries.next(),newTarget);
           }
       } else {
         DocumentEntry dentry = (DocumentEntry)entry;
         DocumentInputStream dstream = new DocumentInputStream(dentry);
         target.createDocument(dentry.getName(),dstream);
         dstream.close();
       }
   
private voidcopyNodes(org.apache.poi.poifs.filesystem.POIFSFileSystem source, org.apache.poi.poifs.filesystem.POIFSFileSystem target, java.util.List excepts)
Copies nodes from one POIFS to the other minus the excepts

param
source is the source POIFS to copy from
param
target is the target POIFS to copy to
param
excepts is a list of Strings specifying what nodes NOT to copy

      //System.err.println("CopyNodes called");

      DirectoryEntry root = source.getRoot();
      DirectoryEntry newRoot = target.getRoot();

      Iterator entries = root.getEntries();

      while (entries.hasNext()) {
         Entry entry = (Entry)entries.next();
         if (!isInList(entry.getName(), excepts)) {
             copyNodeRecursively(entry,newRoot);
         }
      }
   
public org.apache.poi.hssf.usermodel.HSSFCellStylecreateCellStyle()
create a new Cell style and add it to the workbook's style table

return
the new Cell Style object

        ExtendedFormatRecord xfr = workbook.createCellXF();
        short index = (short) (getNumCellStyles() - 1);
        HSSFCellStyle style = new HSSFCellStyle(index, xfr);

        return style;
    
public org.apache.poi.hssf.usermodel.HSSFDataFormatcreateDataFormat()
Returns the instance of HSSFDataFormat for this workbook.

return
the HSSFDataFormat object
see
org.apache.poi.hssf.record.FormatRecord
see
org.apache.poi.hssf.record.Record

	if (formatter == null)
	    formatter = new HSSFDataFormat(workbook);
	return formatter;
    
public org.apache.poi.hssf.usermodel.HSSFFontcreateFont()
create a new Font and add it to the workbook's font table

return
new font object

        FontRecord font = workbook.createNewFont();
        short fontindex = (short) (getNumberOfFonts() - 1);

        if (fontindex > 3)
        {
            fontindex++;   // THERE IS NO FOUR!!
        }
        HSSFFont retval = new HSSFFont(fontindex, font);

        return retval;
    
public org.apache.poi.hssf.usermodel.HSSFNamecreateName()
creates a new named range and add it to the model

return
named range high level

        NameRecord nameRecord = workbook.createName();

        HSSFName newName = new HSSFName(workbook, nameRecord);

        names.add(newName);

        return newName;
    
public org.apache.poi.hssf.usermodel.HSSFSheetcreateSheet()
create an HSSFSheet for this HSSFWorkbook, adds it to the sheets and returns the high level representation. Use this to create new sheets.

return
HSSFSheet representing the new sheet.


//        if (getNumberOfSheets() == 3)
//            throw new RuntimeException("You cannot have more than three sheets in HSSF 1.0");
        HSSFSheet sheet = new HSSFSheet(workbook);

        sheets.add(sheet);
        workbook.setSheetName(sheets.size() - 1,
                "Sheet" + (sheets.size() - 1));
        WindowTwoRecord windowTwo = (WindowTwoRecord) sheet.getSheet().findFirstRecordBySid(WindowTwoRecord.sid);
        windowTwo.setSelected(sheets.size() == 1);
        windowTwo.setPaged(sheets.size() == 1);
        return sheet;
    
public org.apache.poi.hssf.usermodel.HSSFSheetcreateSheet(java.lang.String sheetname)
create an HSSFSheet for this HSSFWorkbook, adds it to the sheets and returns the high level representation. Use this to create new sheets.

param
sheetname sheetname to set for the sheet.
return
HSSFSheet representing the new sheet.

        if (workbook.doesContainsSheetName( sheetname, sheets.size() ))
            throw new IllegalArgumentException( "The workbook already contains a sheet of this name" );

        HSSFSheet sheet = new HSSFSheet(workbook);

        sheets.add(sheet);
        workbook.setSheetName(sheets.size() - 1, sheetname);
        WindowTwoRecord windowTwo = (WindowTwoRecord) sheet.getSheet().findFirstRecordBySid(WindowTwoRecord.sid);
        windowTwo.setSelected(sheets.size() == 1);
        windowTwo.setPaged(sheets.size() == 1);
        return sheet;
    
public voiddumpDrawingGroupRecords(boolean fat)
Spits out a list of all the drawing records in the workbook.

        DrawingGroupRecord r = (DrawingGroupRecord) workbook.findFirstRecordBySid( DrawingGroupRecord.sid );
        r.decode();
        List escherRecords = r.getEscherRecords();
        PrintWriter w = new PrintWriter(System.out);
        for ( Iterator iterator = escherRecords.iterator(); iterator.hasNext(); )
        {
            EscherRecord escherRecord = (EscherRecord) iterator.next();
            if (fat)
                System.out.println(escherRecord.toString());
            else
                escherRecord.display(w, 0);
        }
        w.flush();
    
private org.apache.poi.hssf.record.NameRecordfindExistingRowColHeaderNameRecord(int sheetIndex)

        int index = findExistingRowColHeaderNameRecordIdx(sheetIndex);
        if (index == -1)
            return null;
        else
            return (NameRecord)workbook.findNextRecordBySid(NameRecord.sid, index);
    
private intfindExistingRowColHeaderNameRecordIdx(int sheetIndex)

        int index = 0;
        NameRecord r = null;
        while ((r = (NameRecord) workbook.findNextRecordBySid(NameRecord.sid, index)) != null)
        {
            int indexToSheet = r.getEqualsToIndexToSheet() -1;
            if(indexToSheet > -1) { //ignore "GLOBAL" name records
                int nameRecordSheetIndex = workbook.getSheetIndexFromExternSheetIndex(indexToSheet);
                if (isRowColHeaderRecord( r ) && nameRecordSheetIndex == sheetIndex)
                {
                    return index;
                }
            } 
            index++;
        }

        return -1;
    
public org.apache.poi.hssf.usermodel.HSSFFontfindFont(short boldWeight, short color, short fontHeight, java.lang.String name, boolean italic, boolean strikeout, short typeOffset, byte underline)
Finds a font that matches the one with the supplied attributes

//        System.out.println( boldWeight + ", " + color + ", " + fontHeight + ", " + name + ", " + italic + ", " + strikeout + ", " + typeOffset + ", " + underline );
        for (short i = 0; i < workbook.getNumberOfFontRecords(); i++)
        {
            if (i == 4)
                continue;

            FontRecord font = workbook.getFontRecordAt(i);
            HSSFFont hssfFont = new HSSFFont(i, font);
//            System.out.println( hssfFont.getBoldweight() + ", " + hssfFont.getColor() + ", " + hssfFont.getFontHeight() + ", " + hssfFont.getFontName() + ", " + hssfFont.getItalic() + ", " + hssfFont.getStrikeout() + ", " + hssfFont.getTypeOffset() + ", " + hssfFont.getUnderline() );
            if (hssfFont.getBoldweight() == boldWeight
                    && hssfFont.getColor() == color
                    && hssfFont.getFontHeight() == fontHeight
                    && hssfFont.getFontName().equals(name)
                    && hssfFont.getItalic() == italic
                    && hssfFont.getStrikeout() == strikeout
                    && hssfFont.getTypeOffset() == typeOffset
                    && hssfFont.getUnderline() == underline)
            {
//                System.out.println( "Found font" );
                return hssfFont;
            }
        }

//        System.out.println( "No font found" );
        return null;
    
public java.util.ListgetAllPictures()
Gets all pictures from the Workbook.

return
the list of pictures (a list of {@link HSSFPictureData} objects.)

        List pictures = new ArrayList();
        Iterator recordIter = workbook.getRecords().iterator();
        while (recordIter.hasNext())
        {
            Object obj = recordIter.next();
            if (obj instanceof AbstractEscherHolderRecord)
            {
                ((AbstractEscherHolderRecord) obj).decode();
                List escherRecords = ((AbstractEscherHolderRecord) obj).getEscherRecords();
                searchForPictures(escherRecords, pictures);
            }
        }
        return pictures;
    
public booleangetBackupFlag()
determine whether the Excel GUI will backup the workbook when saving.

return
the current setting for backups.

        BackupRecord backupRecord = workbook.getBackupRecord();

        return (backupRecord.getBackup() == 0) ? false
                : true;
    
public byte[]getBytes()
Method getBytes - get the bytes of just the HSSF portions of the XLS file. Use this to construct a POI POIFSFileSystem yourself.

return
byte[] array containing the binary representation of this workbook and all contained sheets, rows, cells, etc.
see
org.apache.poi.hssf.model.Workbook
see
org.apache.poi.hssf.model.Sheet

        if (log.check( POILogger.DEBUG ))
            log.log(DEBUG, "HSSFWorkbook.getBytes()");

        // before getting the workbook size we must tell the sheets that
        // serialization is about to occur.
        for (int k = 0; k < sheets.size(); k++)
            ((HSSFSheet) sheets.get(k)).getSheet().preSerialize();

        int wbsize = workbook.getSize();

        // log.debug("REMOVEME: old sizing method "+workbook.serialize().length);
        // ArrayList sheetbytes = new ArrayList(sheets.size());
        int totalsize = wbsize;

        for (int k = 0; k < sheets.size(); k++)
        {
            workbook.setSheetBof(k, totalsize);
            totalsize += ((HSSFSheet) sheets.get(k)).getSheet().getSize();
        }


/*        if (totalsize < 4096)
        {
            totalsize = 4096;
        }*/
        byte[] retval = new byte[totalsize];
        int pos = workbook.serialize(0, retval);

        // System.arraycopy(wb, 0, retval, 0, wb.length);
        for (int k = 0; k < sheets.size(); k++)
        {

            // byte[] sb = (byte[])sheetbytes.get(k);
            // System.arraycopy(sb, 0, retval, pos, sb.length);
            int len = ((HSSFSheet) sheets.get(k)).getSheet().serialize(pos,
                                retval);
            pos += len;   // sb.length;
        }
/*        for (int k = pos; k < totalsize; k++)
        {
            retval[k] = 0;
        }*/
        return retval;
    
public org.apache.poi.hssf.usermodel.HSSFCellStylegetCellStyleAt(short idx)
get the cell style object at the given index

param
idx index within the set of styles
return
HSSFCellStyle object at the index

        ExtendedFormatRecord xfr = workbook.getExFormatAt(idx);
        HSSFCellStyle style = new HSSFCellStyle(idx, xfr);

        return style;
    
public org.apache.poi.hssf.usermodel.HSSFPalettegetCustomPalette()

        return new HSSFPalette(workbook.getCustomPalette());
    
public shortgetDisplayedTab()
sets the first tab that is displayed in the list of tabs in excel.

return

        return workbook.getWindowOne().getDisplayedTab();
    
public org.apache.poi.hssf.usermodel.HSSFFontgetFontAt(short idx)
get the font at the given index number

param
idx index number
return
HSSFFont at the index

        FontRecord font = workbook.getFontRecordAt(idx);
        HSSFFont retval = new HSSFFont(idx, font);

        return retval;
    
public org.apache.poi.hssf.usermodel.HSSFNamegetNameAt(int index)
gets the Named range

param
index position of the named range
return
named range high level

        HSSFName result = (HSSFName) names.get(index);

        return result;
    
public intgetNameIndex(java.lang.String name)
gets the named range index by his name Note:Excel named ranges are case-insensitive and this method performs a case-insensitive search.

param
name named range name
return
named range index

        int retval = -1;

        for (int k = 0; k < names.size(); k++)
        {
            String nameName = getNameName(k);

            if (nameName.equalsIgnoreCase(name))
            {
                retval = k;
                break;
            }
        }
        return retval;
    
public java.lang.StringgetNameName(int index)
gets the named range name

param
index the named range index (0 based)
return
named range name

        String result = getNameAt(index).getNameName();

        return result;
    
public shortgetNumCellStyles()
get the number of styles the workbook contains

return
count of cell styles

        return (short) workbook.getNumExFormats();
    
public shortgetNumberOfFonts()
get the number of fonts in the font table

return
number of fonts

        return (short) workbook.getNumberOfFontRecords();
    
public intgetNumberOfNames()
gets the total number of named ranges in the workboko

return
number of named ranges

        int result = names.size();
        return result;
    
public intgetNumberOfSheets()
get the number of spreadsheets in the workbook (this will be three after serialization)

return
number of sheets

        return sheets.size();
    
public java.lang.StringgetPrintArea(int sheetIndex)
Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.

param
sheetIndex Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
return
String Null if no print area has been defined

		NameRecord name = workbook.getSpecificBuiltinRecord(NameRecord.BUILTIN_PRINT_AREA, sheetIndex+1);
		if (name == null) return null;
		//adding one here because 0 indicates a global named region; doesnt make sense for print areas

		return name.getAreaReference(workbook);
	
public java.lang.StringgetSSTString(int index)

deprecated
Do not call this method from your applications. Use the methods available in the HSSFRow to get string HSSFCells

        return workbook.getSSTString(index).getString();
    
public shortgetSelectedTab()
gets the tab whose data is actually seen when the sheet is opened. This may be different from the "selected sheet" since excel seems to allow you to show the data of one sheet when another is seen "selected" in the tabs (at the bottom).

see
org.apache.poi.hssf.usermodel.HSSFSheet#setSelected(boolean)
return

        return workbook.getWindowOne().getSelectedTab();
    
public org.apache.poi.hssf.usermodel.HSSFSheetgetSheet(java.lang.String name)
Get sheet with the given name

param
name of the sheet
return
HSSFSheet with the name provided or null if it does not exist

        HSSFSheet retval = null;

        for (int k = 0; k < sheets.size(); k++)
        {
            String sheetname = workbook.getSheetName(k);

            if (sheetname.equals(name))
            {
                retval = (HSSFSheet) sheets.get(k);
            }
        }
        return retval;
    
public org.apache.poi.hssf.usermodel.HSSFSheetgetSheetAt(int index)
Get the HSSFSheet object at the given index.

param
index of the sheet number (0-based physical & logical)
return
HSSFSheet at the provided index

        return (HSSFSheet) sheets.get(index);
    
public intgetSheetIndex(java.lang.String name)
Returns the index of the sheet by his name

param
name the sheet name
return
index of the sheet (0 based)

        int retval = workbook.getSheetIndex(name);

        return retval;
    
public java.lang.StringgetSheetName(int sheet)
get the sheet name

param
sheet Number
return
Sheet name

        if (sheet > (sheets.size() - 1))
        {
            throw new RuntimeException("Sheet out of bounds");
        }
        return workbook.getSheetName(sheet);
    
org.apache.poi.hssf.model.WorkbookgetWorkbook()

        return workbook;
    
public voidinsertChartRecord()
Test only. Do not use

        int loc = workbook.findFirstRecordLocBySid(SSTRecord.sid);
        byte[] data = {
           (byte)0x0F, (byte)0x00, (byte)0x00, (byte)0xF0, (byte)0x52,
           (byte)0x00, (byte)0x00, (byte)0x00, (byte)0x00, (byte)0x00,
           (byte)0x06, (byte)0xF0, (byte)0x18, (byte)0x00, (byte)0x00,
           (byte)0x00, (byte)0x01, (byte)0x08, (byte)0x00, (byte)0x00,
           (byte)0x02, (byte)0x00, (byte)0x00, (byte)0x00, (byte)0x02,
           (byte)0x00, (byte)0x00, (byte)0x00, (byte)0x01, (byte)0x00,
           (byte)0x00, (byte)0x00, (byte)0x01, (byte)0x00, (byte)0x00,
           (byte)0x00, (byte)0x03, (byte)0x00, (byte)0x00, (byte)0x00,
           (byte)0x33, (byte)0x00, (byte)0x0B, (byte)0xF0, (byte)0x12,
           (byte)0x00, (byte)0x00, (byte)0x00, (byte)0xBF, (byte)0x00,
           (byte)0x08, (byte)0x00, (byte)0x08, (byte)0x00, (byte)0x81,
           (byte)0x01, (byte)0x09, (byte)0x00, (byte)0x00, (byte)0x08,
           (byte)0xC0, (byte)0x01, (byte)0x40, (byte)0x00, (byte)0x00,
           (byte)0x08, (byte)0x40, (byte)0x00, (byte)0x1E, (byte)0xF1,
           (byte)0x10, (byte)0x00, (byte)0x00, (byte)0x00, (byte)0x0D,
           (byte)0x00, (byte)0x00, (byte)0x08, (byte)0x0C, (byte)0x00,
           (byte)0x00, (byte)0x08, (byte)0x17, (byte)0x00, (byte)0x00,
           (byte)0x08, (byte)0xF7, (byte)0x00, (byte)0x00, (byte)0x10,
        };
        UnknownRecord r = new UnknownRecord((short)0x00EB, data);
        workbook.getRecords().add(loc, r);
    
private booleanisInList(java.lang.String entry, java.util.List list)

       for (int k = 0; k < list.size(); k++) {
          if (list.get(k).equals(entry)) {
            return true;
          }
       }
       return false;
   
private booleanisRowColHeaderRecord(org.apache.poi.hssf.record.NameRecord r)

        return r.getOptionFlag() == 0x20 && ("" + ((char)7)).equals(r.getNameText());
    
private byte[]newUID()

        byte[] bytes = new byte[16];
        return bytes;
    
public voidremoveName(int index)
remove the named range by his index

param
index named range index (0 based)

        names.remove(index);
        workbook.removeName(index);
    
public voidremoveName(java.lang.String name)
remove the named range by his name

param
name named range name

        int index = getNameIndex(name);

        removeName(index);

    
public voidremovePrintArea(int sheetIndex)
Delete the printarea for the sheet specified

param
sheetIndex Zero-based sheet index (0 = First Sheet)

    	getWorkbook().removeBuiltinRecord(NameRecord.BUILTIN_PRINT_AREA, sheetIndex+1);
    
public voidremoveSheetAt(int index)
removes sheet at the given index

param
index of the sheet (0-based)

        sheets.remove(index);
        workbook.removeSheet(index);
    
private voidsearchForPictures(java.util.List escherRecords, java.util.List pictures)
Performs a recursive search for pictures in the given list of escher records.

param
escherRecords the escher records.
param
pictures the list to populate with the pictures.

        Iterator recordIter = escherRecords.iterator();
        while (recordIter.hasNext())
        {
            Object obj = recordIter.next();
            if (obj instanceof EscherRecord)
            {
                EscherRecord escherRecord = (EscherRecord) obj;

                if (escherRecord instanceof EscherBSERecord)
                {
                    EscherBlipRecord blip = ((EscherBSERecord) escherRecord).getBlipRecord();
                    if (blip instanceof EscherBitmapBlip)
                    {
                        // TODO: Some kind of structure.
                        pictures.add(new HSSFPictureData((EscherBitmapBlip) blip));
                    }
                }

                // Recursive call.
                searchForPictures(escherRecord.getChildRecords(), pictures);
            }
        }
    
public voidsetBackupFlag(boolean backupValue)
determine whether the Excel GUI will backup the workbook when saving.

param
backupValue true to indicate a backup will be performed.

        BackupRecord backupRecord = workbook.getBackupRecord();

        backupRecord.setBackup(backupValue ? (short) 1
                : (short) 0);
    
public voidsetDisplayedTab(short index)
sets the first tab that is displayed in the list of tabs in excel.

param
index

        workbook.getWindowOne().setDisplayedTab(index);
    
public voidsetPrintArea(int sheetIndex, java.lang.String reference)
Sets the printarea for the sheet provided

i.e. Reference = $A$1:$B$2

param
sheetIndex Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
param
reference Valid name Reference for the Print Area

		NameRecord name = workbook.getSpecificBuiltinRecord(NameRecord.BUILTIN_PRINT_AREA, sheetIndex+1);


		if (name == null)
			name = workbook.createBuiltInName(NameRecord.BUILTIN_PRINT_AREA, sheetIndex+1);
       //adding one here because 0 indicates a global named region; doesnt make sense for print areas

	    short externSheetIndex = getWorkbook().checkExternSheet(sheetIndex);
		name.setExternSheetNumber(externSheetIndex);
		name.setAreaReference(reference);


	
public voidsetPrintArea(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow)
For the Convenience of Java Programmers maintaining pointers.

see
#setPrintArea(int, String)
param
sheetIndex Zero-based sheet index (0 = First Sheet)
param
startColumn Column to begin printarea
param
endColumn Column to end the printarea
param
startRow Row to begin the printarea
param
endRow Row to end the printarea


		//using absolute references because they dont get copied and pasted anyway
		CellReference cell = new CellReference(startRow, startColumn, true, true);
		String reference = cell.toString();

		cell = new CellReference(endRow, endColumn, true, true);
		reference = reference+":"+cell.toString();

		setPrintArea(sheetIndex, reference);
	
private voidsetPropertiesFromWorkbook(org.apache.poi.hssf.model.Workbook book)
used internally to set the workbook properties.

        this.workbook = book;

        // none currently
    
public voidsetRepeatingRowsAndColumns(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow)
Sets the repeating rows and columns for a sheet (as found in File->PageSetup->Sheet). This is function is included in the workbook because it creates/modifies name records which are stored at the workbook level.

To set just repeating columns:

workbook.setRepeatingRowsAndColumns(0,0,1,-1-1);
To set just repeating rows:
workbook.setRepeatingRowsAndColumns(0,-1,-1,0,4);
To remove all repeating rows and columns for a sheet.
workbook.setRepeatingRowsAndColumns(0,-1,-1,-1,-1);

param
sheetIndex 0 based index to sheet.
param
startColumn 0 based start of repeating columns.
param
endColumn 0 based end of repeating columns.
param
startRow 0 based start of repeating rows.
param
endRow 0 based end of repeating rows.

        // Check arguments
        if (startColumn == -1 && endColumn != -1) throw new IllegalArgumentException("Invalid column range specification");
        if (startRow == -1 && endRow != -1) throw new IllegalArgumentException("Invalid row range specification");
        if (startColumn < -1 || startColumn >= 0xFF) throw new IllegalArgumentException("Invalid column range specification");
        if (endColumn < -1 || endColumn >= 0xFF) throw new IllegalArgumentException("Invalid column range specification");
        if (startRow < -1 || startRow > 65535) throw new IllegalArgumentException("Invalid row range specification");
        if (endRow < -1 || endRow > 65535) throw new IllegalArgumentException("Invalid row range specification");
        if (startColumn > endColumn) throw new IllegalArgumentException("Invalid column range specification");
        if (startRow > endRow) throw new IllegalArgumentException("Invalid row range specification");

        HSSFSheet sheet = getSheetAt(sheetIndex);
        short externSheetIndex = getWorkbook().checkExternSheet(sheetIndex);

        boolean settingRowAndColumn =
                startColumn != -1 && endColumn != -1 && startRow != -1 && endRow != -1;
        boolean removingRange =
                startColumn == -1 && endColumn == -1 && startRow == -1 && endRow == -1;

        boolean isNewRecord = false;
        NameRecord nameRecord;
        nameRecord = findExistingRowColHeaderNameRecord(sheetIndex);
        if (removingRange )
        {
            if (nameRecord != null)
                workbook.removeName(findExistingRowColHeaderNameRecordIdx(sheetIndex+1));
            return;
        }
        if ( nameRecord == null )
        {
            nameRecord = workbook.createBuiltInName(NameRecord.BUILTIN_PRINT_TITLE, sheetIndex+1);
            //does a lot of the house keeping for builtin records, like setting lengths to zero etc
            isNewRecord = true;
        }

        short definitionTextLength = settingRowAndColumn ? (short)0x001a : (short)0x000b;
        nameRecord.setDefinitionTextLength(definitionTextLength);

        Stack ptgs = new Stack();

        if (settingRowAndColumn)
        {
            MemFuncPtg memFuncPtg = new MemFuncPtg();
            memFuncPtg.setLenRefSubexpression(23);
            ptgs.add(memFuncPtg);
        }
        if (startColumn >= 0)
        {
            Area3DPtg area3DPtg1 = new Area3DPtg();
            area3DPtg1.setExternSheetIndex(externSheetIndex);
            area3DPtg1.setFirstColumn((short)startColumn);
            area3DPtg1.setLastColumn((short)endColumn);
            area3DPtg1.setFirstRow((short)0);
            area3DPtg1.setLastRow((short)0xFFFF);
            ptgs.add(area3DPtg1);
        }
        if (startRow >= 0)
        {
            Area3DPtg area3DPtg2 = new Area3DPtg();
            area3DPtg2.setExternSheetIndex(externSheetIndex);
            area3DPtg2.setFirstColumn((short)0);
            area3DPtg2.setLastColumn((short)0x00FF);
            area3DPtg2.setFirstRow((short)startRow);
            area3DPtg2.setLastRow((short)endRow);
            ptgs.add(area3DPtg2);
        }
        if (settingRowAndColumn)
        {
            UnionPtg unionPtg = new UnionPtg();
            ptgs.add(unionPtg);
        }
        nameRecord.setNameDefinition(ptgs);

        if (isNewRecord)
        {
            HSSFName newName = new HSSFName(workbook, nameRecord);
            names.add(newName);
        }

        HSSFPrintSetup printSetup = sheet.getPrintSetup();
        printSetup.setValidSettings(false);

        WindowTwoRecord w2 = (WindowTwoRecord) sheet.getSheet().findFirstRecordBySid(WindowTwoRecord.sid);
        w2.setPaged(true);
    
public voidsetSelectedTab(short index)
sets the tab whose data is actually seen when the sheet is opened. This may be different from the "selected sheet" since excel seems to allow you to show the data of one sheet when another is seen "selected" in the tabs (at the bottom).

see
org.apache.poi.hssf.usermodel.HSSFSheet#setSelected(boolean)
param
index

        workbook.getWindowOne().setSelectedTab(index);
    
public voidsetSheetName(int sheet, java.lang.String name)
set the sheet name. Will throw IllegalArgumentException if the name is greater than 31 chars or contains /\?*[]

param
sheet number (0 based)



                                 
         
    
        if (workbook.doesContainsSheetName( name, sheet ))
            throw new IllegalArgumentException( "The workbook already contains a sheet with this name" );

        if (sheet > (sheets.size() - 1))
        {
            throw new RuntimeException("Sheet out of bounds");
        }
        
        workbook.setSheetName( sheet, name);
    
public voidsetSheetName(int sheet, java.lang.String name, short encoding)
set the sheet name forcing the encoding. Forcing the encoding IS A BAD IDEA!!!

deprecated
3-Jan-2006 POI now automatically detects unicode and sets the encoding appropriately. Simply use setSheetName(int sheet, String encoding)
throws
IllegalArgumentException if the name is greater than 31 chars or contains /\?*[]
param
sheet number (0 based)

        if (workbook.doesContainsSheetName( name, sheet ))
            throw new IllegalArgumentException( "The workbook already contains a sheet with this name" );

        if (sheet > (sheets.size() - 1))
        {
            throw new RuntimeException("Sheet out of bounds");
        }

        switch ( encoding ) {
        case ENCODING_COMPRESSED_UNICODE:
        case ENCODING_UTF_16:
            break;

        default:
            // TODO java.io.UnsupportedEncodingException
            throw new RuntimeException( "Unsupported encoding" );
        }

        workbook.setSheetName( sheet, name, encoding );
    
public voidsetSheetOrder(java.lang.String sheetname, int pos)
sets the order of appearance for a given sheet.

param
sheetname the name of the sheet to reorder
param
pos the position that we want to insert the sheet into (0 based)

        sheets.add(pos,sheets.remove(getSheetIndex(sheetname)));
        workbook.setSheetOrder(sheetname, pos);
    
public voidwrite(java.io.OutputStream stream)
Method write - write out this workbook to an Outputstream. Constructs a new POI POIFSFileSystem, passes in the workbook binary representation and writes it out.

param
stream - the java OutputStream you wish to write the XLS to
exception
IOException if anything can't be written.
see
org.apache.poi.poifs.filesystem.POIFSFileSystem

        byte[] bytes = getBytes();
        POIFSFileSystem fs = new POIFSFileSystem();

        fs.createDocument(new ByteArrayInputStream(bytes), "Workbook");

        if (preserveNodes) {
            List excepts = new ArrayList(1);
            excepts.add("Workbook");
            copyNodes(this.poifs,fs,excepts);
        }
        fs.writeFilesystem(stream);
        //poifs.writeFilesystem(stream);