GridHyperlinkCollection

Inheritance: java.lang.Object

public class GridHyperlinkCollection

Encapsulates a collection of GridHyperlink objects.

Methods

MethodDescription
add(int firstRow, int firstColumn, int totalRows, int totalColumns, String address)Adds a hyperlink to a specified cell or a range of cells.
add(String cellName, int totalRows, int totalColumns, String address)Adds a hyperlink to a specified cell or a range of cells.
add(String cellName, String address)Adds a hyperlink to a specified cell .
add(String startCellName, String endCellName, String address, String textToDisplay, String screenTip)Adds a hyperlink to a specified cell or a range of cells.
clear()Clears all hyperlinks.
equals(Object arg0)
get(int index)Gets the GridHyperlink element at the specified index.
getClass()
getCount()
getHyperlink(GridCell cell)Gets the cell’s Hyperlink object.
getHyperlink(int row, int column)Gets the cell’s Hyperlink object.
hashCode()
notify()
notifyAll()
remove(GridCellArea area)Remove the hyperlink at the specified area.
removeAt(int index)Remove the hyperlink at the specified index.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

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:

ParameterTypeDescription
firstRowintFirst row of the hyperlink range.
firstColumnintFirst column of the hyperlink range.
totalRowsintNumber of rows in this hyperlink range.
totalColumnsintNumber of columns of this hyperlink range.
addressjava.lang.StringAddress 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:

ParameterTypeDescription
cellNamejava.lang.StringCell name.
totalRowsintNumber of rows in this hyperlink range.
totalColumnsintNumber of columns of this hyperlink range.
addressjava.lang.StringAddress 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:

ParameterTypeDescription
cellNamejava.lang.StringCell name.
addressjava.lang.StringAddress 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:

ParameterTypeDescription
startCellNamejava.lang.StringThe top-left cell of the range.
endCellNamejava.lang.StringThe bottom-right cell of the range.
addressjava.lang.StringAddress of the hyperlink.
textToDisplayjava.lang.StringThe text to be displayed for the specified hyperlink.
screenTipjava.lang.StringThe 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:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

get(int index)

public GridHyperlink get(int index)

Gets the GridHyperlink element at the specified index.

Parameters:

ParameterTypeDescription
indexintThe 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()

Returns: int

public GridHyperlink getHyperlink(GridCell cell)

Gets the cell’s Hyperlink object. If there is no Hyperlink of the cell, returns null.

Parameters:

ParameterTypeDescription
cellGridCellThe GridCell object.

Returns: GridHyperlink - GridHyperlink the GridHyperlink object.

public GridHyperlink getHyperlink(int row, int column)

Gets the cell’s Hyperlink object. If there is no Hyperlink of the cell, returns null.

Parameters:

ParameterTypeDescription
rowintThe row of the cell.
columnintThe 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:

ParameterTypeDescription
areaGridCellAreaThe area which contains hyperlink.

removeAt(int index)

public void removeAt(int index)

Remove the hyperlink at the specified index.

Parameters:

ParameterTypeDescription
indexintThe 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:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int