|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.hslf.record.Record org.apache.poi.hslf.record.RecordAtom org.apache.poi.hslf.record.AnimationInfoAtom
public final class AnimationInfoAtom
An atom record that specifies the animation information for a shape.
Field Summary | |
---|---|
static int |
AnimateBg
whether the background of the shape is animated |
static int |
Automatic
whether the animation starts automatically |
static int |
Hide
whether the shape is hidden while the animation is not playing |
static int |
Play
whether an associated sound, media or action verb is activated when the shape is clicked. |
static int |
Reverse
whether the animation plays in the reverse direction |
static int |
Sound
whether the animation has an associated sound |
static int |
StopSound
whether all playing sounds are stopped when this animation begins |
static int |
Synchronous
specifies that the animation, while playing, stops other slide show actions. |
Fields inherited from class org.apache.poi.hslf.record.Record |
---|
logger |
Constructor Summary | |
---|---|
protected |
AnimationInfoAtom()
Constructs a brand new link related atom record. |
protected |
AnimationInfoAtom(byte[] source,
int start,
int len)
Constructs the link related atom record from its source data. |
Method Summary | |
---|---|
int |
getDelayTime()
A signed integer that specifies the delay time, in milliseconds, before the animation starts to play. |
int |
getDimColor()
A rgb structure that specifies a color for the dim effect after the animation is complete. |
boolean |
getFlag(int bit)
|
int |
getMask()
A bit mask specifying options for displaying headers and footers |
int |
getOrderID()
A signed integer that specifies the order of the animation in the slide. |
long |
getRecordType()
Gets the record type. |
int |
getSlideCount()
An unsigned integer that specifies the number of slides that this animation continues playing. |
int |
getSoundIdRef()
A 4-byte unsigned integer that specifies a reference to a sound in the SoundCollectionContainer record to locate the embedded audio |
void |
setDelayTime(int id)
A signed integer that specifies the delay time, in milliseconds, before the animation starts to play. |
void |
setDimColor(int rgb)
A rgb structure that specifies a color for the dim effect after the animation is complete. |
void |
setFlag(int bit,
boolean value)
|
void |
setMask(int mask)
A bit mask specifying options for displaying video |
void |
setOrderID(int id)
A signed integer that specifies the order of the animation in the slide. |
void |
setSlideCount(int id)
An unsigned integer that specifies the number of slides that this animation continues playing. |
void |
setSoundIdRef(int id)
A 4-byte unsigned integer that specifies a reference to a sound in the SoundCollectionContainer record to locate the embedded audio |
java.lang.String |
toString()
|
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, wait, wait, wait |
Field Detail |
---|
public static final int Reverse
public static final int Automatic
public static final int Sound
public static final int StopSound
public static final int Play
public static final int Synchronous
public static final int Hide
public static final int AnimateBg
Constructor Detail |
---|
protected AnimationInfoAtom()
protected AnimationInfoAtom(byte[] source, int start, int len)
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 Detail |
---|
public long getRecordType()
getRecordType
in class Record
public void writeOut(java.io.OutputStream out) throws java.io.IOException
writeOut
in class Record
out
- the output stream to write to.
java.io.IOException
- if an error occurs.public int getDimColor()
public void setDimColor(int rgb)
rgb
- color for the dim effect after the animation is completepublic int getMask()
public void setMask(int mask)
mask
- A bit mask specifying options for displaying videopublic boolean getFlag(int bit)
bit
- the bit to check
public void setFlag(int bit, boolean value)
bit
- the bit to setvalue
- whether the specified bit is setpublic int getSoundIdRef()
public void setSoundIdRef(int id)
id
- reference to a soundpublic int getDelayTime()
Automatic
is 0x1, this value MUST be greater than or equal to 0; otherwise, this field MUST be ignored.
public void setDelayTime(int id)
Automatic
is 0x1, this value MUST be greater than or equal to 0; otherwise, this field MUST be ignored.
public int getOrderID()
public void setOrderID(int id)
public int getSlideCount()
public void setSlideCount(int id)
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |