|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.hslf.model.textproperties.TextProp
org.apache.poi.hslf.model.textproperties.BitMaskTextProp
public abstract class BitMaskTextProp
Definition of a special kind of property of some text, or its paragraph. For these properties, a flag in the "contains" header field tells you the data property family will exist. The value of the property is itself a mask, encoding several different (but related) properties
| Field Summary | |
|---|---|
protected static POILogger |
logger
|
| Constructor Summary | |
|---|---|
protected |
BitMaskTextProp(int sizeOfDataBlock,
int maskInHeader,
java.lang.String overallName,
java.lang.String... subPropNames)
|
| Method Summary | |
|---|---|
BitMaskTextProp |
clone()
Clone, eg when you want to actually make use of one of these. |
BitMaskTextProp |
cloneAll()
|
boolean[] |
getSubPropMatches()
Fetch the list of if the sub properties match or not |
java.lang.String[] |
getSubPropNames()
Fetch the list of the names of the sub properties |
boolean |
getSubValue(int idx)
Fetch the true/false status of the subproperty with the given index |
int |
getValue()
Return the text property value. |
int |
getWriteMask()
Calculate mask from the subPropMatches. |
void |
setSubValue(boolean value,
int idx)
Set the true/false status of the subproperty with the given index |
void |
setValue(int val)
Set the value of the text property, and recompute the sub properties based on it, i.e. |
void |
setValueWithMask(int val,
int writeMask)
Convenience method to set a value with mask, without splitting it into the subvalues |
void |
setWriteMask(int writeMask)
Sets the write mask, i.e. |
| Methods inherited from class org.apache.poi.hslf.model.textproperties.TextProp |
|---|
equals, getMask, getName, getSize, hashCode, toString |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected static final POILogger logger
| Constructor Detail |
|---|
protected BitMaskTextProp(int sizeOfDataBlock,
int maskInHeader,
java.lang.String overallName,
java.lang.String... subPropNames)
| Method Detail |
|---|
public java.lang.String[] getSubPropNames()
public boolean[] getSubPropMatches()
public int getWriteMask()
getWriteMask in class TextProppublic void setWriteMask(int writeMask)
writeMask - the mask, bit values outside the property mask range will be ignoredpublic int getValue()
getValue in class TextProppublic void setValue(int val)
setSubValue(boolean, int) to explicitly set subvalues to false.
setValue in class TextProp
public void setValueWithMask(int val,
int writeMask)
val - writeMask - public boolean getSubValue(int idx)
public void setSubValue(boolean value,
int idx)
public BitMaskTextProp clone()
TextProp
clone in class TextProppublic BitMaskTextProp cloneAll()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||