Package com.grapecity.documents.excel.expressions

Class Reference

java.lang.Object
com.grapecity.documents.excel.expressions.Reference
All Implemented Interfaces:
Cloneable
public final class Reference extends Object implements Cloneable
Represents a reference in formula.

  • Field Details

  • Constructor Details

    • Reference

      public Reference()

  • Method Details

    • getWorkbook

      public WorkbookReference getWorkbook()
      Gets the external workbook reference. The default value is null.

    • setWorkbook

      public void setWorkbook(WorkbookReference value)
      Sets the external workbook reference. The default value is null.

    • getWorksheetName

      public String getWorksheetName()
      Gets the name of the worksheet.

    • setWorksheetName

      public void setWorksheetName(String value)
      Sets the name of the worksheet.

    • getLastWorksheetName

      public String getLastWorksheetName()
      Gets the name of the end worksheet of the 3D reference.

    • setLastWorksheetName

      public void setLastWorksheetName(String value)
      Sets the name of the end worksheet of the 3D reference.

    • getHasRow

      public boolean getHasRow()
      Gets whether the reference has row. The default value is true.

    • setHasRow

      public void setHasRow(boolean value)
      Sets whether the reference has row. The default value is true.

    • getHasColumn

      public boolean getHasColumn()
      Gets whether the reference has column. The default value is true.

    • setHasColumn

      public void setHasColumn(boolean value)
      Sets whether the reference has column. The default value is true.

    • getRow

      public int getRow()
      Gets the 0-based row index. The default value is 0.

    • setRow

      public void setRow(int value)
      Sets the 0-based row index. The default value is 0.

    • getColumn

      public int getColumn()
      Gets the 0-based column index. The default value is 0.

    • setColumn

      public void setColumn(int value)
      Sets the 0-based column index. The default value is 0.

    • getLastRow

      public int getLastRow()
      Gets the 0-based end row index. The default value is 0.

    • setLastRow

      public void setLastRow(int value)
      Sets the 0-based end row index. The default value is 0.

    • getLastColumn

      public int getLastColumn()
      Gets the end column index. The default value is 0.

    • setLastColumn

      public void setLastColumn(int value)
      Sets the end column index. The default value is 0.

    • getIsRowRelative

      public boolean getIsRowRelative()
      Gets whether the row is relative. The default value is true.

    • setIsRowRelative

      public void setIsRowRelative(boolean value)
      Sets whether the row is relative. The default value is true.

    • getIsColumnRelative

      public boolean getIsColumnRelative()
      Gets whether the column is relative. The default value is true.

    • setIsColumnRelative

      public void setIsColumnRelative(boolean value)
      Sets whether the column is relative. The default value is true.

    • getIsLastRowRelative

      public boolean getIsLastRowRelative()
      Gets whether the last row is absolute. The default value is true.

    • setIsLastRowRelative

      public void setIsLastRowRelative(boolean value)
      Sets whether the last row is absolute. The default value is true.

    • getIsLastColumnRelative

      public boolean getIsLastColumnRelative()
      Gets whether the last column is relative. The default value is true.

    • setIsLastColumnRelative

      public void setIsLastColumnRelative(boolean value)
      Sets whether the last column is relative. The default value is true.

    • getIsRange

      public boolean getIsRange()
      Gets whether the reference is range. The default value is false.

    • setIsRange

      public void setIsRange(boolean value)
      Sets whether the reference is range. The default value is false.

    • getIsError

      public boolean getIsError()
      Gets whether the reference contains error. The default value is false.

    • setIsError

      public void setIsError(boolean value)
      Sets whether the reference contains error. The default value is false.

    • toString

      public String toString()
      Converts the reference to A1 string.
      Overrides:
      toString in class Object

    • toString

      public String toString(UnParseContext context)
      Converts the reference to string.
      Parameters:
      context - The parse options.

    • equals

      public boolean equals(Object obj)
      Equality comparison for late binding.
      Overrides:
      equals in class Object
      Parameters:
      obj - Another reference.

    • equals

      public boolean equals(Reference other)
      Equality comparison.
      Parameters:
      other - Another reference.

    • hashCode

      public int hashCode()
      This object doesn't support getting hash code, because all fields are mutable.
      Overrides:
      hashCode in class Object
      Returns:
      The hash code of the current type.

    • clone

      public Reference clone()
      Copy the reference.
      Overrides:
      clone in class Object