org.zkoss.poi.hssf.usermodel

Class HSSFObjectData

java.lang.Object

org.zkoss.poi.hssf.usermodel.HSSFShape

org.zkoss.poi.hssf.usermodel.HSSFSimpleShape

org.zkoss.poi.hssf.usermodel.HSSFPicture

org.zkoss.poi.hssf.usermodel.HSSFObjectData

All Implemented Interfaces:

Picture

public final class HSSFObjectData
extends HSSFPicture

Represents binary object (i.e. OLE) data stored in the file. Eg. A GIF, JPEG etc...

Right now, 13, july, 2012 can not be created from scratch

Author:

Daniel Noll

Field Summary

Fields inherited from class org.zkoss.poi.hssf.usermodel.HSSFPicture

PICTURE_TYPE_DIB, PICTURE_TYPE_EMF, PICTURE_TYPE_JPEG, PICTURE_TYPE_PICT, PICTURE_TYPE_PNG, PICTURE_TYPE_WMF

Fields inherited from class org.zkoss.poi.hssf.usermodel.HSSFSimpleShape

OBJECT_TYPE_ARC, OBJECT_TYPE_COMBO_BOX, OBJECT_TYPE_COMMENT, OBJECT_TYPE_LINE, OBJECT_TYPE_MICROSOFT_OFFICE_DRAWING, OBJECT_TYPE_OVAL, OBJECT_TYPE_PICTURE, OBJECT_TYPE_RECTANGLE, WRAP_BY_POINTS, WRAP_NONE, WRAP_SQUARE

Fields inherited from class org.zkoss.poi.hssf.usermodel.HSSFShape

FILL__FILLCOLOR_DEFAULT, LINESTYLE__COLOR_DEFAULT, LINESTYLE_DASHDOTDOTSYS, LINESTYLE_DASHDOTGEL, LINESTYLE_DASHDOTSYS, LINESTYLE_DASHGEL, LINESTYLE_DASHSYS, LINESTYLE_DEFAULT, LINESTYLE_DOTGEL, LINESTYLE_DOTSYS, LINESTYLE_LONGDASHDOTDOTGEL, LINESTYLE_LONGDASHDOTGEL, LINESTYLE_LONGDASHGEL, LINESTYLE_NONE, LINESTYLE_SOLID, LINEWIDTH_DEFAULT, LINEWIDTH_ONE_PT, NO_FILL_DEFAULT, NO_FILLHITTEST_FALSE, NO_FILLHITTEST_TRUE

Constructor Summary

Constructors

Constructor and Description
HSSFObjectData(EscherContainerRecord spContainer, ObjRecord objRecord, DirectoryEntry _root)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterRemove(HSSFPatriarch patriarch) remove escher container from the patriarch.escherAggregate remove obj, textObj and note records if it's necessary in case of ShapeGroup remove all contained shapes
protected HSSFShape	cloneShape()
protected ObjRecord	createObjRecord()
protected EscherContainerRecord	createSpContainer()
protected EmbeddedObjectRefSubRecord	findObjectRecord() Finds the EmbeddedObjectRefSubRecord, or throws an Exception if there wasn't one
DirectoryEntry	getDirectory() Gets the object data.
byte[]	getObjectData() Returns the data portion, for an ObjectData that doesn't have an associated POIFS Directory Entry
java.lang.String	getOLE2ClassName() Returns the OLE2 Class Name of the object
boolean	hasDirectoryEntry() Does this ObjectData have an associated POIFS Directory Entry?

Methods inherited from class org.zkoss.poi.hssf.usermodel.HSSFPicture

getAlt, getClientAnchor, getFileName, getImageDimension, getName, getPictureData, getPictureId, getPictureIndex, getPreferredSize, getPreferredSize, resize, resize, setAlt, setClientAnchor, setFileName, setName, setPictureIndex, setShapeType

Methods inherited from class org.zkoss.poi.hssf.usermodel.HSSFSimpleShape

createTextObjRecord, getShapeType, getString, getTextObjectRecord, getWrapText, setString, setWrapText

Methods inherited from class org.zkoss.poi.hssf.usermodel.HSSFShape

countOfAllChildren, getAnchor, getEscherContainer, getFillColor, getLineStyle, getLineStyleColor, getLineWidth, getObjRecord, getOptRecord, getParent, getPatriarch, getRotationDegree, isFlipHorizontal, isFlipVertical, isNoFill, setAnchor, setFillColor, setFillColor, setFlipHorizontal, setFlipVertical, setLineStyle, setLineStyleColor, setLineStyleColor, setLineWidth, setNoFill, setParent, setPatriarch, setPropertyValue, setRotationDegree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HSSFObjectData

public HSSFObjectData(EscherContainerRecord spContainer,
              ObjRecord objRecord,
              DirectoryEntry _root)

Method Detail

getOLE2ClassName

public java.lang.String getOLE2ClassName()

Returns the OLE2 Class Name of the object

getDirectory

public DirectoryEntry getDirectory()
                            throws java.io.IOException

Gets the object data. Only call for ones that have data though. See hasDirectoryEntry()

Returns:

the object data as an OLE2 directory.

Throws:

java.io.IOException - if there was an error reading the data.

getObjectData

public byte[] getObjectData()

Returns the data portion, for an ObjectData that doesn't have an associated POIFS Directory Entry

hasDirectoryEntry

public boolean hasDirectoryEntry()

Does this ObjectData have an associated POIFS Directory Entry? (Not all do, those that don't have a data portion)

findObjectRecord

protected EmbeddedObjectRefSubRecord findObjectRecord()

Finds the EmbeddedObjectRefSubRecord, or throws an Exception if there wasn't one

createSpContainer

protected EscherContainerRecord createSpContainer()

Overrides:

createSpContainer in class HSSFPicture

createObjRecord

protected ObjRecord createObjRecord()

Overrides:

createObjRecord in class HSSFSimpleShape

afterRemove

protected void afterRemove(HSSFPatriarch patriarch)

Description copied from class: HSSFShape

remove escher container from the patriarch.escherAggregate remove obj, textObj and note records if it's necessary in case of ShapeGroup remove all contained shapes

Overrides:

afterRemove in class HSSFSimpleShape

cloneShape

protected HSSFShape cloneShape()

Overrides:

cloneShape in class HSSFPicture