Java org.apache.poi.ss.usermodel Workbook fields, constructors, methods, implement or subclass

Introduction

In this page you can find the methods, fields and constructors for org.apache.poi.ss.usermodel Workbook.

The text is from its open source code.

Implementation

org.apache.poi.ss.usermodel.Workbook has the following implementations.
Click this link to see all its implementation.

Field

int	PICTURE_TYPE_EMF Extended windows meta file
int	PICTURE_TYPE_WMF Windows Meta File
int	PICTURE_TYPE_PICT Mac PICT format
int	PICTURE_TYPE_JPEG JPEG format
int	PICTURE_TYPE_PNG PNG format
int	PICTURE_TYPE_DIB Device independent bitmap

Method

int	addPicture(byte[] pictureData, int format) Adds a picture to the workbook.
void	addToolPack(UDFFinder toopack) Register a new toolpack in this workbook.
Sheet	cloneSheet(int sheetNum) Create an Sheet from an existing sheet in the Workbook.
void	close() Close the underlying input resource (File or Stream), from which the Workbook was read.
CellStyle	createCellStyle() Create a new Cell style and add it to the workbook's style table
DataFormat	createDataFormat() Returns the instance of DataFormat for this workbook.
Font	createFont() Create a new Font and add it to the workbook's font table
Name	createName() Creates a new (uninitialised) defined name in this workbook
Sheet	createSheet(String sheetname) Create a new sheet for this Workbook and return the high level representation.
Sheet	createSheet() Create a Sheet for this Workbook, adds it to the sheets and returns the high level representation.
Font	findFont(boolean bold, short color, short fontHeight, String name, boolean italic, boolean strikeout, short typeOffset, byte underline) Finds a font that matches the one with the supplied attributes
int	getActiveSheetIndex() Convenience method to get the active sheet.
List	getAllPictures() Gets all pictures from the Workbook.
CellStyle	getCellStyleAt(int idx) Get the cell style object at the given index
CreationHelper	getCreationHelper() Returns an object that handles instantiating concrete classes of the various instances one needs for HSSF and XSSF.
int	getFirstVisibleTab() Gets the first tab that is displayed in the list of tabs in excel.
Font	getFontAt(short idx) Get the font at the given index number
Font	getFontAt(int idx) Get the font at the given index number
Name	getName(String name)
Name	getNameAt(int nameIndex)
int	getNameIndex(String name) Gets the defined name index by name Note: Excel defined names are case-insensitive and this method performs a case-insensitive search.
short	getNumberOfFonts() Get the number of fonts in the font table
int	getNumberOfNames()
int	getNumberOfSheets() Get the number of spreadsheets in the workbook
int	getNumCellStyles() Get the number of styles the workbook contains
String	getPrintArea(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.
Sheet	getSheet(String name) Get sheet with the given name
Sheet	getSheetAt(int index) Get the Sheet object at the given index.
int	getSheetIndex(String name) Returns the index of the sheet by his name
int	getSheetIndex(Sheet sheet) Returns the index of the given sheet
String	getSheetName(int sheet) Get the sheet name
boolean	isSheetHidden(int sheetIx) Check whether a sheet is hidden.
boolean	isSheetVeryHidden(int sheetIx) Check whether a sheet is very hidden.
void	removeName(int index) Remove the defined name at the specified index
void	removeName(String name) Remove a defined name by name
void	removeName(Name name) Remove a defined name
void	removeSheetAt(int index) Removes sheet at the given index
void	setActiveSheet(int sheetIndex) Convenience method to set the active sheet.
void	setForceFormulaRecalculation(boolean value) Whether the application shall perform a full recalculation when the workbook is opened.
void	setMissingCellPolicy(MissingCellPolicy missingCellPolicy) Sets the policy on what to do when getting missing or blank cells from a row.
void	setPrintArea(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow) For the Convenience of Java Programmers maintaining pointers.
void	setPrintArea(int sheetIndex, String reference) Sets the printarea for the sheet provided i.e.
void	setSheetHidden(int sheetIx, boolean hidden) Hide or unhide a sheet.
void	setSheetName(int sheet, String name) Set the sheet name.
void	setSheetOrder(String sheetname, int pos) Sets the order of appearance for a given sheet.
Iterator	sheetIterator() Returns an iterator of the sheets in the workbook in sheet order.
void	write(OutputStream stream) Write out this workbook to an Outputstream.