DataTable.Highlight Class
yui3/src/datatable/js/highlight.js:12
Parent Module: datatable
Available since 3.13.0
Index
Methods
Attributes
Methods
_buildColSelRegex
()
protected
Used to transform the _colNameRegex to a Regular Expression when the
column highlighting is initially turned on. If _colNameRegex is not a
string when this method is called, no action is taken.
_highlightCell
-
e
Method called to turn on or off the cell highlighting when the mouse
enters or leaves the cell. This is determined by the event phase of the
hover event. Where over will turn on the highlighting and anything else
will turn it off.
Parameters:
-
eEventFacadeEvent from the hover event
_highlightCol
-
e
Method called to turn on or off the column highlighting when the mouse
enters or leaves the column. This is determined by the event phase of the
hover event. Where over will turn on the highlighting and anything else
will turn it off.
Parameters:
-
eEventFacadeEvent from the hover event
_highlightRow
-
e
Method called to turn on or off the row highlighting when the mouse
enters or leaves the row. This is determined by the event phase of the
hover event. Where over will turn on the highlighting and anything else
will turn it off.
Parameters:
-
eEventFacadeEvent from the hover event
_setHighlightCells
-
val
Default setter method for cell highlighting. If the value is true, a
delegate is created and stored in this._highlightDelegates.cell. This
delegate will add/remove the cell highlight classname to/from the cell
when the mouse enters/leaves a cell on the tbody
Parameters:
-
valBoolean
Returns:
val
_setHighlightCols
-
val
Default setter method for column highlighting. If the value is true, a
delegate is created and stored in this._highlightDelegates.col. This
delegate will add/remove the column highlight classname to/from the
column when the mouse enters/leaves a column on the tbody
Parameters:
-
valBoolean
Returns:
val
_setHighlightRows
-
val
Default setter method for row highlighting. If the value is true, a
delegate is created and stored in this._highlightDelegates.row. This
delegate will add/remove the row highlight classname to/from the row when
the mouse enters/leaves a row on the tbody
Parameters:
-
valBoolean
Returns:
val
Properties
_colNameRegex
String
protected
A string that will be used to create Regular Expression when column
highlighting is set to true. Uses the css prefix ({prefix}) from the
DataTable object to populate.
_colSelector
String
protected
A string that is used to create a column selector when the column is has
the mouse over it. Can contain the css prefix ({prefix}) and the column
name ({col}). Further substitution will require _highlightCol to be
overwritten.
_highlightDelegates
Object
protected
This object will contain any delegates created when their feature is turned on.
highlightClassNames
Object
public
An object consisting of classnames for a row, a col and a cell to
be applied to their respective objects when the user moves the mouse over
the item and the attribute is set to true.
Attributes
highlightCells
Setting this to true will create a delegate on the DataTable adding the default classname to the cell when the mouse is over it.
Default: false