java.lang.Object
org.apache.poi.hslf.model.textproperties.TextProp
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
BitMaskTextProp, FontAlignmentProp, HSLFTabStopPropCollection, TextAlignmentProp

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
  • Constructor Summary

    Constructors
    Constructor
    Description
    TextProp(int sizeOfDataBlock, int maskInHeader, String propName)
    Generate the definition of a given type of text property.
    Clones the property
  • Method Summary

    Modifier and Type
    Method
    Description
    Clone, eg when you want to actually make use of one of these.
    boolean
     
    int
    Mask in the paragraph or character "contains" header field that indicates that this text property is present.
    Name of the text property
    int
    Size of the data section of the text property (2 or 4 bytes)
    int
    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
     
    void
    setValue(int val)
    Set the value of the text property.
     

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • TextProp

      public TextProp(int sizeOfDataBlock, int maskInHeader, String propName)
      Generate the definition of a given type of text property.
    • TextProp

      public TextProp(TextProp other)
      Clones the property
  • Method Details

    • getName

      public String 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

      public TextProp clone()
      Clone, eg when you want to actually make use of one of these.
      Overrides:
      clone in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object