Class TextProp
java.lang.Object
org.apache.poi.hslf.model.textproperties.TextProp
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
BitMaskTextProp
,FontAlignmentProp
,HSLFTabStopPropCollection
,TextAlignmentProp
Definition of a property of some text, or its paragraph. Defines
how to find out if it's present (via the mask on the paragraph or
character "contains" header field), how long the value of it is,
and how to get and set the value.
As the exact form of these (such as mask value, size of data
block etc) is different for StyleTextProps and
TxMasterTextProps, the definitions of the standard
TextProps is stored in the different record classes
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Clone, eg when you want to actually make use of one of these.boolean
int
getMask()
Mask in the paragraph or character "contains" header field that indicates that this text property is present.getName()
Name of the text propertyint
getSize()
Size of the data section of the text property (2 or 4 bytes)int
getValue()
Fetch the value of the text property (meaning is specific to each different kind of text property)int
Get the mask that's used at write time.int
hashCode()
void
setValue
(int val) Set the value of the text property.toString()
-
Constructor Details
-
TextProp
Generate the definition of a given type of text property. -
TextProp
Clones the property
-
-
Method Details
-
getName
Name of the text property -
getSize
public int getSize()Size of the data section of the text property (2 or 4 bytes) -
getMask
public int getMask()Mask in the paragraph or character "contains" header field that indicates that this text property is present. -
getWriteMask
public int getWriteMask()Get the mask that's used at write time. Only differs from the result of getMask() for the mask based properties -
getValue
public int getValue()Fetch the value of the text property (meaning is specific to each different kind of text property) -
setValue
public void setValue(int val) Set the value of the text property. -
clone
Clone, eg when you want to actually make use of one of these. -
hashCode
public int hashCode() -
equals
-
toString
-