org.apache.poi.xssf.streaming
Class SXSSFCreationHelper

java.lang.Object
  extended by org.apache.poi.xssf.streaming.SXSSFCreationHelper
All Implemented Interfaces:
CreationHelper

public class SXSSFCreationHelper
extends java.lang.Object
implements CreationHelper

Streaming Creation Helper, which performs some actions based on the Streaming Workbook, and some on the related regular XSSF Workbook


Constructor Summary
SXSSFCreationHelper(SXSSFWorkbook workbook)
          Should only be called by SXSSFWorkbook.getCreationHelper()
 
Method Summary
 AreaReference createAreaReference(CellReference topLeft, CellReference bottomRight)
          Creates an area ref from a pair of Cell References..
 AreaReference createAreaReference(java.lang.String reference)
          Creates an AreaReference.
 ClientAnchor createClientAnchor()
          Creates a ClientAnchor.
 DataFormat createDataFormat()
          Creates a new DataFormat instance
 ExtendedColor createExtendedColor()
          Creates a XSSF-style Color object, used for extended sheet formattings and conditional formattings
 SXSSFFormulaEvaluator createFormulaEvaluator()
          Creates FormulaEvaluator - an object that evaluates formula cells.
 Hyperlink createHyperlink(HyperlinkType type)
          Creates a new Hyperlink, of the given type
 XSSFRichTextString createRichTextString(java.lang.String text)
          Creates a new RichTextString instance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SXSSFCreationHelper

@Internal
public SXSSFCreationHelper(SXSSFWorkbook workbook)
Should only be called by SXSSFWorkbook.getCreationHelper()

Parameters:
workbook - the workbook to create objects for
Method Detail

createRichTextString

public XSSFRichTextString createRichTextString(java.lang.String text)
Description copied from interface: CreationHelper
Creates a new RichTextString instance

Specified by:
createRichTextString in interface CreationHelper
Parameters:
text - The text to initialise the RichTextString with

createFormulaEvaluator

public SXSSFFormulaEvaluator createFormulaEvaluator()
Description copied from interface: CreationHelper
Creates FormulaEvaluator - an object that evaluates formula cells.

Specified by:
createFormulaEvaluator in interface CreationHelper
Returns:
a FormulaEvaluator instance

createDataFormat

public DataFormat createDataFormat()
Description copied from interface: CreationHelper
Creates a new DataFormat instance

Specified by:
createDataFormat in interface CreationHelper

createHyperlink

public Hyperlink createHyperlink(HyperlinkType type)
Description copied from interface: CreationHelper
Creates a new Hyperlink, of the given type

Specified by:
createHyperlink in interface CreationHelper

createExtendedColor

public ExtendedColor createExtendedColor()
Description copied from interface: CreationHelper
Creates a XSSF-style Color object, used for extended sheet formattings and conditional formattings

Specified by:
createExtendedColor in interface CreationHelper

createClientAnchor

public ClientAnchor createClientAnchor()
Description copied from interface: CreationHelper
Creates a ClientAnchor. Use this object to position drawing object in a sheet

Specified by:
createClientAnchor in interface CreationHelper
Returns:
a ClientAnchor instance
See Also:
Drawing

createAreaReference

public AreaReference createAreaReference(java.lang.String reference)
Creates an AreaReference.

Specified by:
createAreaReference in interface CreationHelper
Parameters:
reference - cell reference
Returns:
an AreaReference instance

createAreaReference

public AreaReference createAreaReference(CellReference topLeft,
                                         CellReference bottomRight)
Creates an area ref from a pair of Cell References..

Specified by:
createAreaReference in interface CreationHelper
Parameters:
topLeft - cell reference
bottomRight - cell reference
Returns:
an AreaReference instance


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