org.apache.poi.xssf.usermodel
Class XSSFChartSheet

java.lang.Object
  extended by org.apache.poi.POIXMLDocumentPart
      extended by org.apache.poi.xssf.usermodel.XSSFSheet
          extended by org.apache.poi.xssf.usermodel.XSSFChartSheet
All Implemented Interfaces:
java.lang.Iterable<Row>, Sheet

public class XSSFChartSheet
extends XSSFSheet

High level representation of of Sheet Parts that are of type 'chartsheet'. TODO: current verion extends XSSFSheet although both should extend AbstractSheet

Author:
Yegor Kozlov

Field Summary
protected  org.openxmlformats.schemas.spreadsheetml.x2006.main.CTChartsheet chartsheet
           
 
Fields inherited from class org.apache.poi.xssf.usermodel.XSSFSheet
sheet, worksheet
 
Fields inherited from class org.apache.poi.POIXMLDocumentPart
DEFAULT_XML_OPTIONS
 
Fields inherited from interface org.apache.poi.ss.usermodel.Sheet
BottomMargin, FooterMargin, HeaderMargin, LeftMargin, PANE_LOWER_LEFT, PANE_LOWER_RIGHT, PANE_UPPER_LEFT, PANE_UPPER_RIGHT, RightMargin, TopMargin
 
Constructor Summary
protected XSSFChartSheet(PackagePart part, PackageRelationship rel)
           
 
Method Summary
protected  void commit()
          Save the content in the underlying package part.
 org.openxmlformats.schemas.spreadsheetml.x2006.main.CTChartsheet getCTChartsheet()
          Provide access to the CTWorksheet bean holding this sheet's data
protected  void read(java.io.InputStream is)
           
 
Methods inherited from class org.apache.poi.xssf.usermodel.XSSFSheet
addMergedRegion, autoSizeColumn, autoSizeColumn, createComment, createDrawingPatriarch, createFreezePane, createFreezePane, createRow, createSplitPane, findEndOfRowOutlineGroup, getActiveCell, getAutobreaks, getCellComment, getColumnBreaks, getColumnHelper, getColumnStyle, getColumnWidth, getCommentsTable, getCTWorksheet, getDefaultColumnWidth, getDefaultRowHeight, getDefaultRowHeightInPoints, getDisplayGuts, getEvenFooter, getEvenHeader, getFirstFooter, getFirstHeader, getFirstRowNum, getFitToPage, getFooter, getHeader, getHorizontallyCenter, getHyperlink, getLastRowNum, getLeftCol, getMargin, getMergedRegion, getNumberOfComments, getNumHyperlinks, getNumMergedRegions, getOddFooter, getOddHeader, getPaneInformation, getPhysicalNumberOfRows, getPrintSetup, getProtect, getRow, getRowBreaks, getRowSumsBelow, getRowSumsRight, getScenarioProtect, getSheetName, getTopRow, getVerticallyCenter, getWorkbook, groupColumn, groupRow, hasComments, isColumnBroken, isColumnHidden, isDisplayFormulas, isDisplayGridlines, isDisplayRowColHeadings, isDisplayZeros, isPrintGridlines, isRowBroken, isSelected, iterator, onDocumentCreate, onDocumentRead, removeColumnBreak, removeMergedRegion, removeRow, removeRowBreak, rowIterator, setActiveCell, setAutobreaks, setCellComment, setCellHyperlink, setColumnBreak, setColumnGroupCollapsed, setColumnHidden, setColumnWidth, setDefaultColumnStyle, setDefaultColumnWidth, setDefaultRowHeight, setDefaultRowHeightInPoints, setDisplayFormulas, setDisplayGridlines, setDisplayGuts, setDisplayRowColHeadings, setDisplayZeros, setFitToPage, setHorizontallyCenter, setMargin, setPrintGridlines, setRowBreak, setRowGroupCollapsed, setRowSumsBelow, setRowSumsRight, setSelected, setVerticallyCenter, setZoom, setZoom, shiftRows, shiftRows, showInPane, ungroupColumn, ungroupRow, write
 
Methods inherited from class org.apache.poi.POIXMLDocumentPart
addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelations, onSave, read, removeRelation, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

chartsheet

protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTChartsheet chartsheet
Constructor Detail

XSSFChartSheet

protected XSSFChartSheet(PackagePart part,
                         PackageRelationship rel)
Method Detail

read

protected void read(java.io.InputStream is)
             throws java.io.IOException
Overrides:
read in class XSSFSheet
Throws:
java.io.IOException

getCTChartsheet

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTChartsheet getCTChartsheet()
Provide access to the CTWorksheet bean holding this sheet's data

Returns:
the CTWorksheet bean holding this sheet's data

commit

protected void commit()
               throws java.io.IOException
Description copied from class: POIXMLDocumentPart
Save the content in the underlying package part. Default implementation is empty meaning that the package part is left unmodified. Sub-classes should override and add logic to marshal the "model" into Ooxml4J. For example, the code saving a generic XML entry may look as follows:

 protected void commit() throws IOException {
   PackagePart part = getPackagePart();
   OutputStream out = part.getOutputStream();
   XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
   bean.save(out, DEFAULT_XML_OPTIONS);
   out.close();
 }
  

Overrides:
commit in class XSSFSheet
Throws:
java.io.IOException


Copyright 2009 The Apache Software Foundation or its licensors, as applicable.