Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hslf » record » [javadoc | source]
org.apache.poi.hslf.record
abstract public class: Record [javadoc | source]
java.lang.Object
   org.apache.poi.hslf.record.Record

Direct Known Subclasses:
    AnimationInfo, SoundData, SlidePersistAtom, Sound, ColorSchemeAtom, Slide, TextCharsAtom, OutlineTextRefAtom, RoundTripHFPlaceholder12, SlideAtom, PositionDependentRecordAtom, TextRulerAtom, UnknownRecordPlaceholder, SlideListWithText, CString, ExOleObjStg, HeadersFootersAtom, EscherTextboxWrapper, TxMasterStyleAtom, OEShapeAtom, Comment2000Atom, TextBytesAtom, TextSpecInfoAtom, ExMediaAtom, DummyPositionSensitiveRecordWithChildren, ExControl, StyleTextPropAtom, SoundCollection, Comment2000, TxInteractiveInfoAtom, RecordAtom, ExControlAtom, InteractiveInfoAtom, FontEntityAtom, DummyRecordWithChildren, ExEmbedAtom, OEPlaceholderAtom, ExObjList, ExHyperlink, MainMaster, ExAviMovie, TextHeaderAtom, AnimationInfoAtom, Document, ExHyperlinkAtom, ExVideoContainer, ExEmbed, PPDrawingGroup, DocumentAtom, DocumentEncryptionAtom, ExMCIMovie, InteractiveInfo, SheetContainer, PPDrawing, ExObjListAtom, Environment, ExOleObjAtom, Notes, PersistPtrHolder, UserEditAtom, HeadersFootersContainer, FontCollection, PositionDependentRecordContainer, NotesAtom, RecordContainer

This abstract class represents a record in the PowerPoint document. Record classes should extend with RecordContainer or RecordAtom, which extend this in turn.
Field Summary
protected  POILogger logger     
Method from org.apache.poi.hslf.record.Record Summary:
buildRecordAtOffset,   createRecordForType,   findChildRecords,   getChildRecords,   getRecordType,   isAnAtom,   writeLittleEndian,   writeLittleEndian,   writeOut
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hslf.record.Record Detail:
 public static Record buildRecordAtOffset(byte[] b,
    int offset) 
    Build and return the Record at the given offset. Note - does less error checking and handling than findChildRecords
 public static Record createRecordForType(long type,
    byte[] b,
    int start,
    int len) 
    For a given type (little endian bytes 3 and 4 in record header), byte array, start position and length: will return a Record object that will handle that record Remember that while PPT stores the record lengths as 8 bytes short (not including the size of the header), this code assumes you're passing in corrected lengths
 public static Record[] findChildRecords(byte[] b,
    int start,
    int len) 
    Default method for finding child records of a container record
 abstract public Record[] getChildRecords()
    Fetch all the child records of this record If this record is an atom, will return null If this record is a non-atom, but has no children, will return an empty array
 abstract public long getRecordType()
    Returns the type (held as a little endian in bytes 3 and 4) that this class handles
 abstract public boolean isAnAtom()
    Is this record type an Atom record (only has data), or is it a non-Atom record (has other records)?
 public static  void writeLittleEndian(int i,
    OutputStream o) throws IOException 
    When writing out, write out a signed int (32bit) in Little Endian format
 public static  void writeLittleEndian(short s,
    OutputStream o) throws IOException 
    When writing out, write out a signed short (16bit) in Little Endian format
 abstract public  void writeOut(OutputStream o) throws IOException
    Have the contents printer out into an OutputStream, used when writing a file back out to disk (Normally, atom classes will keep their bytes around, but non atom classes will just request the bytes from their children, then chuck on their header and return)