Package com.independentsoft.office.odf.fields

Class UserVariableInputField

java.lang.Object
com.independentsoft.office.odf.fields.Field
com.independentsoft.office.odf.fields.UserVariableInputField
All Implemented Interfaces:
IContentElement, IParagraphContent
public class UserVariableInputField extends Field
Represents alternative method of displaying user variables.

  • Constructor Details

    • UserVariableInputField

      public UserVariableInputField()
      Initializes a new instance of the UserVariableInputField class.

    • UserVariableInputField

      public UserVariableInputField​(InternalXMLStreamReader reader) throws XMLStreamException
      Instantiates a new user variable input field.
      Parameters:
      reader - the reader
      Throws:
      XMLStreamException - the xML stream exception

  • Method Details

    • getContentElements

      public List<IContentElement> getContentElements()
      Returns all content elements.
      Specified by:
      getContentElements in interface IContentElement
      Specified by:
      getContentElements in class Field
      Returns:
      A collection of content elements.

    • getParent

      public IContentElement getParent()
      Returns the parent content element.
      Specified by:
      getParent in interface IContentElement
      Overrides:
      getParent in class Field
      Returns:
      the parent

    • setParent

      public void setParent​(IContentElement parent)
      Sets the parent content element.
      Specified by:
      setParent in interface IContentElement
      Overrides:
      setParent in class Field
      Parameters:
      parent - the new parent

    • clone

      public UserVariableInputField clone()
      Creates a new object that is a deep copy of the current instance.
      Specified by:
      clone in interface IContentElement
      Specified by:
      clone in interface IParagraphContent
      Specified by:
      clone in class Field
      Returns:
      A new object that is a copy of this instance.

    • toString

      public String toString()
      Converts the value of the current UserVariableInputField object to its equivalent string representation.
      Overrides:
      toString in class Object
      Returns:
      the string

    • getName

      public String getName()
      Gets the name of a user defined field that shall be declared already by a preceding UserVariableDeclaration objects.
      Returns:
      the name

    • setName

      public void setName​(String name)
      Sets the name of a user defined field that shall be declared already by a preceding UserVariableDeclaration objects.
      Parameters:
      name - the new name

    • getDescription

      public String getDescription()
      Gets the message that is displayed when users are prompted for input.
      Returns:
      the description

    • setDescription

      public void setDescription​(String name)
      Sets the message that is displayed when users are prompted for input.
      Parameters:
      name - the new description

    • getStyle

      public String getStyle()
      Gets the data style to format a field value.
      Returns:
      the style

    • setStyle

      public void setStyle​(String style)
      Sets the data style to format a field value.
      Parameters:
      style - the new style

    • getValue

      public String getValue()
      Gets the user variable.
      Returns:
      the value

    • setValue

      public void setValue​(String value)
      Sets the user variable.
      Parameters:
      value - the new value