Class OEPlaceholderAtom
An atom record that specifies whether a shape is a placeholder shape.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The full size of the master body text placeholder shape.static final int
Half of the size of the master body text placeholder shape.static final int
A quarter of the size of the master body text placeholder shape. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreate a new instance ofOEPlaceholderAtom
protected
OEPlaceholderAtom
(byte[] source, int start, int len) Build an instance ofOEPlaceholderAtom
from on-disk data -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the placeholder Id.int
Returns the placeholder size.int
Returns the placement Id.long
Returns the type (held as a little endian in bytes 3 and 4) that this class handlesvoid
setPlaceholderId
(byte id) Sets the placeholder Id.void
setPlaceholderSize
(byte size) Sets the placeholder size.void
setPlacementId
(int id) Sets the placement Id.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
-
PLACEHOLDER_FULLSIZE
public static final int PLACEHOLDER_FULLSIZEThe full size of the master body text placeholder shape.- See Also:
-
PLACEHOLDER_HALFSIZE
public static final int PLACEHOLDER_HALFSIZEHalf of the size of the master body text placeholder shape.- See Also:
-
PLACEHOLDER_QUARTSIZE
public static final int PLACEHOLDER_QUARTSIZEA quarter of the size of the master body text placeholder shape.- See Also:
-
-
Constructor Details
-
OEPlaceholderAtom
public OEPlaceholderAtom()Create a new instance ofOEPlaceholderAtom
-
OEPlaceholderAtom
protected OEPlaceholderAtom(byte[] source, int start, int len) Build an instance ofOEPlaceholderAtom
from on-disk data
-
-
Method Details
-
getRecordType
public long getRecordType()Description copied from class:Record
Returns the type (held as a little endian in bytes 3 and 4) that this class handles- Specified by:
getRecordType
in classRecord
- Returns:
- type of this record
RecordTypes.OEPlaceholderAtom
.
-
getPlacementId
public int getPlacementId()Returns the placement Id.The placement Id is a number assigned to the placeholder. It goes from -1 to the number of placeholders. It SHOULD be unique among all PlacholderAtom records contained in the corresponding slide. The value 0xFFFFFFFF specifies that the corresponding shape is not a placeholder shape.
- Returns:
- the placement Id.
-
setPlacementId
public void setPlacementId(int id) Sets the placement Id.The placement Id is a number assigned to the placeholder. It goes from -1 to the number of placeholders. It SHOULD be unique among all PlacholderAtom records contained in the corresponding slide. The value 0xFFFFFFFF specifies that the corresponding shape is not a placeholder shape.
- Parameters:
id
- the placement Id.
-
getPlaceholderId
public int getPlaceholderId()Returns the placeholder Id.placeholder Id specifies the type of the placeholder shape. The value MUST be one of the static constants defined in this class
- Returns:
- the placeholder Id.
-
setPlaceholderId
public void setPlaceholderId(byte id) Sets the placeholder Id.placeholder Id specifies the type of the placeholder shape. The value MUST be one of the static constants defined in this class
- Parameters:
id
- the placeholder Id.
-
getPlaceholderSize
public int getPlaceholderSize()Returns the placeholder size. Must be one of the PLACEHOLDER_* static constants defined in this class.- Returns:
- the placeholder size.
-
setPlaceholderSize
public void setPlaceholderSize(byte size) Sets the placeholder size. Must be one of the PLACEHOLDER_* static constants defined in this class.- Parameters:
size
- the placeholder size.
-
writeOut
Write the contents of the record back, so it can be written to disk- Specified by:
writeOut
in classRecord
- Throws:
IOException
-