|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.hslf.record.Record
org.apache.poi.hslf.record.RecordContainer
public abstract class RecordContainer
Abstract class which all container records will extend. Providers helpful methods for writing child records out to disk
| Field Summary | |
|---|---|
protected Record[] |
_children
|
| Fields inherited from class org.apache.poi.hslf.record.Record |
|---|
logger |
| Constructor Summary | |
|---|---|
RecordContainer()
|
|
| Method Summary | |
|---|---|
int |
addChildAfter(Record newChild,
Record after)
Adds the given Child Record after the supplied record |
int |
addChildBefore(Record newChild,
Record before)
Adds the given Child Record before the supplied record |
int |
appendChildRecord(Record newChild)
Add a new child record onto a record's list of children. |
Record |
findFirstOfType(long type)
Finds the first child record of the given type, or null if none of the child records are of the given type. |
Record[] |
getChildRecords()
Return any children |
static void |
handleParentAwareRecords(RecordContainer br)
Find the records that are parent-aware, and tell them who their parent is |
boolean |
isAnAtom()
We're not an atom |
void |
moveChildBefore(Record child,
Record before)
Deprecated. method is not used within POI and will be removed |
void |
moveChildrenAfter(Record firstChild,
int number,
Record after)
Deprecated. method is not used within POI and will be removed |
void |
moveChildrenBefore(Record firstChild,
int number,
Record before)
Deprecated. method is not used within POI and will be removed |
Record |
removeChild(Record ch)
Remove a child record from this record container |
void |
setChildRecord(Record[] records)
Set child records. |
void |
writeOut(byte headerA,
byte headerB,
long type,
Record[] children,
java.io.OutputStream out)
Write out our header, and our children. |
| Methods inherited from class org.apache.poi.hslf.record.Record |
|---|
buildRecordAtOffset, createRecordForType, findChildRecords, getRecordType, writeLittleEndian, writeLittleEndian, writeOut |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Record[] _children
| Constructor Detail |
|---|
public RecordContainer()
| Method Detail |
|---|
public Record[] getChildRecords()
getChildRecords in class Recordpublic boolean isAnAtom()
isAnAtom in class Recordpublic Record findFirstOfType(long type)
public Record removeChild(Record ch)
ch - the child to remove
public int appendChildRecord(Record newChild)
newChild - the child record to be added
public int addChildAfter(Record newChild,
Record after)
newChild - after -
public int addChildBefore(Record newChild,
Record before)
newChild - before -
@Removal(version="3.19")
@Deprecated
public void moveChildBefore(Record child,
Record before)
@Removal(version="3.19")
@Deprecated
public void moveChildrenBefore(Record firstChild,
int number,
Record before)
@Removal(version="3.19")
@Deprecated
public void moveChildrenAfter(Record firstChild,
int number,
Record after)
firstChild - the first child to be movednumber - the number of records to moveafter - the record after that the children are movedpublic void setChildRecord(Record[] records)
records - the new child records
public void writeOut(byte headerA,
byte headerB,
long type,
Record[] children,
java.io.OutputStream out)
throws java.io.IOException
headerA - the first byte of the headerheaderB - the second byte of the headertype - the record typechildren - our child recordsout - the stream to write to
java.io.IOExceptionpublic static void handleParentAwareRecords(RecordContainer br)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||