Package org.apache.poi.hslf.record
Class ExOleObjAtom
java.lang.Object
org.apache.poi.hslf.record.Record
org.apache.poi.hslf.record.RecordAtom
org.apache.poi.hslf.record.ExOleObjAtom
Atom storing information for an OLE object.
- Author:
- Daniel Noll
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe object is displayed on the screen as though it were printed to a printer.static final intThe object is displayed as an icon.static final intThe object is displayed as a thumbnail image.static final intThe object) is displayed as an embedded object inside of a container,static final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intThe OLE object is an ActiveX control.static final intAn embedded OLE object; the object is serialized and saved within the file.static final intA linked OLE object; the object is saved outside of the file. -
Constructor Summary
ConstructorsModifierConstructorDescriptionConstructs a brand new link related atom record.protectedExOleObjAtom(byte[] source, int start, int len) Constructs the link related atom record from its source data. -
Method Summary
Modifier and TypeMethodDescriptionintGets whether the object can be completely seen, or if only the icon is visible.booleanGets whether the object's image is blank.intgetObjID()Gets the unique identifier for the OLE object.intGets the reference to the persistent objectintGets misc options (the last four bytes in the atom).longReturns the type (held as a little endian in bytes 3 and 4) that this class handles.intGets the type of OLE object.intgetType()Gets whether the object is embedded or linked.voidsetDrawAspect(int aspect) Sets whether the object can be completely seen, or if only the icon is visible.voidsetObjID(int id) Sets the unique identifier for the OLE object.voidsetObjStgDataRef(int ref) Sets the reference to the persistent objectvoidsetOptions(int opts) Sets misc options (the last four bytes in the atom).voidsetSubType(int type) Sets the type of OLE object.voidsetType(int type) Sets whether the object is embedded or linked.toString()voidwriteOut(OutputStream out) Have the contents printer out into an OutputStream, used when writing a file back out to disk (Normally, atom classes will keep their bytes around, but non atom classes will just request the bytes from their children, then chuck on their header and return)Methods inherited from class org.apache.poi.hslf.record.RecordAtom
getChildRecords, isAnAtomMethods inherited from class org.apache.poi.hslf.record.Record
buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian
-
Field Details
-
DRAW_ASPECT_VISIBLE
public static final int DRAW_ASPECT_VISIBLEThe object) is displayed as an embedded object inside of a container,- See Also:
-
DRAW_ASPECT_THUMBNAIL
public static final int DRAW_ASPECT_THUMBNAILThe object is displayed as a thumbnail image.- See Also:
-
DRAW_ASPECT_ICON
public static final int DRAW_ASPECT_ICONThe object is displayed as an icon.- See Also:
-
DRAW_ASPECT_DOCPRINT
public static final int DRAW_ASPECT_DOCPRINTThe object is displayed on the screen as though it were printed to a printer.- See Also:
-
TYPE_EMBEDDED
public static final int TYPE_EMBEDDEDAn embedded OLE object; the object is serialized and saved within the file.- See Also:
-
TYPE_LINKED
public static final int TYPE_LINKEDA linked OLE object; the object is saved outside of the file.- See Also:
-
TYPE_CONTROL
public static final int TYPE_CONTROLThe OLE object is an ActiveX control.- See Also:
-
SUBTYPE_DEFAULT
public static final int SUBTYPE_DEFAULT- See Also:
-
SUBTYPE_CLIPART_GALLERY
public static final int SUBTYPE_CLIPART_GALLERY- See Also:
-
SUBTYPE_WORD_TABLE
public static final int SUBTYPE_WORD_TABLE- See Also:
-
SUBTYPE_EXCEL
public static final int SUBTYPE_EXCEL- See Also:
-
SUBTYPE_GRAPH
public static final int SUBTYPE_GRAPH- See Also:
-
SUBTYPE_ORGANIZATION_CHART
public static final int SUBTYPE_ORGANIZATION_CHART- See Also:
-
SUBTYPE_EQUATION
public static final int SUBTYPE_EQUATION- See Also:
-
SUBTYPE_WORDART
public static final int SUBTYPE_WORDART- See Also:
-
SUBTYPE_SOUND
public static final int SUBTYPE_SOUND- See Also:
-
SUBTYPE_IMAGE
public static final int SUBTYPE_IMAGE- See Also:
-
SUBTYPE_POWERPOINT_PRESENTATION
public static final int SUBTYPE_POWERPOINT_PRESENTATION- See Also:
-
SUBTYPE_POWERPOINT_SLIDE
public static final int SUBTYPE_POWERPOINT_SLIDE- See Also:
-
SUBTYPE_PROJECT
public static final int SUBTYPE_PROJECT- See Also:
-
SUBTYPE_NOTEIT
public static final int SUBTYPE_NOTEIT- See Also:
-
SUBTYPE_EXCEL_CHART
public static final int SUBTYPE_EXCEL_CHART- See Also:
-
SUBTYPE_MEDIA_PLAYER
public static final int SUBTYPE_MEDIA_PLAYER- See Also:
-
-
Constructor Details
-
ExOleObjAtom
public ExOleObjAtom()Constructs a brand new link related atom record. -
ExOleObjAtom
protected ExOleObjAtom(byte[] source, int start, int len) Constructs the link related atom record from its source data.- Parameters:
source- the source data as a byte array.start- the start offset into the byte array.len- the length of the slice in the byte array.
-
-
Method Details
-
getDrawAspect
public int getDrawAspect()Gets whether the object can be completely seen, or if only the icon is visible.- Returns:
- the draw aspect, one of the
DRAW_ASPECT_*constants.
-
setDrawAspect
public void setDrawAspect(int aspect) Sets whether the object can be completely seen, or if only the icon is visible.- Parameters:
aspect- the draw aspect, one of theDRAW_ASPECT_*constants.
-
getType
public int getType()Gets whether the object is embedded or linked.- Returns:
- the type, one of the
TYPE_EMBEDDED_*constants.
-
setType
public void setType(int type) Sets whether the object is embedded or linked.- Parameters:
type- the type, one of theTYPE_EMBEDDED_*constants.
-
getObjID
public int getObjID()Gets the unique identifier for the OLE object.- Returns:
- the object ID.
-
setObjID
public void setObjID(int id) Sets the unique identifier for the OLE object.- Parameters:
id- the object ID.
-
getSubType
public int getSubType()Gets the type of OLE object.- Returns:
- the sub-type, one of the
SUBTYPE_*constants.
-
setSubType
public void setSubType(int type) Sets the type of OLE object.- Parameters:
type- the sub-type, one of theSUBTYPE_*constants.
-
getObjStgDataRef
public int getObjStgDataRef()Gets the reference to the persistent object- Returns:
- the reference to the persistent object, corresponds with an
ExOleObjStgstorage container.
-
setObjStgDataRef
public void setObjStgDataRef(int ref) Sets the reference to the persistent object- Parameters:
ref- the reference to the persistent object, corresponds with anExOleObjStgstorage container.
-
getIsBlank
public boolean getIsBlank()Gets whether the object's image is blank.- Returns:
trueif the object's image is blank.
-
getOptions
public int getOptions()Gets misc options (the last four bytes in the atom).- Returns:
trueif the object's image is blank.
-
setOptions
public void setOptions(int opts) Sets misc options (the last four bytes in the atom). -
getRecordType
public long getRecordType()Returns the type (held as a little endian in bytes 3 and 4) that this class handles.- Specified by:
getRecordTypein classRecord
-
writeOut
Have the contents printer out into an OutputStream, used when writing a file back out to disk (Normally, atom classes will keep their bytes around, but non atom classes will just request the bytes from their children, then chuck on their header and return)- Specified by:
writeOutin classRecord- Throws:
IOException
-
toString
-