GridHyperlinkCollection
Inheritance: java.lang.Object
public class GridHyperlinkCollection
Encapsulates a collection of GridHyperlink objects.
Methods
add(int firstRow, int firstColumn, int totalRows, int totalColumns, String address)
public int add(int firstRow, int firstColumn, int totalRows, int totalColumns, String address)
Adds a hyperlink to a specified cell or a range of cells.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| firstRow | int | First row of the hyperlink range. |
| firstColumn | int | First column of the hyperlink range. |
| totalRows | int | Number of rows in this hyperlink range. |
| totalColumns | int | Number of columns of this hyperlink range. |
| address | java.lang.String | Address of the hyperlink. |
Returns: int - GridHyperlink object index.
add(String cellName, int totalRows, int totalColumns, String address)
public int add(String cellName, int totalRows, int totalColumns, String address)
Adds a hyperlink to a specified cell or a range of cells.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| cellName | java.lang.String | Cell name. |
| totalRows | int | Number of rows in this hyperlink range. |
| totalColumns | int | Number of columns of this hyperlink range. |
| address | java.lang.String | Address of the hyperlink. |
Returns: int - GridHyperlink object index.
add(String cellName, String address)
public int add(String cellName, String address)
Adds a hyperlink to a specified cell .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| cellName | java.lang.String | Cell name. |
| address | java.lang.String | Address of the hyperlink. |
Returns: int - GridHyperlink object index.
add(String startCellName, String endCellName, String address, String textToDisplay, String screenTip)
public int add(String startCellName, String endCellName, String address, String textToDisplay, String screenTip)
Adds a hyperlink to a specified cell or a range of cells.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startCellName | java.lang.String | The top-left cell of the range. |
| endCellName | java.lang.String | The bottom-right cell of the range. |
| address | java.lang.String | Address of the hyperlink. |
| textToDisplay | java.lang.String | The text to be displayed for the specified hyperlink. |
| screenTip | java.lang.String | The screenTip text for the specified hyperlink. |
Returns: int - GridHyperlink object index.
clear()
public void clear()
Clears all hyperlinks.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
get(int index)
public GridHyperlink get(int index)
Gets the GridHyperlink element at the specified index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | int | The zero based index of the element. |
Returns: GridHyperlink - The element at the specified index.
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getCount()
public int getCount()
Gets the size of enumerator
Returns: int
getHyperlink(GridCell cell)
public GridHyperlink getHyperlink(GridCell cell)
Gets the cell’s Hyperlink object. If there is no Hyperlink of the cell, returns null.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| cell | GridCell | The GridCell object. |
Returns: GridHyperlink - GridHyperlink the GridHyperlink object.
getHyperlink(int row, int column)
public GridHyperlink getHyperlink(int row, int column)
Gets the cell’s Hyperlink object. If there is no Hyperlink of the cell, returns null.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| row | int | The row of the cell. |
| column | int | The column of the cell. |
Returns: GridHyperlink - GridHyperlink the GridHyperlink object.
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
remove(GridCellArea area)
public void remove(GridCellArea area)
Remove the hyperlink at the specified area.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| area | GridCellArea | The area which contains hyperlink. |
removeAt(int index)
public void removeAt(int index)
Remove the hyperlink at the specified index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | int | The zero based index of the element. |
toString()
public String toString()
Returns: java.lang.String
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 |