|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Workbook
High level representation of a Excel 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.
Field Summary | |
---|---|
static int |
PICTURE_TYPE_DIB
Device independent bitmap |
static int |
PICTURE_TYPE_EMF
Extended windows meta file |
static int |
PICTURE_TYPE_JPEG
JPEG format |
static int |
PICTURE_TYPE_PICT
Mac PICT format |
static int |
PICTURE_TYPE_PNG
PNG format |
static int |
PICTURE_TYPE_WMF
Windows Meta File |
static int |
SHEET_STATE_HIDDEN
Indicates the book window is hidden, but can be shown by the user via the user interface. |
static int |
SHEET_STATE_VERY_HIDDEN
Indicates the sheet is hidden and cannot be shown in the user interface (UI). |
static int |
SHEET_STATE_VISIBLE
Indicates the sheet is visible. |
Method Summary | |
---|---|
int |
addPicture(byte[] pictureData,
int format)
Adds a picture to the workbook. |
Sheet |
cloneSheet(int sheetNum)
Create an Sheet from an existing sheet in the Workbook. |
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()
Sreate an Sheet for this Workbook, adds it to the sheets and returns the high level representation. |
Sheet |
createSheet(java.lang.String sheetname)
Create an Sheet for this Workbook, adds it to the sheets and returns the high level representation. |
Font |
findFont(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 |
int |
getActiveSheetIndex()
Convenience method to get the active sheet. |
java.util.List |
getAllPictures()
Gets all pictures from the Workbook. |
CellStyle |
getCellStyleAt(short 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 |
Row.MissingCellPolicy |
getMissingCellPolicy()
Retrieves the current policy on what to do when getting missing or blank cells from a row. |
Name |
getName(java.lang.String name)
|
Name |
getNameAt(int nameIndex)
|
int |
getNameIndex(java.lang.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 |
short |
getNumCellStyles()
Get the number of styles the workbook contains |
java.lang.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(java.lang.String name)
Get sheet with the given name |
Sheet |
getSheetAt(int index)
Get the Sheet object at the given index. |
int |
getSheetIndex(Sheet sheet)
Returns the index of the given sheet |
int |
getSheetIndex(java.lang.String name)
Returns the index of the sheet by his name |
java.lang.String |
getSheetName(int sheet)
Set the sheet name |
boolean |
isHidden()
|
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(java.lang.String name)
Remove a defined name by name |
void |
removePrintArea(int sheetIndex)
Delete the printarea for the sheet specified |
void |
removeSheetAt(int index)
Removes sheet at the given index |
void |
setActiveSheet(int sheetIndex)
Convenience method to set the active sheet. |
void |
setFirstVisibleTab(int sheetIndex)
Sets the first tab that is displayed in the list of tabs in excel. |
void |
setHidden(boolean hiddenFlag)
|
void |
setMissingCellPolicy(Row.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,
java.lang.String reference)
Sets the printarea for the sheet provided |
void |
setRepeatingRowsAndColumns(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). |
void |
setSelectedTab(int index)
Sets the tab whose data is actually seen when the sheet is opened. |
void |
setSheetHidden(int sheetIx,
boolean hidden)
Hide or unhide a sheet |
void |
setSheetHidden(int sheetIx,
int hidden)
Hide or unhide a sheet. |
void |
setSheetName(int sheet,
java.lang.String name)
Set the sheet name. |
void |
setSheetOrder(java.lang.String sheetname,
int pos)
Sets the order of appearance for a given sheet. |
void |
write(java.io.OutputStream stream)
Write out this workbook to an Outputstream. |
Field Detail |
---|
static final int PICTURE_TYPE_EMF
static final int PICTURE_TYPE_WMF
static final int PICTURE_TYPE_PICT
static final int PICTURE_TYPE_JPEG
static final int PICTURE_TYPE_PNG
static final int PICTURE_TYPE_DIB
static final int SHEET_STATE_VISIBLE
setSheetHidden(int, int)
,
Constant Field Valuesstatic final int SHEET_STATE_HIDDEN
setSheetHidden(int, int)
,
Constant Field Valuesstatic final int SHEET_STATE_VERY_HIDDEN
In Excel this state is only available programmatically in VBA:
ThisWorkbook.Sheets("MySheetName").Visible = xlSheetVeryHidden
setSheetHidden(int, int)
,
Constant Field ValuesMethod Detail |
---|
int getActiveSheetIndex()
void setActiveSheet(int sheetIndex)
sheetIndex
- index of the active sheet (0-based)int getFirstVisibleTab()
void setFirstVisibleTab(int sheetIndex)
sheetIndex
- the first tab that to display in the list of tabs (0-based)void setSheetOrder(java.lang.String sheetname, int pos)
sheetname
- the name of the sheet to reorderpos
- the position that we want to insert the sheet into (0 based)void setSelectedTab(int index)
index
- the index of the sheet to select (0 based)Sheet.setSelected(boolean)
void setSheetName(int sheet, java.lang.String name)
sheet
- number (0 based)
java.lang.IllegalArgumentException
- if the name is greater than 31 chars or contains /\?*[]
java.lang.String getSheetName(int sheet)
sheet
- sheet number (0 based)
int getSheetIndex(java.lang.String name)
name
- the sheet name
int getSheetIndex(Sheet sheet)
sheet
- the sheet to look up
Sheet createSheet()
Sheet createSheet(java.lang.String sheetname)
sheetname
- sheetname to set for the sheet.
java.lang.IllegalArgumentException
- if the name is greater than 31 chars or contains /\?*[]
Sheet cloneSheet(int sheetNum)
int getNumberOfSheets()
Sheet getSheetAt(int index)
index
- of the sheet number (0-based physical & logical)
Sheet getSheet(java.lang.String name)
name
- of the sheet
null
if it does not existvoid removeSheetAt(int index)
index
- of the sheet to remove (0-based)void setRepeatingRowsAndColumns(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow)
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);
sheetIndex
- 0 based index to sheet.startColumn
- 0 based start of repeating columns.endColumn
- 0 based end of repeating columns.startRow
- 0 based start of repeating rows.endRow
- 0 based end of repeating rows.Font createFont()
Font findFont(short boldWeight, short color, short fontHeight, java.lang.String name, boolean italic, boolean strikeout, short typeOffset, byte underline)
null
short getNumberOfFonts()
Font getFontAt(short idx)
idx
- index number (0-based)
CellStyle createCellStyle()
short getNumCellStyles()
CellStyle getCellStyleAt(short idx)
idx
- index within the set of styles (0-based)
void write(java.io.OutputStream stream) throws java.io.IOException
stream
- - the java OutputStream you wish to write to
java.io.IOException
- if anything can't be written.int getNumberOfNames()
Name getName(java.lang.String name)
name
- the name of the defined name
null
if not found.Name getNameAt(int nameIndex)
nameIndex
- position of the named range (0-based)
java.lang.IllegalArgumentException
- if the supplied index is invalidName createName()
int getNameIndex(java.lang.String name)
name
- the name of the defined name
void removeName(int index)
index
- named range index (0 based)void removeName(java.lang.String name)
name
- the name of the defined namevoid setPrintArea(int sheetIndex, java.lang.String reference)
i.e. Reference = $A$1:$B$2
sheetIndex
- Zero-based sheet index (0 Represents the first sheet to keep consistent with java)reference
- Valid name Reference for the Print Areavoid setPrintArea(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow)
sheetIndex
- Zero-based sheet index (0 = First Sheet)startColumn
- Column to begin printareaendColumn
- Column to end the printareastartRow
- Row to begin the printareaendRow
- Row to end the printareasetPrintArea(int, String)
java.lang.String getPrintArea(int sheetIndex)
sheetIndex
- Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
void removePrintArea(int sheetIndex)
sheetIndex
- Zero-based sheet index (0 = First Sheet)Row.MissingCellPolicy getMissingCellPolicy()
The default is to return blank and null cells.
Row.MissingCellPolicy
void setMissingCellPolicy(Row.MissingCellPolicy missingCellPolicy)
Row.getCell(int)
}. See
Row.MissingCellPolicy
DataFormat createDataFormat()
int addPicture(byte[] pictureData, int format)
pictureData
- The bytes of the pictureformat
- The format of the picture.
PICTURE_TYPE_EMF
,
PICTURE_TYPE_WMF
,
PICTURE_TYPE_PICT
,
PICTURE_TYPE_JPEG
,
PICTURE_TYPE_PNG
,
PICTURE_TYPE_DIB
java.util.List getAllPictures()
PictureData
objects.)CreationHelper getCreationHelper()
boolean isHidden()
false
if this workbook is not visible in the GUIvoid setHidden(boolean hiddenFlag)
hiddenFlag
- pass false
to make the workbook visible in the GUIboolean isSheetHidden(int sheetIx)
Note that a sheet could instead be set to be very hidden, which is different
(isSheetVeryHidden(int)
)
sheetIx
- Number
true
if sheet is hiddenboolean isSheetVeryHidden(int sheetIx)
This is different from the normal hidden status
(isSheetHidden(int)
)
sheetIx
- sheet index to check
true
if sheet is very hiddenvoid setSheetHidden(int sheetIx, boolean hidden)
sheetIx
- the sheet index (0-based)hidden
- True to mark the sheet as hidden, false otherwisevoid setSheetHidden(int sheetIx, int hidden)
sheetIx
- the sheet index (0-based)hidden
- one of the following Workbook
constants:
Workbook.SHEET_STATE_VISIBLE
,
Workbook.SHEET_STATE_HIDDEN
, or
Workbook.SHEET_STATE_VERY_HIDDEN
.
java.lang.IllegalArgumentException
- if the supplied sheet index or state is invalid
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |