Package com.nomagic.magicreport.engine.rtf.node

Class RTFControl

java.lang.Object
com.nomagic.magicreport.engine.rtf.node.RTFControl
All Implemented Interfaces:
RTFNode, Serializable
@OpenApiAll public class RTFControl extends Object implements RTFNode
Node represent RTF control. A control is a specially formatted command that RTF uses to mark printer control codes and information that applications use to manage documents. A node name cannot be longer than 32 characters.

Note that a backslash begins each control word.

Since:
Jun 19, 2007
See Also:

  • Constructor Details

    • RTFControl

      public RTFControl()

  • Method Details

    • getName

      public String getName()
      Return a node name.
      Returns:
      the node name

    • setName

      public void setName(String name)
      Set a node name.
      Parameters:
      name - the node name to set

    • getParameter

      public String getParameter()
      Return a node parameter.
      Returns:
      the node parameter

    • setParameter

      public void setParameter(String parameter)
      Set a node parameter.
      Parameters:
      parameter - the node parameter to set

    • getParameterValue

      public int getParameterValue()
      Return a node parameter in integer value.
      Returns:
      the node parameter in integer value.
      Throws:
      NumberFormatException - if the parameter does not contain a integer.

    • toString

      public String toString()
      Returns a string representation of the node. this method returns a string equal to the value of: 
       "Node Name: " + name + ", Parameter: " + parameter;
      Overrides:
      toString in class Object
      Returns:
      a string representation of the object.