Package org.apache.poi.hslf.record
Class ExEmbedAtom
java.lang.Object
org.apache.poi.hslf.record.Record
org.apache.poi.hslf.record.RecordAtom
org.apache.poi.hslf.record.ExEmbedAtom
The atom that holds metadata on a specific embedded object in the document.
- Author:
- Daniel Noll
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Embedded document does not follow the color scheme.static final int
Embedded document follows the entire color scheme.static final int
Embedded document follows the text and background scheme. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructs a brand new embedded object atom record.protected
ExEmbedAtom
(byte[] source, int start, int len) Constructs the embedded object atom record from its source data. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Gets whether the embedded server cannot be locked.int
Gets whether the object follows the color scheme.boolean
Getswhether the object is a Word table.boolean
Gets whether it is not required to send the dimensions to the embedded object.long
Gets the record type.void
setCantLockServerB
(boolean cantBeLocked) void
writeOut
(OutputStream out) Write the contents of the record back, so it can be written to diskMethods inherited from class org.apache.poi.hslf.record.RecordAtom
getChildRecords, isAnAtom
Methods inherited from class org.apache.poi.hslf.record.Record
buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian
-
Field Details
-
DOES_NOT_FOLLOW_COLOR_SCHEME
public static final int DOES_NOT_FOLLOW_COLOR_SCHEMEEmbedded document does not follow the color scheme.- See Also:
-
FOLLOWS_ENTIRE_COLOR_SCHEME
public static final int FOLLOWS_ENTIRE_COLOR_SCHEMEEmbedded document follows the entire color scheme.- See Also:
-
FOLLOWS_TEXT_AND_BACKGROUND_SCHEME
public static final int FOLLOWS_TEXT_AND_BACKGROUND_SCHEMEEmbedded document follows the text and background scheme.- See Also:
-
-
Constructor Details
-
ExEmbedAtom
protected ExEmbedAtom()Constructs a brand new embedded object atom record. -
ExEmbedAtom
protected ExEmbedAtom(byte[] source, int start, int len) Constructs the embedded object 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
-
getFollowColorScheme
public int getFollowColorScheme()Gets whether the object follows the color scheme.- Returns:
- one of
DOES_NOT_FOLLOW_COLOR_SCHEME
,FOLLOWS_ENTIRE_COLOR_SCHEME
, orFOLLOWS_TEXT_AND_BACKGROUND_SCHEME
.
-
getCantLockServerB
public boolean getCantLockServerB()Gets whether the embedded server cannot be locked.- Returns:
true
if the embedded server cannot be locked.
-
setCantLockServerB
public void setCantLockServerB(boolean cantBeLocked) -
getNoSizeToServerB
public boolean getNoSizeToServerB()Gets whether it is not required to send the dimensions to the embedded object.- Returns:
true
if the embedded server does not require the object dimensions.
-
getIsTable
public boolean getIsTable()Getswhether the object is a Word table.- Returns:
true
if the object is a Word table.
-
getRecordType
public long getRecordType()Gets the record type.- Specified by:
getRecordType
in classRecord
- Returns:
- the record type.
-
writeOut
Write the contents of the record back, so it can be written to disk- Specified by:
writeOut
in classRecord
- Parameters:
out
- the output stream to write to.- Throws:
IOException
- if an error occurs.
-