Package com.independentsoft.office.odf.fields

# Class SenderState

java.lang.Object
com.independentsoft.office.odf.fields.Field
com.independentsoft.office.odf.fields.SenderState

All Implemented Interfaces:
  `IContentElement`, `IParagraphContent`

public class SenderState extends Field
Represents the state or province name of the address of a subsequent author, if applicable.

- ## Field Summary

  ### Fields inherited from class com.independentsoft.office.odf.fields.Field

  `parent`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `SenderState()`
  Initializes a new instance of the SenderState class.
  `SenderState​(String state)`
  Initializes a new instance of the SenderState class.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `SenderState`
  `clone()`
  Creates a new object that is a deep copy of the current instance.
  `List<IContentElement>`
  `getContentElements()`
  Returns all content elements.
  `IContentElement`
  `getParent()`
  Returns the parent content element.
  `String`
  `getValue()`
  Gets the sender's state.
  `boolean`
  `isFixed()`
  Specifies whether the value of a field element is fixed.
  `void`
  `setFixed​(boolean isFixed)`
  Specifies whether the value of a field element is fixed.
  `void`
  `setParent​(IContentElement parent)`
  Sets the parent content element.
  `void`
  `setValue​(String value)`
  Sets the sender's state.
  `String`
  `toString()`
  Converts the value of the current SenderState object to its equivalent string representation.

  ### Methods inherited from class java.lang.Object

  `equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Constructor Details

  - ### SenderState

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

  - ### SenderState

    public SenderState​(String state)
    Initializes a new instance of the SenderState class.
    Parameters:
      `state` - the state

- ## 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 SenderState 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 SenderState object to its equivalent string representation.
    Overrides:
      `toString` in class `Object`
    Returns:
      the string

  - ### getValue

    public String getValue()
    Gets the sender's state.
    Returns:
      the value

  - ### setValue

    public void setValue​(String value)
    Sets the sender's state.
    Parameters:
      `value` - the new value

  - ### isFixed

    public boolean isFixed()
    Specifies whether the value of a field element is fixed. The defined values are: - false: value of field element may be replaced with a new value in future edits. - true: value of field element shall be preserved in future edits.
    Returns:
      true, if is fixed

  - ### setFixed

    public void setFixed​(boolean isFixed)
    Specifies whether the value of a field element is fixed. The defined values are: - false: value of field element may be replaced with a new value in future edits. - true: value of field element shall be preserved in future edits.
    Parameters:
      `isFixed` - the new fixed