FileDocCategorySizeDatePackage
TextProp.javaAPI DocApache Poi 3.0.13016Sun Mar 11 12:59:30 GMT 2007org.apache.poi.hslf.model.textproperties

TextProp

public class TextProp extends Object implements Cloneable
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

Fields Summary
protected int
sizeOfDataBlock
protected String
propName
protected int
dataValue
protected int
maskInHeader
Constructors Summary
public TextProp(int sizeOfDataBlock, int maskInHeader, String propName)
Generate the definition of a given type of text property.

		this.sizeOfDataBlock = sizeOfDataBlock;
		this.maskInHeader = maskInHeader;
		this.propName = propName;
		this.dataValue = 0;
	
Methods Summary
public java.lang.Objectclone()
Clone, eg when you want to actually make use of one of these.

		try {
			return super.clone();
		} catch(CloneNotSupportedException e) {
			throw new InternalError(e.getMessage());
		}
	
public intgetMask()
Mask in the paragraph or character "contains" header field that indicates that this text property is present.

 return maskInHeader; 
public java.lang.StringgetName()
Name of the text property

 return propName; 
public intgetSize()
Size of the data section of the text property (2 or 4 bytes)

 return sizeOfDataBlock; 
public intgetValue()
Fetch the value of the text property (meaning is specific to each different kind of text property)

 return dataValue; 
public intgetWriteMask()
Get the mask that's used at write time. Only differs from the result of getMask() for the mask based properties

 return getMask(); 
public voidsetValue(int val)
Set the value of the text property.

 dataValue = val;