Return-Path: X-Original-To: apmail-poi-commits-archive@minotaur.apache.org Delivered-To: apmail-poi-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 2F12518654 for ; Sun, 1 Nov 2015 22:51:10 +0000 (UTC) Received: (qmail 89855 invoked by uid 500); 1 Nov 2015 22:51:10 -0000 Delivered-To: apmail-poi-commits-archive@poi.apache.org Received: (qmail 89817 invoked by uid 500); 1 Nov 2015 22:51:10 -0000 Mailing-List: contact commits-help@poi.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@poi.apache.org Delivered-To: mailing list commits@poi.apache.org Received: (qmail 89808 invoked by uid 99); 1 Nov 2015 22:51:10 -0000 Received: from Unknown (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 01 Nov 2015 22:51:10 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 7CFCF18097A for ; Sun, 1 Nov 2015 22:51:09 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 1.79 X-Spam-Level: * X-Spam-Status: No, score=1.79 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, T_RP_MATCHES_RCVD=-0.01] autolearn=disabled Received: from mx1-us-west.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id MhgdiM3k0Ozb for ; Sun, 1 Nov 2015 22:50:55 +0000 (UTC) Received: from mailrelay1-us-west.apache.org (mailrelay1-us-west.apache.org [209.188.14.139]) by mx1-us-west.apache.org (ASF Mail Server at mx1-us-west.apache.org) with ESMTP id 60095203BD for ; Sun, 1 Nov 2015 22:50:55 +0000 (UTC) Received: from svn01-us-west.apache.org (svn.apache.org [10.41.0.6]) by mailrelay1-us-west.apache.org (ASF Mail Server at mailrelay1-us-west.apache.org) with ESMTP id B0A2CE0E95 for ; Sun, 1 Nov 2015 22:50:54 +0000 (UTC) Received: from svn01-us-west.apache.org (localhost [127.0.0.1]) by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org) with ESMTP id 870CF3A0A5D for ; Sun, 1 Nov 2015 22:50:54 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1711857 [3/5] - in /poi/site/publish: ./ apidocs/ apidocs/org/apache/poi/ apidocs/org/apache/poi/hslf/model/textproperties/ apidocs/org/apache/poi/hslf/model/textproperties/class-use/ apidocs/org/apache/poi/hslf/usermodel/ apidocs/org/apac... Date: Sun, 01 Nov 2015 22:50:53 -0000 To: commits@poi.apache.org From: nick@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20151101225054.870CF3A0A5D@svn01-us-west.apache.org> Modified: poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.html?rev=1711857&r1=1711856&r2=1711857&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.html Sun Nov 1 22:50:51 2015 @@ -147,27 +147,33 @@ implements create(HSSFWorkbook book)  +HSSFName +createName() +
Return the underlying workbook
+ + + Ptg get3DReferencePtg(AreaReference areaRef, SheetIdentifier sheet)
Produce the appropriate Ptg for a 3d area reference
- + Ptg get3DReferencePtg(CellReference cr, SheetIdentifier sheet)
Produce the appropriate Ptg for a 3d cell reference
- + EvaluationWorkbook.ExternalName getExternalName(int externSheetIndex, int externNameIndex)
HSSF Only - fetch the external-style name details
- + EvaluationWorkbook.ExternalName getExternalName(java.lang.String nameName, java.lang.String sheetName, @@ -175,13 +181,13 @@ implements XSSF Only - fetch the external-style name details - + EvaluationWorkbook.ExternalSheet getExternalSheet(int externSheetIndex)
HSSF Only - fetch the external-style sheet details
- + EvaluationWorkbook.ExternalSheet getExternalSheet(java.lang.String firstSheetName, java.lang.String lastSheetName, @@ -189,81 +195,83 @@ implements XSSF Only - fetch the external-style sheet details - + int getExternalSheetIndex(java.lang.String sheetName)
gets the externSheet index for a sheet from this workbook
- + int getExternalSheetIndex(java.lang.String workbookName, java.lang.String sheetName)
gets the externSheet index for a sheet from an external workbook
- + Ptg[] getFormulaTokens(EvaluationCell evalCell)  - + EvaluationName getName(NamePtg namePtg)  - + EvaluationName getName(java.lang.String name, int sheetIndex)
Lookup a named range by its name.
- + java.lang.String getNameText(NamePtg namePtg)  - + NameXPtg getNameXPtg(java.lang.String name, - SheetIdentifier sheet)  + SheetIdentifier sheet)
+
Return an external name (named range, function, user-defined function) Ptg
+ - + EvaluationSheet getSheet(int sheetIndex)  - + java.lang.String getSheetFirstNameByExternSheet(int externSheetIndex)  - + int getSheetIndex(EvaluationSheet evalSheet)  - + int getSheetIndex(java.lang.String sheetName)
Finds a sheet index by case insensitive name.
- + java.lang.String getSheetLastNameByExternSheet(int externSheetIndex)  - + java.lang.String getSheetName(int sheetIndex)  - + SpreadsheetVersion getSpreadsheetVersion()
Returns an enum holding spreadhseet properties specific to an Excel version ( max column and row numbers, max arguments to a function, etc.)
- + UDFFinder getUDFFinder()  - + java.lang.String resolveNameXText(NameXPtg n)  @@ -298,6 +306,21 @@ implements HSSFEvaluationWorkbook create(HSSFWorkbook book) + + + + @@ -369,6 +392,7 @@ implements NameXPtg getNameXPtg(java.lang.String name, SheetIdentifier sheet) +
Return an external name (named range, function, user-defined function) Ptg
Specified by:
getNameXPtg in interface FormulaParsingWorkbook
Modified: poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFSheet.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFSheet.html?rev=1711857&r1=1711856&r2=1711857&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFSheet.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFSheet.html Sun Nov 1 22:50:51 2015 @@ -192,46 +192,38 @@ implements -int -addMergedRegion(Region region) -
Deprecated.  -
(Aug-2008) use CellRangeAddress instead of Region
-
- - - void addValidationData(DataValidation dataValidation)
Creates a data validation object
- + void autoSizeColumn(int column)
Adjusts the column width to fit the contents.
- + void autoSizeColumn(int column, boolean useMergedCells)
Adjusts the column width to fit the contents.
- + HSSFPatriarch createDrawingPatriarch()
Creates the top-level drawing patriarch.
- + void createFreezePane(int colSplit, int rowSplit)
Creates a split (freezepane).
- + void createFreezePane(int colSplit, int rowSplit, @@ -240,13 +232,13 @@ implements Creates a split (freezepane). - + HSSFRow createRow(int rownum)
Create a new row within the sheet and return the high level representation
- + void createSplitPane(int xSplitPos, int ySplitPos, @@ -256,7 +248,7 @@ implements Creates a split pane. - + void dumpDrawingRecords(boolean fat, java.io.PrintWriter pw) @@ -264,49 +256,49 @@ implements + protected HSSFComment findCellComment(int row, int column)  - + boolean getAlternateExpression()
whether alternate expression evaluation is on
- + boolean getAlternateFormula()
whether alternative formula entry is on
- + boolean getAutobreaks()
show automatic page breaks or not
- + HSSFComment getCellComment(int row, int column)
Returns cell comment for the specified row and column
- + int[] getColumnBreaks()
Retrieves all the vertical page breaks
- + int getColumnOutlineLevel(int columnIndex)
Returns the column outline level.
- + HSSFCellStyle getColumnStyle(int column)
Returns the HSSFCellStyle that applies to the given @@ -314,13 +306,13 @@ implements + int getColumnWidth(int columnIndex)
get the width (in units of 1/256th of a character width )
- + short getColumnWidth(short columnIndex)
Deprecated.  @@ -328,131 +320,131 @@ implements + float getColumnWidthInPixels(int column)
get the width in pixel
- + DataValidationHelper getDataValidationHelper()  - + java.util.List<HSSFDataValidation> getDataValidations()
Returns the list of DataValidation in the sheet.
- + int getDefaultColumnWidth()
get the default column width for the sheet (if the columns do not define their own width) in characters
- + short getDefaultRowHeight()
get the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point)
- + float getDefaultRowHeightInPoints()
get the default row height for the sheet (if the rows do not define their own height) in points.
- + boolean getDialog()
get whether sheet is a dialog sheet or not
- + boolean getDisplayGuts()
get whether to display the guts or not
- + EscherAggregate getDrawingEscherAggregate()
Returns the agregate escher records for this sheet, it there is one.
- + HSSFPatriarch getDrawingPatriarch()
This will hold any graphics or charts for the sheet.
- + int getFirstRowNum()
Gets the first row on the sheet
- + boolean getFitToPage()
fit to page option is on
- + HSSFFooter getFooter()
Gets the user model for the default document footer.
- + boolean getForceFormulaRecalculation()
Whether a record must be inserted or not at generation to indicate that formula must be recalculated when workbook is opened.
- + HSSFHeader getHeader()
Gets the user model for the default document header.
- + boolean getHorizontallyCenter()
Determine whether printed output for this sheet will be horizontally centered.
- + int getLastRowNum()
Gets the number last row on the sheet.
- + short getLeftCol()
The left col in the visible view when the sheet is first viewed after opening it in a viewer
- + double getMargin(short margin)
Gets the size of the margin in inches.
- + CellRangeAddress getMergedRegion(int index)
Returns the merged region at the specified index
- + Region getMergedRegionAt(int index)
Deprecated.  @@ -460,122 +452,122 @@ implements + java.util.List<CellRangeAddress> getMergedRegions()
Returns the list of merged regions.
- + int getNumMergedRegions()
returns the number of merged regions
- + boolean getObjectProtect()
Answer whether object protection is enabled or disabled
- + PaneInformation getPaneInformation()
Returns the information regarding the currently configured pane (split or freeze).
- + short getPassword()  - + int getPhysicalNumberOfRows()
Returns the number of physically defined rows (NOT the number of rows in the sheet)
- + HSSFPrintSetup getPrintSetup()
Gets the print setup object.
- + boolean getProtect()
Answer whether protection is enabled or disabled
- + CellRangeAddress getRepeatingColumns()
Gets the repeating columns used when printing the sheet, as found in File->PageSetup->Sheet.
- + CellRangeAddress getRepeatingRows()
Gets the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.
- + HSSFRow getRow(int rowIndex)
Returns the logical row (not physical) 0-based.
- + int[] getRowBreaks()
Retrieves all the horizontal page breaks
- + boolean getRowSumsBelow()
get if row summaries appear below detail in the outline
- + boolean getRowSumsRight()
get if col summaries appear right of the detail in the outline
- + boolean getScenarioProtect()
Answer whether scenario protection is enabled or disabled
- + HSSFSheetConditionalFormatting getSheetConditionalFormatting()
The 'Conditional Formatting' facet for this Sheet
- + java.lang.String getSheetName()
Returns the name of this sheet
- + short getTopRow()
The top row in the visible view when the sheet is first viewed after opening it in a viewer
- + boolean getVerticallyCenter()
Determine whether printed output for this sheet will be vertically centered.
- + boolean getVerticallyCenter(boolean value)
Deprecated.  @@ -583,20 +575,20 @@ implements + HSSFWorkbook getWorkbook()
Return the parent workbook
- + void groupColumn(int fromColumn, int toColumn)
Create an outline for the provided column range.
- + void groupColumn(short fromColumn, short toColumn) @@ -605,34 +597,34 @@ implements + void groupRow(int fromRow, int toRow)
Tie a range of cell together so that they can be collapsed or expanded
- + protected void insertChartRecords(java.util.List<Record> records)  - + boolean isActive()  - + boolean isColumnBroken(int column)
Determines if there is a page break at the indicated column
- + boolean isColumnHidden(int columnIndex)
Get the hidden state for a given column.
- + boolean isColumnHidden(short columnIndex)
Deprecated.  @@ -640,166 +632,166 @@ implements + boolean isDisplayFormulas()
Returns if formulas are displayed.
- + boolean isDisplayGridlines()
Returns if gridlines are displayed.
- + boolean isDisplayRowColHeadings()
Returns if RowColHeadings are displayed.
- + boolean isDisplayZeros()
Gets the flag indicating whether the window should show 0 (zero) in cells containing zero value.
- + boolean isGridsPrinted()
get whether gridlines are printed.
- + boolean isPrintGridlines()
Returns whether gridlines are printed.
- + boolean isRightToLeft()
Whether the text is displayed in right-to-left mode in the window
- + boolean isRowBroken(int row)
Determines if there is a page break at the indicated row
- + boolean isSelected()
Note - this is not the same as whether the sheet is focused (isActive)
- + java.util.Iterator<Row> iterator()
Alias for rowIterator() to allow foreach loops
- + protected void preSerialize()
check whether the data of sheet can be serialized
- + void protectSheet(java.lang.String password)
Sets the protection enabled as well as the password
- + CellRange<HSSFCell> removeArrayFormula(Cell cell)
Remove a Array Formula from this sheet.
- + void removeColumnBreak(int column)
Removes a page break at the indicated column
- + void removeMergedRegion(int index)
removes a merged region of cells (hence letting them free)
- + void removeRow(Row row)
Remove a row from this sheet.
- + void removeRowBreak(int row)
Removes the page break at the indicated row
- + java.util.Iterator<Row> rowIterator()
Returns an iterator of the physical rows
- + void setActive(boolean sel)
Sets whether sheet is selected.
- + void setAlternativeExpression(boolean b)
whether alternate expression evaluation is on
- + void setAlternativeFormula(boolean b)
whether alternative formula entry is on
- + CellRange<HSSFCell> setArrayFormula(java.lang.String formula, CellRangeAddress range)
Sets array formula to specified region for result.
- + void setAutobreaks(boolean b)
show automatic page breaks or not
- + HSSFAutoFilter setAutoFilter(CellRangeAddress range)
Enable filtering for a range of cells
- + void setColumnBreak(int column)
Sets a page break at the indicated column.
- + void setColumnGroupCollapsed(int columnNumber, boolean collapsed)
Expands or collapses a column group.
- + void setColumnGroupCollapsed(short columnNumber, boolean collapsed) @@ -808,14 +800,14 @@ implements + void setColumnHidden(int columnIndex, boolean hidden)
Get the visibility state for a given column.
- + void setColumnHidden(short columnIndex, boolean hidden) @@ -824,7 +816,7 @@ implements + void setColumnWidth(int columnIndex, int width) @@ -832,7 +824,7 @@ implements + void setColumnWidth(short columnIndex, short width) @@ -841,21 +833,21 @@ implements + void setDefaultColumnStyle(int column, CellStyle style)
Sets the default column style for a given column.
- + void setDefaultColumnWidth(int width)
set the default column width for the sheet (if the columns do not define their own width) in characters
- + void setDefaultColumnWidth(short width)
Deprecated.  @@ -863,160 +855,160 @@ implements + void setDefaultRowHeight(short height)
set the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point)
- + void setDefaultRowHeightInPoints(float height)
set the default row height for the sheet (if the rows do not define their own height) in points
- + void setDialog(boolean b)
set whether sheet is a dialog sheet or not
- + void setDisplayFormulas(boolean show)
Sets whether the formulas are shown in a viewer.
- + void setDisplayGridlines(boolean show)
Sets whether the gridlines are shown in a viewer.
- + void setDisplayGuts(boolean b)
set whether to display the guts or not
- + void setDisplayRowColHeadings(boolean show)
Sets whether the RowColHeadings are shown in a viewer.
- + void setDisplayZeros(boolean value)
Set whether the window should show 0 (zero) in cells containing zero value.
- + void setFitToPage(boolean b)
fit to page option is on
- + void setForceFormulaRecalculation(boolean value)
Control if Excel should be asked to recalculate all formulas on this sheet when the workbook is opened.
- + void setGridsPrinted(boolean value)
set whether gridlines printed.
- + void setHorizontallyCenter(boolean value)
determines whether the output is horizontally centered on the page.
- + void setMargin(short margin, double size)
Sets the size of the margin in inches.
- + void setPrintGridlines(boolean newPrintGridlines)
Turns on or off the printing of gridlines.
- + void setRepeatingColumns(CellRangeAddress columnRangeRef)
Sets the repeating columns used when printing the sheet, as found in File->PageSetup->Sheet.
- + void setRepeatingRows(CellRangeAddress rowRangeRef)
Sets the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.
- + void setRightToLeft(boolean value)
Sets whether the worksheet is displayed from right to left instead of from left to right.
- + void setRowBreak(int row)
Sets a page break at the indicated row Breaks occur above the specified row and left of the specified column inclusive.
- + void setRowGroupCollapsed(int rowIndex, boolean collapse)
Set view state of a groupped range of rows
- + void setRowSumsBelow(boolean b)
set if row summaries appear below detail in the outline
- + void setRowSumsRight(boolean b)
set if col summaries appear right of the detail in the outline
- + void setSelected(boolean sel)
Sets whether sheet is selected.
- + void setVerticallyCenter(boolean value)
determines whether the output is vertically centered on the page.
- + void setZoom(int numerator, int denominator)
Sets the zoom magnification for the sheet.
- + protected void shiftMerged(int startRow, int endRow, @@ -1027,7 +1019,7 @@ implements + void shiftRows(int startRow, int endRow, @@ -1035,7 +1027,7 @@ implements Shifts rows between startRow and endRow n number of rows.
- + void shiftRows(int startRow, int endRow, @@ -1045,7 +1037,7 @@ implements Shifts rows between startRow and endRow n number of rows.
- + void shiftRows(int startRow, int endRow, @@ -1056,7 +1048,7 @@ implements Shifts rows between startRow and endRow n number of rows.
- + void showInPane(int toprow, int leftcol) @@ -1064,7 +1056,7 @@ implements + void showInPane(short toprow, short leftcol) @@ -1072,14 +1064,14 @@ implements + void ungroupColumn(int fromColumn, int toColumn)
Ungroup a range of columns that were previously groupped
- + void ungroupColumn(short fromColumn, short toColumn) @@ -1088,20 +1080,20 @@ implements + void ungroupRow(int fromRow, int toRow)
Ungroup a range of rows that were previously groupped
- + protected void validateColumn(int column)
Runs a bounds check for column numbers
- + protected void validateRow(int row)
Runs a bounds check for row numbers
@@ -1650,16 +1642,6 @@ implements Parameters:
value - false if not printed.
- - - -
    -
  • -

    addMergedRegion

    -
    public int addMergedRegion(Region region)
    -
    Deprecated. (Aug-2008) use CellRangeAddress instead of Region
    -
  • -
@@ -1672,7 +1654,10 @@ implements addMergedRegion
 in interface Sheet
Parameters:
region - (rowfrom/colfrom-rowto/colto) to merge
-
Returns:
index of this region
+
Returns:
index of this region
+
Throws:
+
java.lang.IllegalStateException - if region intersects with an existing merged region + or multi-cell array formula on this sheet
Modified: poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/class-use/HSSFName.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/class-use/HSSFName.html?rev=1711857&r1=1711856&r2=1711857&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/class-use/HSSFName.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/class-use/HSSFName.html Sun Nov 1 22:50:51 2015 @@ -97,15 +97,19 @@ HSSFName +HSSFEvaluationWorkbook.createName()  + + +HSSFName HSSFWorkbook.createName()
creates a new named range and add it to the model
- + HSSFName HSSFWorkbook.getName(java.lang.String name)  - + HSSFName HSSFWorkbook.getNameAt(int nameIndex)  Modified: poi/site/publish/apidocs/org/apache/poi/hssf/util/CellRangeAddress.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hssf/util/CellRangeAddress.html?rev=1711857&r1=1711856&r2=1711857&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hssf/util/CellRangeAddress.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hssf/util/CellRangeAddress.html Sun Nov 1 22:50:51 2015 @@ -178,7 +178,7 @@ extends CellRangeAddressBase -equals, getFirstColumn, getFirstRow, getLastColumn, getLastRow, getMaxColumn, getMaxRow, getMinColumn, getMinRow, getNumberOfCells, hashCode, isFullColumnRange, isFullRowRange, isInRange, setFirstColumn, setFirstRow, setLastColumn, setLastRow, toString, validate +equals, getFirstColumn, getFirstRow, getLastColumn, getLastRow, getMaxColumn, getMaxRow, getMinColumn, getMinRow, getNumberOfCells, hashCode, intersects, isFullColumnRange, isFullRowRange, isInRange, setFirstColumn, setFirstRow, setLastColumn, setLastRow, toString, validate