Apache POI - Common 5.3.0 · org.apache.poi.hssf.usermodel.HSSFPatriarch

Modifier and Type	Field and Description
private EscherAggregate	_boundAggregate The EscherAggregate we have been bound to.
private final EscherContainerRecord	_mainSpgrContainer
private final List<HSSFShape>	_shapes
private final HSSFSheet	_sheet
private final EscherSpgrRecord	_spgrRecord

Access	Constructor and Description
pack-priv	HSSFPatriarch(HSSFSheet the sheet this patriarch is stored in. sheet, EscherAggregate -low level representation of all binary data inside sheet boundAggregate) Creates the patriarch.

Method Summary

Modifier and Type	Method and Description
public void	addShape(HSSFShape shape) Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.addShape. add a shape to this drawing
pack-priv void	afterCreate()
pack-priv void	buildShapeTree() create shape tree from existing escher records tree
public void	clear() Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.clear. remove all shapes inside patriarch
public boolean	containsChart() Does this HSSFPatriarch contain a chart?
public int	Returns: count of shapes including shapes inside shape groups countOfAllChildren() Total count of all children and their children's children.
public HSSFClientAnchor	Returns: the newly created client anchor createAnchor(int the x coordinate in EMU within the first cell. dx1, int the y coordinate in EMU within the first cell. dy1, int the x coordinate in EMU within the second cell. dx2, int the y coordinate in EMU within the second cell. dy2, int the column (0 based) of the first cell. col1, int the row (0 based) of the first cell. row1, int the column (0 based) of the second cell. col2, int the row (0 based) of the second cell. row2) Implements org.apache.poi.ss.usermodel.Drawing.createAnchor. Creates a new client anchor and sets the top-left and bottom-right coordinates of the anchor.
public HSSFComment	createCellComment(ClientAnchor the client anchor describes how this comment is attached to the sheet. anchor) Implements org.apache.poi.ss.usermodel.Drawing.createCellComment. Creates a comment.
pack-priv HSSFSimpleShape	createComboBox(HSSFAnchor anchor) YK: used to create autofilters
public HSSFComment	Returns: the newly created comment. createComment(HSSFAnchor the client anchor describes how this comment is attached to the sheet. anchor) Constructs a cell comment.
public HSSFShapeGroup	Returns: the newly created group. createGroup(HSSFClientAnchor the client anchor describes how this group is attached to the sheet. anchor) Creates a new group record stored under this patriarch.
public HSSFObjectData	createObjectData(ClientAnchor the client anchor describes how this picture is attached to the sheet. anchor, int the storageId returned by `Workbook#addOlePackage(byte[], String, String, String)` storageId, int the index of the picture (used as preview image) in the workbook collection of pictures. pictureIndex) Implements org.apache.poi.ss.usermodel.Drawing.createObjectData. Adds a new OLE Package Shape
pack-priv static HSSFPatriarch	Returns: new patriarch with copies of all shapes from the existing patriarch createPatriarch(HSSFPatriarch - copy all the shapes from this patriarch to new one patriarch, HSSFSheet where must be located new patriarch sheet) used to clone patriarch create patriarch from existing one
public HSSFPicture	Returns: the newly created shape. createPicture(HSSFClientAnchor the client anchor describes how this group is attached to the sheet. anchor, int - pointer to the byte array saved inside workbook in escher bse record pictureIndex) Creates a picture.
public HSSFPicture	Returns: newly created shape createPicture(ClientAnchor the client anchor describes how this picture is attached to the sheet. anchor, int the index of the picture in the workbook collection of pictures. pictureIndex) Implements org.apache.poi.ss.usermodel.Drawing.createPicture. Creates a picture.
public HSSFPolygon	Returns: the newly created shape. createPolygon(HSSFClientAnchor the client anchor describes how this group is attached to the sheet. anchor) Creates a polygon
public HSSFSimpleShape	Returns: the newly created shape. createSimpleShape(HSSFClientAnchor the client anchor describes how this group is attached to the sheet. anchor) Creates a simple shape.
public HSSFTextbox	Returns: the newly created textbox. createTextbox(HSSFClientAnchor the client anchor describes how this group is attached to the sheet. anchor) Constructs a textbox under the patriarch.
public EscherAggregate	Returns: - low level representation of sheet drawing data getBoundAggregate() Returns the aggregate escher record we're bound to
public List<HSSFShape>	getChildren() Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getChildren. Returns an unmodifiable list of all shapes contained by the patriarch.
protected HSSFSheet	getSheet()
public int	Returns: x coordinate of the left up corner getX1() Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getX1.
public int	Returns: x coordinate of the right down corner getX2() Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getX2.
public int	Returns: y coordinate of the left up corner getY1() Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getY1.
public int	Returns: y coordinate of the right down corner getY2() Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getY2.
public Iterator<HSSFShape>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
pack-priv int	Returns: new unique shapeId newShapeId()
private void	onCreate(HSSFShape shape)
protected void	preSerialize() check if any shapes contain wrong data At now(13.08.2010) check if patriarch contains 2 or more comments with same coordinates
public boolean	Returns: true of shape is removed removeShape(HSSFShape to be removed shape) Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.removeShape. remove first level shapes
public void	setCoordinates(int x1, int y1, int x2, int y2) Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.setCoordinates. Sets the coordinate space of this group.
private void	setFlipFlags(HSSFShape shape)
public Spliterator<HSSFShape>	spliterator() Overrides default java.lang.Iterable.spliterator. Creates a `Spliterator` over the elements described by this `Iterable`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

_boundAggregate	back to summary
private EscherAggregate _boundAggregate The EscherAggregate we have been bound to. (This will handle writing us out into records, and building up our shapes from the records)

_mainSpgrContainer	back to summary
private final EscherContainerRecord _mainSpgrContainer

_shapes	back to summary
private final List<HSSFShape> _shapes

_sheet	back to summary
private final HSSFSheet _sheet

_spgrRecord	back to summary
private final EscherSpgrRecord _spgrRecord

HSSFPatriarch	back to summary
pack-priv HSSFPatriarch(HSSFSheet sheet, EscherAggregate boundAggregate) Creates the patriarch. Parameters sheet:HSSFSheet the sheet this patriarch is stored in. boundAggregate:EscherAggregate -low level representation of all binary data inside sheet

Method Detail

addShape	back to summary
public void addShape(HSSFShape shape) Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.addShape. add a shape to this drawing Annotations @Override @Internal

addShape

back to summary

public void addShape(HSSFShape shape)

Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.addShape.

add a shape to this drawing

Annotations

@Override
@Internal

afterCreate	back to summary
pack-priv void afterCreate()

buildShapeTree	back to summary
pack-priv void buildShapeTree() create shape tree from existing escher records tree

clear	back to summary
public void clear() Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.clear. remove all shapes inside patriarch Annotations @Override

clear

back to summary

public void clear()

Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.clear.

remove all shapes inside patriarch

Annotations

@Override

containsChart	back to summary
public boolean containsChart() Does this HSSFPatriarch contain a chart? (Technically a reference to a chart, since they get stored in a different block of records) FIXME - detect chart in all cases (only seems to work on some charts so far)

countOfAllChildren	back to summary
public int countOfAllChildren() Total count of all children and their children's children. Returns:int count of shapes including shapes inside shape groups

countOfAllChildren

back to summary

public int countOfAllChildren()

Total count of all children and their children's children.

Returns:int: count of shapes including shapes inside shape groups

createAnchor	back to summary
public HSSFClientAnchor createAnchor(int dx1, int dy1, int dx2, int dy2, int col1, int row1, int col2, int row2) Implements org.apache.poi.ss.usermodel.Drawing.createAnchor. Creates a new client anchor and sets the top-left and bottom-right coordinates of the anchor. Parameters dx1:int the x coordinate in EMU within the first cell. dy1:int the y coordinate in EMU within the first cell. dx2:int the x coordinate in EMU within the second cell. dy2:int the y coordinate in EMU within the second cell. col1:int the column (0 based) of the first cell. row1:int the row (0 based) of the first cell. col2:int the column (0 based) of the second cell. row2:int the row (0 based) of the second cell. Returns:HSSFClientAnchor the newly created client anchor Annotations @Override

createAnchor

back to summary

public HSSFClientAnchor createAnchor(int dx1, int dy1, int dx2, int dy2, int col1, int row1, int col2, int row2)

Implements org.apache.poi.ss.usermodel.Drawing.createAnchor.

Creates a new client anchor and sets the top-left and bottom-right coordinates of the anchor.

Parameters

dx1:int: the x coordinate in EMU within the first cell.
dy1:int: the y coordinate in EMU within the first cell.
dx2:int: the x coordinate in EMU within the second cell.
dy2:int: the y coordinate in EMU within the second cell.
col1:int: the column (0 based) of the first cell.
row1:int: the row (0 based) of the first cell.
col2:int: the column (0 based) of the second cell.
row2:int: the row (0 based) of the second cell.

Returns:HSSFClientAnchor

the newly created client anchor

Annotations

@Override

createCellComment	back to summary
public HSSFComment createCellComment(ClientAnchor anchor) Implements org.apache.poi.ss.usermodel.Drawing.createCellComment. Doc from org.apache.poi.ss.usermodel.Drawing.createCellComment. Creates a comment. Parameters anchor:ClientAnchor the client anchor describes how this comment is attached to the sheet. Returns:HSSFComment the newly created comment. Annotations @Override

createCellComment

back to summary

public HSSFComment createCellComment(ClientAnchor anchor)

Implements org.apache.poi.ss.usermodel.Drawing.createCellComment.

Doc from org.apache.poi.ss.usermodel.Drawing.createCellComment.

Creates a comment.

Parameters

anchor:ClientAnchor: the client anchor describes how this comment is attached to the sheet.

Returns:HSSFComment

the newly created comment.

Annotations

@Override

createComboBox back to summary

createComboBox	back to summary
pack-priv HSSFSimpleShape createComboBox(HSSFAnchor anchor) YK: used to create autofilters See Also `org.apache.poi.hssf.usermodel.HSSFSheet#setAutoFilter(org.apache.poi.ss.util.CellRangeAddress)`

pack-priv HSSFSimpleShape createComboBox(HSSFAnchor anchor)

YK: used to create autofilters

See Also: org.apache.poi.hssf.usermodel.HSSFSheet#setAutoFilter(org.apache.poi.ss.util.CellRangeAddress)

createComment	back to summary
public HSSFComment createComment(HSSFAnchor anchor) Constructs a cell comment. Parameters anchor:HSSFAnchor the client anchor describes how this comment is attached to the sheet. Returns:HSSFComment the newly created comment.

createComment

back to summary

public HSSFComment createComment(HSSFAnchor anchor)

Constructs a cell comment.

Parameters

anchor:HSSFAnchor: the client anchor describes how this comment is attached to the sheet.

Returns:HSSFComment

the newly created comment.

createGroup	back to summary
public HSSFShapeGroup createGroup(HSSFClientAnchor anchor) Creates a new group record stored under this patriarch. Parameters anchor:HSSFClientAnchor the client anchor describes how this group is attached to the sheet. Returns:HSSFShapeGroup the newly created group.

createGroup

back to summary

public HSSFShapeGroup createGroup(HSSFClientAnchor anchor)

Creates a new group record stored under this patriarch.

Parameters

anchor:HSSFClientAnchor: the client anchor describes how this group is attached to the sheet.

Returns:HSSFShapeGroup

the newly created group.

createObjectData back to summary

createObjectData	back to summary
public HSSFObjectData createObjectData(ClientAnchor anchor, int storageId, int pictureIndex) Implements org.apache.poi.ss.usermodel.Drawing.createObjectData. Doc from org.apache.poi.ss.usermodel.Drawing.createObjectData. Adds a new OLE Package Shape Parameters anchor:ClientAnchor the client anchor describes how this picture is attached to the sheet. storageId:int the storageId returned by `Workbook#addOlePackage(byte[], String, String, String)` pictureIndex:int the index of the picture (used as preview image) in the workbook collection of pictures. Returns:HSSFObjectData newly created shape Annotations @Override

public HSSFObjectData createObjectData(ClientAnchor anchor, int storageId, int pictureIndex)

Implements org.apache.poi.ss.usermodel.Drawing.createObjectData.

Doc from org.apache.poi.ss.usermodel.Drawing.createObjectData.

Adds a new OLE Package Shape

Parameters

anchor:ClientAnchor: the client anchor describes how this picture is attached to the sheet.
storageId:int: the storageId returned by Workbook#addOlePackage(byte[], String, String, String)
pictureIndex:int: the index of the picture (used as preview image) in the workbook collection of pictures.

Returns:HSSFObjectData

newly created shape

Annotations

@Override

createPatriarch	back to summary
pack-priv static HSSFPatriarch createPatriarch(HSSFPatriarch patriarch, HSSFSheet sheet) used to clone patriarch create patriarch from existing one Parameters patriarch:HSSFPatriarch - copy all the shapes from this patriarch to new one sheet:HSSFSheet where must be located new patriarch Returns:HSSFPatriarch new patriarch with copies of all shapes from the existing patriarch

createPatriarch

back to summary

pack-priv static HSSFPatriarch createPatriarch(HSSFPatriarch patriarch, HSSFSheet sheet)

used to clone patriarch create patriarch from existing one

Parameters

patriarch:HSSFPatriarch: - copy all the shapes from this patriarch to new one
sheet:HSSFSheet: where must be located new patriarch

Returns:HSSFPatriarch

new patriarch with copies of all shapes from the existing patriarch

createPicture	back to summary
public HSSFPicture createPicture(HSSFClientAnchor anchor, int pictureIndex) Creates a picture. Parameters anchor:HSSFClientAnchor the client anchor describes how this group is attached to the sheet. pictureIndex:int - pointer to the byte array saved inside workbook in escher bse record Returns:HSSFPicture the newly created shape.

createPicture

back to summary

public HSSFPicture createPicture(HSSFClientAnchor anchor, int pictureIndex)

Creates a picture.

Parameters

anchor:HSSFClientAnchor: the client anchor describes how this group is attached to the sheet.
pictureIndex:int: - pointer to the byte array saved inside workbook in escher bse record

Returns:HSSFPicture

the newly created shape.

createPicture	back to summary
public HSSFPicture createPicture(ClientAnchor anchor, int pictureIndex) Implements org.apache.poi.ss.usermodel.Drawing.createPicture. Doc from org.apache.poi.ss.usermodel.Drawing.createPicture. Creates a picture. Parameters anchor:ClientAnchor the client anchor describes how this picture is attached to the sheet. pictureIndex:int the index of the picture in the workbook collection of pictures. Returns:HSSFPicture newly created shape Annotations @Override

createPicture

back to summary

public HSSFPicture createPicture(ClientAnchor anchor, int pictureIndex)

Implements org.apache.poi.ss.usermodel.Drawing.createPicture.

Doc from org.apache.poi.ss.usermodel.Drawing.createPicture.

Creates a picture.

Parameters

anchor:ClientAnchor: the client anchor describes how this picture is attached to the sheet.
pictureIndex:int: the index of the picture in the workbook collection of pictures.

Returns:HSSFPicture

newly created shape

Annotations

@Override

createPolygon	back to summary
public HSSFPolygon createPolygon(HSSFClientAnchor anchor) Creates a polygon Parameters anchor:HSSFClientAnchor the client anchor describes how this group is attached to the sheet. Returns:HSSFPolygon the newly created shape.

createPolygon

back to summary

public HSSFPolygon createPolygon(HSSFClientAnchor anchor)

Creates a polygon

Parameters

anchor:HSSFClientAnchor: the client anchor describes how this group is attached to the sheet.

Returns:HSSFPolygon

the newly created shape.

createSimpleShape	back to summary
public HSSFSimpleShape createSimpleShape(HSSFClientAnchor anchor) Creates a simple shape. This includes such shapes as lines, rectangles, and ovals. Note Microsoft Excel seems to sometimes disallow higher y1 than y2 or higher x1 than x2 in the anchor, you might need to reverse them and draw shapes vertically or horizontally flipped! Parameters anchor:HSSFClientAnchor the client anchor describes how this group is attached to the sheet. Returns:HSSFSimpleShape the newly created shape.

createSimpleShape

back to summary

public HSSFSimpleShape createSimpleShape(HSSFClientAnchor anchor)

Creates a simple shape. This includes such shapes as lines, rectangles, and ovals.

Note

Microsoft Excel seems to sometimes disallow higher y1 than y2 or higher x1 than x2 in the anchor, you might need to reverse them and draw shapes vertically or horizontally flipped!

Parameters

anchor:HSSFClientAnchor: the client anchor describes how this group is attached to the sheet.

Returns:HSSFSimpleShape

the newly created shape.

createTextbox	back to summary
public HSSFTextbox createTextbox(HSSFClientAnchor anchor) Constructs a textbox under the patriarch. Parameters anchor:HSSFClientAnchor the client anchor describes how this group is attached to the sheet. Returns:HSSFTextbox the newly created textbox.

createTextbox

back to summary

public HSSFTextbox createTextbox(HSSFClientAnchor anchor)

Constructs a textbox under the patriarch.

Parameters

anchor:HSSFClientAnchor: the client anchor describes how this group is attached to the sheet.

Returns:HSSFTextbox

the newly created textbox.

getBoundAggregate	back to summary
public EscherAggregate getBoundAggregate() Returns the aggregate escher record we're bound to Returns:EscherAggregate - low level representation of sheet drawing data Annotations @Internal

getBoundAggregate

back to summary

public EscherAggregate getBoundAggregate()

Returns the aggregate escher record we're bound to

Returns:EscherAggregate

- low level representation of sheet drawing data

Annotations

@Internal

getChildren	back to summary
public List<HSSFShape> getChildren() Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getChildren. Returns an unmodifiable list of all shapes contained by the patriarch. Returns:List<HSSFShape> Doc from org.apache.poi.hssf.usermodel.HSSFShapeContainer.getChildren. Any children contained by this shape. Annotations @Override

getChildren

back to summary

public List<HSSFShape> getChildren()

Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getChildren.

Returns an unmodifiable list of all shapes contained by the patriarch.

Returns:List<HSSFShape>

Doc from org.apache.poi.hssf.usermodel.HSSFShapeContainer.getChildren.

Any children contained by this shape.

Annotations

@Override

getSheet	back to summary
protected HSSFSheet getSheet()

getX1	back to summary
public int getX1() Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getX1. Returns:int x coordinate of the left up corner Annotations @Override

getX1

back to summary

public int getX1()

Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getX1.

Returns:int

x coordinate of the left up corner

Annotations

@Override

getX2	back to summary
public int getX2() Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getX2. Returns:int x coordinate of the right down corner Annotations @Override

getX2

back to summary

public int getX2()

Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getX2.

Returns:int

x coordinate of the right down corner

Annotations

@Override

getY1	back to summary
public int getY1() Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getY1. Returns:int y coordinate of the left up corner Annotations @Override

getY1

back to summary

public int getY1()

Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getY1.

Returns:int

y coordinate of the left up corner

Annotations

@Override

getY2	back to summary
public int getY2() Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getY2. Returns:int y coordinate of the right down corner Annotations @Override

getY2

back to summary

public int getY2()

Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.getY2.

Returns:int

y coordinate of the right down corner

Annotations

@Override

iterator back to summary

iterator	back to summary
public Iterator<HSSFShape> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Returns:Iterator<HSSFShape> an Iterator. Annotations @Override

public Iterator<HSSFShape> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<HSSFShape>

an Iterator.

Annotations

@Override

newShapeId	back to summary
pack-priv int newShapeId() Returns:int new unique shapeId

onCreate	back to summary
private void onCreate(HSSFShape shape)

preSerialize	back to summary
protected void preSerialize() check if any shapes contain wrong data At now(13.08.2010) check if patriarch contains 2 or more comments with same coordinates

removeShape	back to summary
public boolean removeShape(HSSFShape shape) Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.removeShape. Doc from org.apache.poi.hssf.usermodel.HSSFShapeContainer.removeShape. remove first level shapes Parameters shape:HSSFShape to be removed Returns:boolean true of shape is removed Annotations @Override

removeShape

back to summary

public boolean removeShape(HSSFShape shape)

Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.removeShape.

Doc from org.apache.poi.hssf.usermodel.HSSFShapeContainer.removeShape.

remove first level shapes

Parameters

shape:HSSFShape: to be removed

Returns:boolean

true of shape is removed

Annotations

@Override

setCoordinates	back to summary
public void setCoordinates(int x1, int y1, int x2, int y2) Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.setCoordinates. Sets the coordinate space of this group. All children are constrained to these coordinates. Annotations @Override

setCoordinates

back to summary

public void setCoordinates(int x1, int y1, int x2, int y2)

Implements org.apache.poi.hssf.usermodel.HSSFShapeContainer.setCoordinates.

Sets the coordinate space of this group. All children are constrained to these coordinates.

Annotations

@Override

setFlipFlags	back to summary
private void setFlipFlags(HSSFShape shape)

spliterator back to summary

spliterator	back to summary
public Spliterator<HSSFShape> spliterator() Overrides default java.lang.Iterable.spliterator. Doc from java.lang.Iterable.spliterator. Creates a `Spliterator` over the elements described by this `Iterable`. Returns:Spliterator<HSSFShape> a `Spliterator` over the elements described by this `Iterable`. Annotations @Override Since POI 5.2.0

public Spliterator<HSSFShape> spliterator()

Overrides default java.lang.Iterable.spliterator.

Doc from java.lang.Iterable.spliterator.

Creates a Spliterator over the elements described by this Iterable.

Returns:Spliterator<HSSFShape>

a Spliterator over the elements described by this Iterable.

Annotations

@Override

Since

POI 5.2.0

public final Class HSSFPatriarch

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail