org.apache.poi.hslf.record
Class OEPlaceholderAtom

java.lang.Object
  org.apache.poi.hslf.record.Record
      org.apache.poi.hslf.record.RecordAtom
          org.apache.poi.hslf.record.OEPlaceholderAtom

public class OEPlaceholderAtom
extends RecordAtom

OEPlaceholderAtom (3011).

Atom that describes the placeholder.

Author:

Yegor Kozlov

Field Summary

static byte	Body
static byte	CenteredTitle
static byte	ClipArt
static byte	GenericTextObject
static byte	Graph
static byte	MasterBody
static byte	MasterCenteredTitle
static byte	MasterDate
static byte	MasterFooter
static byte	MasterHeader
static byte	MasterNotesBodyImage
static byte	MasterNotesSlideImage
static byte	MasterSlideNumber
static byte	MasterSubtitle
static byte	MasterTitle
static byte	MediaClip
static byte	None
static byte	NotesBody
static byte	NotesSlideImage
static byte	Object
static byte	OrganizationChart
static int	PLACEHOLDER_FULLSIZE
static int	PLACEHOLDER_HALFSIZE
static int	PLACEHOLDER_QUARTSIZE
static byte	Subtitle
static byte	Table
static byte	Title
static byte	VerticalTextBody
static byte	VerticalTextTitle

Fields inherited from class org.apache.poi.hslf.record.Record

logger

Constructor Summary

	OEPlaceholderAtom() Create a new instance of OEPlaceholderAtom
protected	OEPlaceholderAtom(byte[] source, int start, int len) Build an instance of OEPlaceholderAtom from on-disk data

Method Summary

int	getPlaceholderId() Returns the placeholder Id.
int	getPlaceholderSize() Returns the placeholder size.
int	getPlacementId() Returns the placement Id.
long	getRecordType() Returns the type (held as a little endian in bytes 3 and 4) that this class handles
void	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(java.io.OutputStream out) Write the contents of the record back, so it can be written to disk

Methods 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

Methods inherited from class java.lang.Object

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

Field Detail

PLACEHOLDER_FULLSIZE

public static final int PLACEHOLDER_FULLSIZE

See Also:

Constant Field Values

PLACEHOLDER_HALFSIZE

public static final int PLACEHOLDER_HALFSIZE

See Also:

Constant Field Values

PLACEHOLDER_QUARTSIZE

public static final int PLACEHOLDER_QUARTSIZE

See Also:

Constant Field Values

None

public static final byte None

See Also:

Constant Field Values

MasterTitle

public static final byte MasterTitle

See Also:

Constant Field Values

MasterBody

public static final byte MasterBody

See Also:

Constant Field Values

MasterCenteredTitle

public static final byte MasterCenteredTitle

See Also:

Constant Field Values

MasterNotesSlideImage

public static final byte MasterNotesSlideImage

See Also:

Constant Field Values

MasterNotesBodyImage

public static final byte MasterNotesBodyImage

See Also:

Constant Field Values

MasterDate

public static final byte MasterDate

See Also:

Constant Field Values

MasterSlideNumber

public static final byte MasterSlideNumber

See Also:

Constant Field Values

MasterFooter

public static final byte MasterFooter

See Also:

Constant Field Values

MasterHeader

public static final byte MasterHeader

See Also:

Constant Field Values

MasterSubtitle

public static final byte MasterSubtitle

See Also:

Constant Field Values

GenericTextObject

public static final byte GenericTextObject

See Also:

Constant Field Values

Title

public static final byte Title

See Also:

Constant Field Values

Body

public static final byte Body

See Also:

Constant Field Values

NotesBody

public static final byte NotesBody

See Also:

Constant Field Values

CenteredTitle

public static final byte CenteredTitle

See Also:

Constant Field Values

Subtitle

public static final byte Subtitle

See Also:

Constant Field Values

VerticalTextTitle

public static final byte VerticalTextTitle

See Also:

Constant Field Values

VerticalTextBody

public static final byte VerticalTextBody

See Also:

Constant Field Values

NotesSlideImage

public static final byte NotesSlideImage

See Also:

Constant Field Values

Object

public static final byte Object

See Also:

Constant Field Values

Graph

public static final byte Graph

See Also:

Constant Field Values

Table

public static final byte Table

See Also:

Constant Field Values

ClipArt

public static final byte ClipArt

See Also:

Constant Field Values

OrganizationChart

public static final byte OrganizationChart

See Also:

Constant Field Values

MediaClip

public static final byte MediaClip

See Also:

Constant Field Values

Constructor Detail

OEPlaceholderAtom

public OEPlaceholderAtom()

Create a new instance of OEPlaceholderAtom

OEPlaceholderAtom

protected OEPlaceholderAtom(byte[] source,
                            int start,
                            int len)

Build an instance of OEPlaceholderAtom from on-disk data

Method Detail

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 class Record

Returns:

type of this record RecordTypes.OEPlaceholderAtom.

getPlacementId

public int getPlacementId()

Returns the placement Id.

Returns:

the placement Id.

setPlacementId

public void setPlacementId(int id)

Sets the placement Id.

Parameters:

id - the placement Id.

getPlaceholderId

public int getPlaceholderId()

Returns the placeholder Id.

Returns:

the placeholder Id.

setPlaceholderId

public void setPlaceholderId(byte id)

Sets the placeholder Id.

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

public void writeOut(java.io.OutputStream out)
              throws java.io.IOException

Write the contents of the record back, so it can be written to disk

Specified by:

writeOut in class Record

Throws:

java.io.IOException