Package com.lowagie.text.rtf.parser.properties

Class RtfProperty

java.lang.Object
com.lowagie.text.rtf.parser.properties.RtfProperty
public class RtfProperty extends Object
RtfProperty handles document, paragraph, etc. property values
Since:
2.0.8

  • Field Details

  • Constructor Details

    • RtfProperty

      public RtfProperty()

  • Method Details

    • setToDefault

      public void setToDefault()
      Set all property objects to default values.
      Since:
      2.0.8

    • setToDefault

      public void setToDefault(String propertyGroup)
      Set individual property group to default values.
      Parameters:
      propertyGroup - String name of the property group to set to default.
      Since:
      2.0.8

    • toggleProperty

      public boolean toggleProperty(RtfCtrlWordData ctrlWordData)
      Toggle the value of the property identified by the RtfCtrlWordData.specialHandler parameter. Toggle values are assumed to be integer values per the RTF spec with a value of 0=off or 1=on.
      Parameters:
      ctrlWordData - The property name to set
      Returns:
      true for handled or false if propertyName is null or blank

    • setProperty

      public boolean setProperty(RtfCtrlWordData ctrlWordData)
      Set the value of the property identified by the parameter.
      Parameters:
      ctrlWordData - The controlword with the name to set
      Returns:
      true for handled or false if propertyName or propertyValue is null

    • setProperty

      private boolean setProperty(String propertyName, Object propertyValueNew)
      Set the value of the property identified by the parameter.
      Parameters:
      propertyName - The property name to set
      propertyValueNew - The object to set the property value to
      Returns:
      true for handled or false if propertyName or propertyValue is null

    • setProperty

      private boolean setProperty(String propertyName, int propertyValueNew)
      Set the value of the property identified by the parameter.
      Parameters:
      propertyName - The property name to set
      propertyValueNew - The object to set the property value to
      Returns:
      true for handled or false if propertyName is null

    • addToProperty

      private boolean addToProperty(String propertyName, int propertyValue)
      Add the value of the property identified by the parameter.
      Parameters:
      propertyName - The property name to set
      propertyValue - The object to set the property value to
      Returns:
      true for handled or false if propertyName is null

    • setProperty

      private boolean setProperty(String propertyName, long propertyValueNew)
      Set the value of the property identified by the parameter.
      Parameters:
      propertyName - The property name to set
      propertyValueNew - The object to set the property value to
      Returns:
      true for handled or false if propertyName is null

    • addToProperty

      private boolean addToProperty(String propertyName, long propertyValue)
      Add the value of the property identified by the parameter.
      Parameters:
      propertyName - The property name to set
      propertyValue - The object to set the property value to
      Returns:
      true for handled or false if propertyName is null

    • removeProperty

      private boolean removeProperty(String propertyName)

    • getProperty

      public Object getProperty(String propertyName)
      Get the value of the property identified by the parameter.
      Parameters:
      propertyName - String containing the property name to get
      Returns:
      Property Object requested or null if not found in map.

    • getProperties

      public HashMap<String,Object> getProperties(String propertyGroup)
      Get a group of properties.
      Parameters:
      propertyGroup - The group name to obtain.
      Returns:
      Properties object with requested values.

    • isModified

      public boolean isModified()
      Returns:
      the modified

    • setModified

      public void setModified(String propertyName, boolean modified)
      Parameters:
      propertyName - the propertyName that is modified
      modified - the modified to set

    • isModifiedCharacter

      public boolean isModifiedCharacter()
      Returns:
      the modifiedCharacter

    • setModifiedCharacter

      public void setModifiedCharacter(boolean modifiedCharacter)
      Parameters:
      modifiedCharacter - the modifiedCharacter to set

    • isModifiedParagraph

      public boolean isModifiedParagraph()
      Returns:
      the modifiedParagraph

    • setModifiedParagraph

      public void setModifiedParagraph(boolean modifiedParagraph)
      Parameters:
      modifiedParagraph - the modifiedParagraph to set

    • isModifiedSection

      public boolean isModifiedSection()
      Returns:
      the modifiedSection

    • setModifiedSection

      public void setModifiedSection(boolean modifiedSection)
      Parameters:
      modifiedSection - the modifiedSection to set

    • isModifiedDocument

      public boolean isModifiedDocument()
      Returns:
      the modifiedDocument

    • setModifiedDocument

      public void setModifiedDocument(boolean modifiedDocument)
      Parameters:
      modifiedDocument - the modifiedDocument to set

    • addRtfPropertyListener

      public void addRtfPropertyListener(RtfPropertyListener listener)
      Adds a RtfPropertyListener to the RtfProperty.
      Parameters:
      listener - the new RtfPropertyListener.

    • removeRtfPropertyListener

      public void removeRtfPropertyListener(RtfPropertyListener listener)
      Removes a RtfPropertyListener from the RtfProperty.
      Parameters:
      listener - the new RtfPropertyListener.

    • beforeChange

      public void beforeChange(String propertyName)

    • afterChange

      public void afterChange(String propertyName)