Package com.independentsoft.office.odf.fields

# Class DisplayRow

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

All Implemented Interfaces:
  `IContentElement`, `IParagraphContent`

public class DisplayRow extends Field
Represents a specific row from a current selection.

- ## Field Summary

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

  `parent`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `DisplayRow()`
  Initializes a new instance of the DisplayRow class.
  `DisplayRow​(InternalXMLStreamReader reader)`
  Instantiates a new display row.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `DisplayRow`
  `clone()`
  Creates a new object that is a deep copy of the current instance.
  `String`
  `getCondition()`
  Gets the condition for selecting a row.
  `List<IContentElement>`
  `getContentElements()`
  Returns all content elements.
  `String`
  `getName()`
  Gets the source database by its name.
  `IContentElement`
  `getParent()`
  Returns the parent content element.
  `int`
  `getRowNumber()`
  Gets the row number.
  `String`
  `getTableName()`
  Gets a table within a source database.
  `TableType`
  `getTableType()`
  Gets the reference made by a database table.
  `String`
  `getValue()`
  Gets the row.
  `void`
  `setCondition​(String condition)`
  Sets the condition for selecting a row.
  `void`
  `setName​(String name)`
  Sets the source database by its name.
  `void`
  `setParent​(IContentElement parent)`
  Sets the parent content element.
  `void`
  `setRowNumber​(int rowNumber)`
  Sets the row number to select when the condition is true.
  `void`
  `setTableName​(String tableName)`
  Sets a table within a source database.
  `void`
  `setTableType​(TableType tableType)`
  Sets the reference made by a database table.
  `void`
  `setValue​(String value)`
  Sets the row.
  `String`
  `toString()`
  Converts the value of the current DisplayRow object to its equivalent string representation.

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

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

- ## Constructor Details

  - ### DisplayRow

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

  - ### DisplayRow

    public DisplayRow​(InternalXMLStreamReader reader) throws XMLStreamException
    Instantiates a new display row.
    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 DisplayRow 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 DisplayRow object to its equivalent string representation.
    Overrides:
      `toString` in class `Object`
    Returns:
      the string

  - ### getName

    public String getName()
    Gets the source database by its name.
    Returns:
      the name

  - ### setName

    public void setName​(String name)
    Sets the source database by its name.
    Parameters:
      `name` - the new name

  - ### getTableName

    public String getTableName()
    Gets a table within a source database.
    Returns:
      the table name

  - ### setTableName

    public void setTableName​(String tableName)
    Sets a table within a source database.
    Parameters:
      `tableName` - the new table name

  - ### getTableType

    public TableType getTableType()
    Gets the reference made by a database table.
    Returns:
      the table type

  - ### setTableType

    public void setTableType​(TableType tableType)
    Sets the reference made by a database table.
    Parameters:
      `tableType` - the new table type

  - ### getCondition

    public String getCondition()
    Gets the condition for selecting a row. If the attribute is present, a new row will be only selected of the result of evaluating the condition is to true when interpreted as Boolean value.
    Returns:
      the condition

  - ### setCondition

    public void setCondition​(String condition)
    Sets the condition for selecting a row. If the attribute is present, a new row will be only selected of the result of evaluating the condition is to true when interpreted as Boolean value.
    Parameters:
      `condition` - the new condition

  - ### getRowNumber

    public int getRowNumber()
    Gets the row number.
    Returns:
      the row number

  - ### setRowNumber

    public void setRowNumber​(int rowNumber)
    Sets the row number to select when the condition is true.
    Parameters:
      `rowNumber` - the new row number

  - ### getValue

    public String getValue()
    Gets the row.
    Returns:
      the value

  - ### setValue

    public void setValue​(String value)
    Sets the row.
    Parameters:
      `value` - the new value