JSDoc: Class: CellClick

new CellClick()

Extends

Feature

Members

currentHoverCell :Point

the cell location where the cursor is currently

Type:

Point

Inherited From:

Feature#currentHoverCell

Default Value:

null

cursor :string

the cursor I want to be displayed

Type:

string

Inherited From:

Feature#cursor

Default Value:

null

detached :Feature

a temporary holding field for my next feature when I'm in a disconnected state

Type:

Feature

Inherited From:

Feature#detached

Default Value:

null

next :Feature

the next feature to be given a chance to handle incoming events

Type:

Feature

Inherited From:

Feature#next

Default Value:

null

Methods

attachChain()

reattach my child from the detached reference

Inherited From:

Feature#attachChain

detachChain()

disconnect my child

Inherited From:

Feature#detachChain

handleClick(grid, event)

Parameters:

Name	Type	Description
`grid`	Hypergrid
`event`	CellEvent	the event details

Overrides:

Feature#handleClick

isFirstFixedColumn(grid, event)

Parameters:

Name	Type	Description
`grid`	Hypergrid
`event`	Object	the event details

Inherited From:

Feature#isFirstFixedColumn

isFirstFixedRow(grid, event)

Parameters:

Name	Type	Description
`grid`	Hypergrid
`event`	Object	the event details

Inherited From:

Feature#isFirstFixedRow

openLink(grid, cellEvent) → {boolean|window|null|undefined}

Open the cell's URL.

The URL is found in the cell's link property, which serves two functions:

Renders as a link. When truthy causes SimpleCell cell renderer to render the cell underlined with linkColor. (See also linkOnHover and linkColorOnHover.) Therefore, setting this property to true will render as a link, although clicking on it will have no effect. This is useful if you wish to handle the click yourself by attaching a 'fin-click' listener to your hypergrid.
Fetch the URL. The value of the link property is interpreted as per link.
Decorate the URL. The cell name (i.e., the data column name) and cell value are merged into the URL wherever the respective substrings '%name' and '%value' are found. For example, if the column name is "age" and the cell value is 6 (or a function returning 25), and the link is 'http://www.abc.com?%name=%value', then the actual link (first argument given to grid.windowOpen) would be 'http://www.abc.com?age=25'.
Open the URL. The link is then opened by grid.windowOpen. If link is an array, it is "applied" to grid.windowOpen in its entirety; otherwise, grid.windowOpen is called with the link as the first argument and linkTarget as the second.
Decorate the link. On successful return from windowOpen(), the text is colored as "visited" as per the cell's linkVisitedColor property (by setting the cell's linkColor property to its linkVisitedColor property).

Parameters:

Name	Type	Description
`grid`	Hypergrid
`cellEvent`	CellEvent	Event details.

Returns:

One of:

Value	Meaning
`undefined`	no link to open
`null`	`grid.windowOpen` failed to open a window
otherwise	A `window` reference returned by a successful call to `grid.windowOpen`.

Type: boolean | window | null | undefined