ReferredArea
Inheritance: java.lang.Object
public class ReferredArea
Represents a referred area by the formula.
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getClass() | |
| getEndColumn() | The end column of the area. |
| getEndRow() | The end row of the area. |
| getExternalFileName() | Get the external file name if this is an external reference. |
| getSheetName() | Indicates which sheet this reference is in. |
| getStartColumn() | The start column of the area. |
| getStartRow() | The start row of the area. |
| getValue(int rowOffset, int colOffset) | Gets cell value with given offset from the top-left of this area. |
| getValue(int rowOffset, int colOffset, boolean calculateFormulas) | Gets cell value with given offset from the top-left of this area. |
| getValues() | Gets cell values in this area. |
| getValues(boolean calculateFormulas) | Gets cell values in this area. |
| hashCode() | |
| isArea() | Indicates whether this is an area. |
| isEntireColumn() | Indicates whether this area contains all rows(entire column). |
| isEntireRow() | Indicates whether this area contains all columns(entire row). |
| isExternalLink() | Indicates whether this is an external link. |
| notify() | |
| notifyAll() | |
| toString() | Returns the reference address of this area. |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getEndColumn()
public int getEndColumn()
The end column of the area.
Returns: int
getEndRow()
public int getEndRow()
The end row of the area.
Returns: int
getExternalFileName()
public String getExternalFileName()
Get the external file name if this is an external reference.
Returns: java.lang.String
getSheetName()
public String getSheetName()
Indicates which sheet this reference is in.
Returns: java.lang.String
getStartColumn()
public int getStartColumn()
The start column of the area.
Returns: int
getStartRow()
public int getStartRow()
The start row of the area.
Returns: int
getValue(int rowOffset, int colOffset)
public Object getValue(int rowOffset, int colOffset)
Gets cell value with given offset from the top-left of this area.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rowOffset | int | row offset from the start row of this area |
| colOffset | int | column offset from the start row of this area |
Returns: java.lang.Object - “#REF!” if this area is invalid; “#N/A” if given offset out of this area; Otherwise return the cell value at given position.
getValue(int rowOffset, int colOffset, boolean calculateFormulas)
public Object getValue(int rowOffset, int colOffset, boolean calculateFormulas)
Gets cell value with given offset from the top-left of this area.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rowOffset | int | row offset from the start row of this area |
| colOffset | int | column offset from the start row of this area |
| calculateFormulas | boolean | Whether calculate it recursively if the specified reference is formula |
Returns: java.lang.Object - “#REF!” if this area is invalid; “#N/A” if given offset out of this area; Otherwise return the cell value at given position.
getValues()
public Object getValues()
Gets cell values in this area.
Returns: java.lang.Object - If this area is invalid, “#REF!” will be returned; If this area is one single cell, then return the cell value object; Otherwise return one 2D array for all values in this area.
getValues(boolean calculateFormulas)
public Object getValues(boolean calculateFormulas)
Gets cell values in this area.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| calculateFormulas | boolean | In this range, if there are some formulas that have not been calculated, this flag denotes whether those formulas should be calculated recursively |
Returns: java.lang.Object - If this area is invalid, “#REF!” will be returned; If this area is one single cell, then return the cell value object; Otherwise return one 2D array for all values in this area.
hashCode()
public native int hashCode()
Returns: int
isArea()
public boolean isArea()
Indicates whether this is an area.
Remarks
If this is not an area, only StartRow and StartColumn effect.
Returns: boolean
isEntireColumn()
public boolean isEntireColumn()
Indicates whether this area contains all rows(entire column).
Returns: boolean
isEntireRow()
public boolean isEntireRow()
Indicates whether this area contains all columns(entire row).
Returns: boolean
isExternalLink()
public boolean isExternalLink()
Indicates whether this is an external link.
Returns: boolean
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
toString()
public String toString()
Returns the reference address of this area. Generally it is the address of the reference which may be used in formula, such as “Sheet1!A1:C3”.
Returns: java.lang.String - the reference address of this area.
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |