Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hslf » record » [javadoc | source]
org.apache.poi.hslf.record
public class: StyleTextPropAtom [javadoc | source]
java.lang.Object
   org.apache.poi.hslf.record.Record
      org.apache.poi.hslf.record.RecordAtom
         org.apache.poi.hslf.record.StyleTextPropAtom
A StyleTextPropAtom (type 4001). Holds basic character properties (bold, italic, underline, font size etc) and paragraph properties (alignment, line spacing etc) for the block of text (TextBytesAtom or TextCharsAtom) that this record follows. You will find two lists within this class. 1 - Paragraph style list (paragraphStyles) 2 - Character style list (charStyles) Both are lists of TextPropCollections. These define how many characters the style applies to, and what style elements make up the style (another list, this time of TextProps). Each TextProp has a value, which somehow encapsulates a property of the style
Field Summary
public static  TextProp[] paragraphTextPropTypes    All the different kinds of paragraph properties we might handle 
public static  TextProp[] characterTextPropTypes    All the different kinds of character properties we might handle 
Fields inherited from org.apache.poi.hslf.record.Record:
logger
Constructor:
 public StyleTextPropAtom(int parentTextSize) 
 public StyleTextPropAtom(byte[] source,
    int start,
    int len) 
Method from org.apache.poi.hslf.record.StyleTextPropAtom Summary:
addCharacterTextPropCollection,   addParagraphTextPropCollection,   getCharacterStyles,   getCharacterTextLengthCovered,   getParagraphStyles,   getParagraphTextLengthCovered,   getRecordType,   setCharacterStyles,   setParagraphStyles,   setParentTextSize,   toString,   writeOut
Methods from org.apache.poi.hslf.record.RecordAtom:
getChildRecords,   isAnAtom
Methods from org.apache.poi.hslf.record.Record:
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.StyleTextPropAtom Detail:
 public TextPropCollection addCharacterTextPropCollection(int charactersCovered) 
    Create a new Character TextPropCollection, and add it to the list
 public TextPropCollection addParagraphTextPropCollection(int charactersCovered) 
    Create a new Paragraph TextPropCollection, and add it to the list
 public LinkedList getCharacterStyles() 
 public int getCharacterTextLengthCovered() 
    Returns how many characters the character's TextPropCollections cover. (May be one or two more than the underlying text does, due to having extra characters meaning something special to powerpoint)
 public LinkedList getParagraphStyles() 
 public int getParagraphTextLengthCovered() 
    Returns how many characters the paragraph's TextPropCollections cover. (May be one or two more than the underlying text does, due to having extra characters meaning something special to powerpoint)
 public long getRecordType() 
    We are of type 4001
 public  void setCharacterStyles(LinkedList cs) 
    Updates the link list of TextPropCollections which make up the character stylings
 public  void setParagraphStyles(LinkedList ps) 
    Updates the link list of TextPropCollections which make up the paragraph stylings
 public  void setParentTextSize(int size) 
    Tell us how much text the parent TextCharsAtom or TextBytesAtom contains, so we can go ahead and initialise ourselves.
 public String toString() 
    Dump the record content into StringBuffer
 public  void writeOut(OutputStream out) throws IOException 
    Write the contents of the record back, so it can be written to disk