Package org.apache.poi.hslf.record
Class StyleTextPropAtom
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
Fields -
Constructor Summary
ConstructorsConstructorDescriptionStyleTextPropAtom
(byte[] source, int start, int len) For the Text Style Properties (StyleTextProp) AtomStyleTextPropAtom
(int parentTextSize) A new set of text style properties for some text without any. -
Method Summary
Modifier and TypeMethodDescriptionaddCharacterTextPropCollection
(int charactersCovered) Create a new Character TextPropCollection, and add it to the listaddParagraphTextPropCollection
(int charactersCovered) Create a new Paragraph TextPropCollection, and add it to the listvoid
Clear styles, so new collections can be addedint
Returns how many characters the character's TextPropCollections cover.int
Returns how many characters the paragraph's TextPropCollections cover.long
We are of type 4001void
Updates the link list of TextPropCollections which make up the character stylingsvoid
Updates the link list of TextPropCollections which make up the paragraph stylingsvoid
setParentTextSize
(int size) Tell us how much text the parent TextCharsAtom or TextBytesAtom contains, so we can go ahead and initialise ourselves.toString()
Dump the record content intoStringBuffer
void
writeOut
(OutputStream out) Write the contents of the record back, so it can be written to diskMethods 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
-
Field Details
-
_type
public static final long _type
-
-
Constructor Details
-
StyleTextPropAtom
public StyleTextPropAtom(byte[] source, int start, int len) For the Text Style Properties (StyleTextProp) Atom -
StyleTextPropAtom
public StyleTextPropAtom(int parentTextSize) A new set of text style properties for some text without any.
-
-
Method Details
-
getParagraphStyles
-
setParagraphStyles
Updates the link list of TextPropCollections which make up the paragraph stylings -
getCharacterStyles
-
setCharacterStyles
Updates the link list of TextPropCollections which make up the character stylings -
getParagraphTextLengthCovered
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) -
getCharacterTextLengthCovered
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) -
getRecordType
public long getRecordType()We are of type 4001- Specified by:
getRecordType
in classRecord
-
writeOut
Write the contents of the record back, so it can be written to disk- Specified by:
writeOut
in classRecord
- Throws:
IOException
-
setParentTextSize
public void setParentTextSize(int size) Tell us how much text the parent TextCharsAtom or TextBytesAtom contains, so we can go ahead and initialise ourselves. -
clearStyles
public void clearStyles()Clear styles, so new collections can be added -
addParagraphTextPropCollection
Create a new Paragraph TextPropCollection, and add it to the list- Parameters:
charactersCovered
- The number of characters this TextPropCollection will cover- Returns:
- the new TextPropCollection, which will then be in the list
-
addCharacterTextPropCollection
Create a new Character TextPropCollection, and add it to the list- Parameters:
charactersCovered
- The number of characters this TextPropCollection will cover- Returns:
- the new TextPropCollection, which will then be in the list
-
toString
Dump the record content intoStringBuffer
-