Top Fields Constructors Methods
org.apache.poi.hssf.usermodel

public Class HSSFCreationHelper

extends Object
implements CreationHelper
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.usermodel.CreationHelper
Imports
org.apache.poi.common.usermodel.HyperlinkType, org.apache.poi.hssf.record.common.ExtendedColor, org.apache.poi.ss.usermodel.CreationHelper, org.apache.poi.ss.util.AreaReference, .CellReference, org.apache.poi.util.Internal

Field Summary

Modifier and TypeField and Description
private final HSSFWorkbook
workbook

Constructor Summary

AccessConstructor and Description
pack-priv
HSSFCreationHelper(HSSFWorkbook
the workbook to create objects for
wb)

Should only be called by HSSFWorkbook#getCreationHelper()

Method Summary

Modifier and TypeMethod and Description
public AreaReference
createAreaReference(String
cell reference
reference)

Implements org.apache.poi.ss.usermodel.CreationHelper.createAreaReference.

Creates an AreaReference.

public AreaReference
createAreaReference(CellReference
cell reference
topLeft, CellReference
cell reference
bottomRight)

Implements org.apache.poi.ss.usermodel.CreationHelper.createAreaReference.

Creates an area ref from a pair of Cell References..

public HSSFClientAnchor

Returns:

a HSSFClientAnchor instance
createClientAnchor()

Implements org.apache.poi.ss.usermodel.CreationHelper.createClientAnchor.

Creates a HSSFClientAnchor.

public HSSFDataFormat
createDataFormat()

Implements org.apache.poi.ss.usermodel.CreationHelper.createDataFormat.

Creates a new DataFormat instance

public HSSFExtendedColor
createExtendedColor()

Implements org.apache.poi.ss.usermodel.CreationHelper.createExtendedColor.

Creates a XSSF-style Color object, used for extended sheet formattings and conditional formattings

public HSSFFormulaEvaluator

Returns:

a HSSFFormulaEvaluator instance
createFormulaEvaluator()

Implements org.apache.poi.ss.usermodel.CreationHelper.createFormulaEvaluator.

Creates a HSSFFormulaEvaluator, the object that evaluates formula cells.

public HSSFRichTextString
createRichTextString(String
The text to initialise the RichTextString with
text)

Implements org.apache.poi.ss.usermodel.CreationHelper.createRichTextString.

Creates a new RichTextString instance

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

workbookback to summary
private final HSSFWorkbook workbook

Constructor Detail

HSSFCreationHelperback to summary
pack-priv HSSFCreationHelper(HSSFWorkbook wb)

Should only be called by HSSFWorkbook#getCreationHelper()

Parameters
wb:HSSFWorkbook

the workbook to create objects for

Annotations
@Internal
since:3.15 beta 3

Method Detail

createAreaReferenceback to summary
public AreaReference createAreaReference(String reference)

Implements org.apache.poi.ss.usermodel.CreationHelper.createAreaReference.

Doc from org.apache.poi.ss.usermodel.CreationHelper.createAreaReference.

Creates an AreaReference.

Parameters
reference:String

cell reference

Returns:AreaReference

an AreaReference instance

Annotations
@Override
createAreaReferenceback to summary
public AreaReference createAreaReference(CellReference topLeft, CellReference bottomRight)

Implements org.apache.poi.ss.usermodel.CreationHelper.createAreaReference.

Doc from org.apache.poi.ss.usermodel.CreationHelper.createAreaReference.

Creates an area ref from a pair of Cell References..

Parameters
topLeft:CellReference

cell reference

bottomRight:CellReference

cell reference

Returns:AreaReference

an AreaReference instance

Annotations
@Override
createClientAnchorback to summary
public HSSFClientAnchor createClientAnchor()

Implements org.apache.poi.ss.usermodel.CreationHelper.createClientAnchor.

Creates a HSSFClientAnchor. Use this object to position drawing object in a sheet

Returns:HSSFClientAnchor

a HSSFClientAnchor instance

Annotations
@Override
See Also
org.apache.poi.ss.usermodel.Drawing
createDataFormatback to summary
public HSSFDataFormat createDataFormat()

Implements org.apache.poi.ss.usermodel.CreationHelper.createDataFormat.

Doc from org.apache.poi.ss.usermodel.CreationHelper.createDataFormat.

Creates a new DataFormat instance

Annotations
@Override
createExtendedColorback to summary
public HSSFExtendedColor createExtendedColor()

Implements org.apache.poi.ss.usermodel.CreationHelper.createExtendedColor.

Doc from org.apache.poi.ss.usermodel.CreationHelper.createExtendedColor.

Creates a XSSF-style Color object, used for extended sheet formattings and conditional formattings

Annotations
@Override
createFormulaEvaluatorback to summary
public HSSFFormulaEvaluator createFormulaEvaluator()

Implements org.apache.poi.ss.usermodel.CreationHelper.createFormulaEvaluator.

Creates a HSSFFormulaEvaluator, the object that evaluates formula cells.

Returns:HSSFFormulaEvaluator

a HSSFFormulaEvaluator instance

Annotations
@Override
createHyperlinkback to summary
public HSSFHyperlink createHyperlink(HyperlinkType type)

Implements org.apache.poi.ss.usermodel.CreationHelper.createHyperlink.

Doc from org.apache.poi.ss.usermodel.CreationHelper.createHyperlink.

Creates a new Hyperlink, of the given type

Annotations
@Override
createRichTextStringback to summary
public HSSFRichTextString createRichTextString(String text)

Implements org.apache.poi.ss.usermodel.CreationHelper.createRichTextString.

Doc from org.apache.poi.ss.usermodel.CreationHelper.createRichTextString.

Creates a new RichTextString instance

Parameters
text:String

The text to initialise the RichTextString with

Annotations
@Override