Class TextPropCollection
java.lang.Object
org.apache.poi.hslf.model.textproperties.TextPropCollection
For a given run of characters, holds the properties (which could
be paragraph properties or character properties).
Used to hold the number of characters affected, the list of active
properties, and the indent level if required.
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsConstructorDescriptionTextPropCollection(int charactersCovered, TextPropCollection.TextPropType textPropType) Create a new collection of text properties (be they paragraph or character) which will be groked via a subsequent call to buildTextPropList(). -
Method Summary
Modifier and TypeMethodDescriptionfinal voidAdd the property at the correct position.final <T extends TextProp>
TaddWithName(String name) Add the TextProp with this name to the listintbuildTextPropList(int containsField, byte[] data, int dataOffset) For an existing set of text properties, build the list of properties coded for in a given run of properties.voidcopy(TextPropCollection other) Clones the given text propertiesbooleancompares most properties apart of the covered characters lengthfinal <T extends TextProp>
TfindByName(String textPropName) Fetch the TextProp with this name, or null if it isn't presentintFetch the number of characters this styling applies toshortintFetch the TextProps that define this styling in the record orderinthashCode()final <T extends TextProp>
TremoveByName(String name) voidsetIndentLevel(short indentLevel) toString()voidupdateTextSize(int textSize) Update the size of the text that this set of properties applies tovoidWrites out to disk the header, and then all the propertiesvoidwriteOut(OutputStream o, boolean isMasterStyle) Writes out to disk the header, and then all the properties
-
Constructor Details
-
TextPropCollection
Create a new collection of text properties (be they paragraph or character) which will be groked via a subsequent call to buildTextPropList().
-
-
Method Details
-
getSpecialMask
public int getSpecialMask() -
getCharactersCovered
public int getCharactersCovered()Fetch the number of characters this styling applies to -
getTextPropList
Fetch the TextProps that define this styling in the record order -
findByName
Fetch the TextProp with this name, or null if it isn't present -
removeByName
-
getTextPropType
-
addWithName
Add the TextProp with this name to the list -
addProp
Add the property at the correct position. Replaces an existing property with the same name.- Parameters:
textProp- the property to be added
-
buildTextPropList
public int buildTextPropList(int containsField, byte[] data, int dataOffset) For an existing set of text properties, build the list of properties coded for in a given run of properties.- Returns:
- the number of bytes that were used encoding the properties list
-
copy
Clones the given text properties -
updateTextSize
public void updateTextSize(int textSize) Update the size of the text that this set of properties applies to -
writeOut
Writes out to disk the header, and then all the properties- Throws:
IOException
-
writeOut
Writes out to disk the header, and then all the properties- Throws:
IOException
-
getIndentLevel
public short getIndentLevel() -
setIndentLevel
public void setIndentLevel(short indentLevel) -
hashCode
public int hashCode() -
equals
compares most properties apart of the covered characters length -
toString
-