Methods in org.apache.poi.ss.usermodel that return ObjectData
Modifier and Type	Method and Description
`ObjectData`	Drawing.`createObjectData(ClientAnchor anchor, + int storageId, + int pictureIndex)` + Adds a new OLE Package Shape +

Methods in org.apache.poi.ss.usermodel that return ObjectData

Modifier and Type

Method and Description

ObjectData

Drawing.

createObjectData(ClientAnchor anchor,
+                int storageId,
+                int pictureIndex)

Adds a new OLE Package Shape

Methods in org.apache.poi.xssf.streaming that return ObjectData
Modifier and Type	Method and Description
`ObjectData`	SXSSFDrawing.`createObjectData(ClientAnchor anchor, + int storageId, + int pictureIndex)`

Methods in org.apache.poi.xssf.streaming that return ObjectData

Modifier and Type

Method and Description

ObjectData

SXSSFDrawing.

createObjectData(ClientAnchor anchor,
+                int storageId,
+                int pictureIndex)

Returns an object that handles instantiating concrete @@ -369,36 +378,36 @@ implements + 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

- + boolean getForceFormulaRecalculation()

Whether Excel will be asked to recalculate all formulas when the workbook is opened.

- + 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)

Deprecated. @@ -406,7 +415,7 @@ implements + int getNameIndex(java.lang.String name)

Deprecated. @@ -415,130 +424,130 @@ implements + java.util.List<? extends Name> getNames(java.lang.String name)

Returns all defined names with the given name.

- + 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

- + 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.

- + int getRandomAccessWindowSize()

See the constructors for a more detailed description of the sliding window of rows.

- + protected SharedStringsTable getSharedStringSource() - + SXSSFSheet getSheet(java.lang.String name)

Get sheet with the given name

- + SXSSFSheet 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

- + SpreadsheetVersion getSpreadsheetVersion()

Returns the spreadsheet version (EXCLE2007) of this workbook

- + XSSFWorkbook getXSSFWorkbook() - + protected void

injectData(ZipEntrySource zipEntrySource,
           java.io.OutputStream out)

- + boolean isCompressTempFiles()

Get whether temp files should be compressed.

- + protected boolean isDate1904() - + boolean isHidden() - + boolean isSheetHidden(int sheetIx)

Check whether a sheet is hidden.

- + boolean isSheetVeryHidden(int sheetIx)

Check whether a sheet is very hidden.

- + java.util.Iterator<Sheet> iterator()

Alias for sheetIterator() to allow foreach loops

- + int

linkExternalWorkbook(java.lang.String name,
                     Workbook workbook)

@@ -548,7 +557,7 @@ implements + void removeName(int index)

Deprecated. @@ -556,13 +565,13 @@ implements + void removeName(Name name)

Remove the given defined name

- + void removeName(java.lang.String name)

Deprecated. @@ -570,54 +579,54 @@ implements + 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 setCompressTempFiles(boolean compress)

Set whether temp files should be compressed.

- + void setFirstVisibleTab(int sheetIndex)

Sets the first tab that is displayed in the list of tabs in excel.

- + void setForceFormulaRecalculation(boolean value)

Whether the application shall perform a full recalculation when the workbook is opened.

- + 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,
@@ -627,20 +636,20 @@ implements For the Convenience of Java Programmers maintaining pointers.


 
 
-
+
 void
 setPrintArea(int sheetIndex,
             java.lang.String reference)
 Sets the printarea for the sheet provided
 
 
-
+
 void
 setSelectedTab(int index)
 Sets the tab whose data is actually seen when the sheet is opened.
 
 
-
+
 void
 setSheetHidden(int sheetIx,
               boolean hidden)
@@ -650,38 +659,38 @@ implements 
+
 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.
 
 
-
+
 java.util.Iterator<Sheet>
 sheetIterator()
 Returns an iterator of the sheets in the workbook
   in sheet order.
 
 
-
+
 void
 write(java.io.OutputStream stream)
-Write out this workbook to an Outputstream.
+Write out this workbook to an OutputStream.
 
 
 
@@ -1297,14 +1306,16 @@ public 
 
 findFont
-public Font findFont(short boldWeight,
-            short color,
-            short fontHeight,
-            java.lang.String name,
-            boolean italic,
-            boolean strikeout,
-            short typeOffset,
-            byte underline)
+@Deprecated
+@Removal(version="3.17")
+public Font findFont(short boldWeight,
+                                      short color,
+                                      short fontHeight,
+                                      java.lang.String name,
+                                      boolean italic,
+                                      boolean strikeout,
+                                      short typeOffset,
+                                      byte underline)
 Deprecated. POI 3.15 beta 2. Use findFont(boolean, short, short, String, boolean, boolean, short, byte) instead.
 Finds a font that matches the one with the supplied attributes
 
@@ -1439,7 +1450,7 @@ public Write out this workbook to an Outputstream.


+Write out this workbook to an OutputStream.
 
 Specified by:
 write in interface Workbook
@@ -1535,6 +1546,7 @@ public 
 getNameAt
 @Deprecated
+@Removal(version="3.18")
 public Name getNameAt(int nameIndex)
 Deprecated. 3.16. New projects should avoid accessing named ranges by index.
 
@@ -1567,6 +1579,7 @@ public 
 getNameIndex
 @Deprecated
+@Removal(version="3.18")
 public int getNameIndex(java.lang.String name)
 Deprecated. 3.16. New projects should avoid accessing named ranges by index.
  Use getName(String) instead.
@@ -1588,6 +1601,7 @@ public int getNameIndex(java.l
 
 removeName
 @Deprecated
+@Removal(version="3.18")
 public void removeName(int index)
 Deprecated. 3.16. New projects should use removeName(Name).
 Remove the defined name at the specified index
@@ -1604,6 +1618,7 @@ public void removeName(int&nbs
 

 removeName
 @Deprecated
+@Removal(version="3.18")
 public void removeName(java.lang.String name)
 Deprecated. 3.16. New projects should use removeName(Name).
 Remove a defined name by name
@@ -1988,7 +2003,7 @@ public int linkExternalWorkboo
 
 
 
-
+
 
 getSpreadsheetVersion
 public SpreadsheetVersion getSpreadsheetVersion()
@@ -2000,6 +2015,28 @@ public int linkExternalWorkboo
   3.14 beta 2
 
 
+
+
+
+
+
+addOlePackage
+public int addOlePackage(byte[] oleData,
+                java.lang.String label,
+                java.lang.String fileName,
+                java.lang.String command)
+                  throws java.io.IOException
+Description copied from interface: Workbook
+Adds an OLE package manager object with the given content to the sheet
+
+Specified by:
+addOlePackage in interface Workbook
+Parameters:
oleData - the payload
label - the label of the payload
fileName - the original filename
command - the command to open the payload
+Returns:
the index of the added ole object, i.e. the storage id
+Throws:
+java.io.IOException - if the object can't be embedded
+
+
 
 
 

Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFCell.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFCell.html?rev=1778897&r1=1778896&r2=1778897&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFCell.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFCell.html Sun Jan 15 09:41:55 2017
@@ -870,7 +870,9 @@ public void copyCellFrom(
 
 getCellType
-public int getCellType()
+@Deprecated
+@Removal(version="3.17")
+public int getCellType()
 Deprecated. 3.15. Will return a CellType enum in the future.
 Return the cell type.
  
@@ -904,7 +906,9 @@ public void copyCellFrom(
 

 getCachedFormulaResultType
-public int getCachedFormulaResultType()
+@Deprecated
+@Removal(version="3.17")
+public int getCachedFormulaResultType()
 Deprecated. 3.15. Will return a CellType enum in the future.
 Only valid for formula cells
  
@@ -1095,7 +1099,9 @@ public void copyCellFrom(
 

 setCellType
-public void setCellType(int cellType)
+@Deprecated
+@Removal(version="3.17")
+public void setCellType(int cellType)
 Deprecated. POI 3.15 beta 3. Use setCellType(CellType) instead.
 Set the cells type (numeric, formula or string)
 

Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFDrawing.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFDrawing.html?rev=1778897&r1=1778896&r2=1778897&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFDrawing.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFDrawing.html Sun Jan 15 09:41:55 2017
@@ -251,51 +251,63 @@ implements 
+XSSFObjectData
+createObjectData(ClientAnchor anchor,
+                int storageId,
+                int pictureIndex)
+Adds a new OLE Package Shape
+
+
+
 XSSFPicture
 createPicture(ClientAnchor anchor,
              int pictureIndex)
 Creates a picture.
 
 
-
+
 XSSFPicture
 createPicture(XSSFClientAnchor anchor,
              int pictureIndex)
 Creates a picture.
 
 
-
+
 XSSFSimpleShape
 createSimpleShape(XSSFClientAnchor anchor)
 Creates a simple shape.
 
 
-
+
 XSSFTextBox
 createTextbox(XSSFClientAnchor anchor)
 Constructs a textbox under the drawing.
 
 
-
+
 java.util.List<XSSFChart>
 getCharts()
 Returns all charts in this drawing.
 
 
-
+
 org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTDrawing
 getCTDrawing()
 Return the underlying CTDrawing bean, the root element of the SpreadsheetML Drawing part.
 
 
-
+
 java.util.List<XSSFShape>
 getShapes() 
 
-
+
 java.util.List<XSSFShape>
 getShapes(XSSFShapeGroup groupshape) 
 
+
+XSSFSheet
+getSheet() 
+
 
 java.util.Iterator<XSSFShape>
 iterator() 
@@ -607,6 +619,26 @@ public org.openxmlformats.schemas.d
 Returns:
the newly created comment.
 
 
+
+
+
+
+
+createObjectData
+public XSSFObjectData createObjectData(ClientAnchor anchor,
+                              int storageId,
+                              int pictureIndex)
+Description copied from interface: Drawing
+Adds a new OLE Package Shape
+
+Specified by:
+createObjectData in interface Drawing<XSSFShape>
+Parameters:
anchor - the client anchor describes how this picture is
+                     attached to the sheet.
storageId - the storageId returned by Workbook.addOlePackage(byte[], String, String, String)
pictureIndex - the index of the picture (used as preview image) in the
+                     workbook collection of pictures.
+Returns:
newly created shape
+
+
 
 
 
@@ -640,7 +672,7 @@ public org.openxmlformats.schemas.d
 
 
 
-
+
 
 iterator
 public java.util.Iterator<XSSFShape> iterator()
@@ -650,6 +682,16 @@ public org.openxmlformats.schemas.d
 
 
 
+
+
+
+
+
+getSheet
+public XSSFSheet getSheet()
+Returns:
the sheet associated with the drawing
+
+
 
 
 



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org

getNameAt

getNameIndex

removeName

removeName

getSpreadsheetVersion

addOlePackage

getCellType

getCachedFormulaResultType

setCellType

createObjectData

iterator

Uses of ObjectData in org.apache.poi.ss.usermodel

Uses of ObjectData in org.apache.poi.xssf.streaming

createObjectData

findFont

getSheet