Class: TableDomUtils

Oracle® Fusion Middleware Oracle JavaScript Extension Toolkit (JET)
12c (12.1.4)

E54107-01

QuickNav

oj. TableDomUtils

DOM Utils for ojTable

Constructor

new TableDomUtils(component)

Parameters:
Name Type Description
component Object ojTable instance
Source:

Fields

<static, constant> CSS_CLASSES

Source:

<static, constant> MARKER_STYLE_CLASSES

Source:

Methods

createAccLabelSpan(text, className) → {jQuery}

Create a span element for acc purposes
Parameters:
Name Type Description
text string span text
className string | null css class
Source:
Returns:
jQuery span DOM element
Type
jQuery

createContextMenu(handleContextMenuBeforeShow, handleContextMenuSelect) → {jQuery}

Add a default context menu to the table container if there is none. If there is a context menu set on the table options we use that one. Add listeners for context menu before show and select.
Parameters:
Name Type Description
handleContextMenuBeforeShow function(Object) function called before menu show
handleContextMenuSelect function(Object) function called for menu select
Source:
Returns:
jQuery ul DOM element
Type
jQuery

createContextMenuItem() → {jQuery}

Builds a menu for a command, takes care of submenus where appropriate
Source:
Returns:
jQuery li DOM element
Type
jQuery

createContextMenuLabel(command) → {jQuery}

Builds a context menu label by looking up command translation
Parameters:
Name Type Description
command string the string to look up translation for
Source:
Returns:
jQuery a DOM element
Type
jQuery

createContextMenuListItem(command) → {jQuery}

Builds a context menu list item from a command
Parameters:
Name Type Description
command string the string to look up command value for as well as translation
Source:
Returns:
jQuery li DOM element
Type
jQuery

createInitialTable(isTableHeaderless, isTableFooterless, handleContextMenuBeforeShow, handleContextMenuSelect) → {jQuery}

Create the initial empty table
Parameters:
Name Type Description
isTableHeaderless boolean is table headerless
isTableFooterless boolean is table footerless
handleContextMenuBeforeShow function(Object) function called before menu show
handleContextMenuSelect function(Object) function called for menu select
Source:
Returns:
jQuery table DOM element
Type
jQuery

createTableBody() → {jQuery}

Create an empty tbody element with appropriate styling
Source:
Returns:
jQuery tbody DOM element
Type
jQuery

createTableBodyCell(rowIdx, columnIdx) → {jQuery}

Create an empty td element with appropriate styling
Parameters:
Name Type Description
rowIdx number row index
columnIdx number column index
Source:
Returns:
jQuery td DOM element
Type
jQuery

createTableBodyCellAccSelect(rowIdx, tableBodyRow) → {jQuery}

Create a checkbox for accessibility row selection
Parameters:
Name Type Description
rowIdx number row index
tableBodyRow jQuery tr DOM element
Source:
Returns:
jQuery td DOM element
Type
jQuery

createTableBodyRow(rowSelectionMode) → {jQuery}

Create an empty tr element with appropriate styling
Parameters:
Name Type Description
rowSelectionMode string row selection mode
Source:
Returns:
jQuery tr DOM element
Type
jQuery

createTableContainer() → {jQuery}

Create an empty div element with appropriate styling
Source:
Returns:
jQuery div DOM element
Type
jQuery

createTableDivScroller() → {jQuery}

Create a div element for table scrolling. Used in scrolling fallback mode.
Source:
Returns:
jQuery div DOM element
Type
jQuery

createTableFooter() → {jQuery}

Create an empty tfoot with appropriate styling
Source:
Returns:
jQuery tfoot DOM element
Type
jQuery

createTableFooterAccSelect(tableFooterRow) → {jQuery}

Create a checkbox for accessibility row selection
Parameters:
Name Type Description
tableFooterRow jQuery tr DOM element
Source:
Returns:
jQuery td DOM element
Type
jQuery

createTableFooterCell(columnIdx) → {jQuery}

Create an empty td element with appropriate styling
Parameters:
Name Type Description
columnIdx number column index
Source:
Returns:
jQuery td DOM element
Type
jQuery

createTableHeader() → {jQuery}

Create an empty thead & tr element with appropriate styling
Source:
Returns:
jQuery thead DOM element
Type
jQuery

createTableHeaderAccSelectRowColumn() → {jQuery}

Create a th element for accessibility row selection
Source:
Returns:
jQuery th DOM element
Type
jQuery

createTableHeaderColumn(columnIdx, columnSelectionMode) → {jQuery}

Create a th element with appropriate styling and column content
Parameters:
Name Type Description
columnIdx number column index
columnSelectionMode string column selection mode
Source:
Returns:
jQuery th DOM element
Type
jQuery

createTableHeaderColumnAccSelect(columnIdx, columnSelectionMode) → {jQuery}

Create a checkbox for accessibility column selection
Parameters:
Name Type Description
columnIdx number column index
columnSelectionMode string column selection mode
Source:
Returns:
jQuery div DOM element
Type
jQuery

createTableNoDataMessage() → {jQuery}

Create a div element for the 'No data to display' message
Source:
Returns:
jQuery div DOM element
Type
jQuery

createTableStatusMessage() → {jQuery}

Create a div element for the Fetching Data... status message
Source:
Returns:
jQuery div DOM element
Type
jQuery

getContextMenu() → {jQuery}

Get the context menu
Source:
Returns:
jQuery table DOM element
Type
jQuery

getEmptyTableDimensions() → {Object}

Return table dimensions without any data
Source:
Returns:
the height and width of the table
Type
Object

getFirstAncestor(element, className) → {jQuery|null}

Find the first ancestor of an element with a specific class name
Parameters:
Name Type Description
element jQuery the element to find the nearest class name to
className string the class name to look for
Source:
Returns:
the element with the className, if there is none returns null
Type
jQuery | null

getScroller() → {jQuery}

Return the table scroller
Source:
Returns:
scrolbar
Type
jQuery

getTable() → {jQuery}

Return the table element
Source:
Returns:
jQuery table DOM element
Type
jQuery

getTableBody() → {jQuery|null}

Return the table body element
Source:
Returns:
jQuery tbody DOM element
Type
jQuery | null

getTableBodyCell() → {jQuery|null}

Return the cell element param {number} rowIdx row index param {number} columnIdx column index
Source:
Returns:
jQuery td DOM element
Type
jQuery | null

getTableBodyCellAccSelect(tableBodyRow) → {jQuery|null}

Get checkbox cell for accessibility row selection
Parameters:
Name Type Description
tableBodyRow jQuery tr DOM element
Source:
Returns:
jQuery td DOM element
Type
jQuery | null

getTableBodyCells(rowIdx) → {jQuery|null}

Return all the cell elements in a row
Parameters:
Name Type Description
rowIdx number row index
Source:
Returns:
jQuery array of td DOM elements
Type
jQuery | null

getTableBodyRow(rowIdx) → {jQuery|null}

Return table row
Parameters:
Name Type Description
rowIdx number | null row index
Source:
Returns:
jQuery tr DOM element
Type
jQuery | null

getTableBodyRows() → {jQuery|null}

Return all the table rows
Source:
Returns:
jQuery array of tr DOM elements
Type
jQuery | null

getTableContainer() → {jQuery|null}

Return the table container
Source:
Returns:
jQuery div DOM element
Type
jQuery | null

getTableDivScroller() → {jQuery|null}

Return the table div scroller
Source:
Returns:
jQuery div DOM element
Type
jQuery | null

getTableFooter() → {jQuery|null}

Return the table footer
Source:
Returns:
jQuery tfoot DOM element
Type
jQuery | null

getTableFooterRow() → {jQuery|null}

Return table footer row
Source:
Returns:
jQuery tr DOM element
Type
jQuery | null

getTableHeader() → {jQuery|null}

Return the table header
Source:
Returns:
jQuery thead DOM element
Type
jQuery | null

getTableHeaderColumn(columnIdx) → {jQuery|null}

Return table column header
Parameters:
Name Type Description
columnIdx number column index
Source:
Returns:
jQuery th DOM element
Type
jQuery | null

getTableHeaderColumnAccSelect(columnIdx) → {jQuery|null}

Get checkbox cell for accessibility column selection
Parameters:
Name Type Description
columnIdx number column index
Source:
Returns:
jQuery td DOM element
Type
jQuery | null

getTableHeaderColumns() → {jQuery|null}

Return all table column headers
Source:
Returns:
jQuery array of th DOM elements
Type
jQuery | null

getTableHeaderRow() → {jQuery|null}

Return table header row
Source:
Returns:
jQuery th DOM element
Type
jQuery | null

getTableNoDataMessage() → {jQuery|null}

Return the table no data message element
Source:
Returns:
jQuery div DOM element
Type
jQuery | null

getTableStatusMessage() → {jQuery|null}

Return the table status message element
Source:
Returns:
jQuery div DOM element
Type
jQuery | null

Init()

Initializes the instance.
Source:

insertTableBodyCell(rowIdx, columnIdx, tableBodyCell, tableBodyRow)

Insert a td element in the appropriate place in the DOM
Parameters:
Name Type Description
rowIdx number row index
columnIdx number column index
tableBodyCell jQuery DOM element
tableBodyRow jQuery tr DOM element
Source:

insertTableBodyRow(rowIdx, tableBodyRow, row, docFrag)

Insert a tr element in the appropriate place in the DOM
Parameters:
Name Type Description
rowIdx number row index
tableBodyRow jQuery DOM element
row Object oj.Row
docFrag Object document fragment
Source:

insertTableFooterCell(columnIdx, tableFooterCell)

Insert a td element in the appropriate place in the DOM
Parameters:
Name Type Description
columnIdx number column index
tableFooterCell jQuery DOM element
Source:

insertTableHeaderColumn(columnIdx, tableHeaderColumn)

Insert a th element in the appropriate place in the DOM
Parameters:
Name Type Description
columnIdx number column index
tableHeaderColumn jQuery DOM element
Source:

isDivScroller() → {boolean}

Returns true if a div scroller is used. False if tbody scrolling is used.
Source:
Returns:
Whether div scroller is used
Type
boolean

refreshTableDimensions()

Refresh the table dimensions
Source:

removeTableBodyRow(rowIdx)

Remove a tr element from the DOM
Parameters:
Name Type Description
rowIdx number row index
Source:

replaceTableBodyRow(rowIdx, tableBodyRow, row, docFrag)

Replace a tr element in the appropriate place in the DOM
Parameters:
Name Type Description
rowIdx number row index
tableBodyRow jQuery DOM element
row Object oj.Row
docFrag Object document fragment
Source:

setTableBodyCell(rowIdx, columnIdx, tableBodyRow, row, cellRenderer)

Set the td cell. Calls the cell renderer or populates the value.
Parameters:
Name Type Description
rowIdx number row index
columnIdx number column index
tableBodyRow jQuery tr DOM element
row Object oj.Row
cellRenderer function(Object) cell renderer
Source:

setTableBodyCellAttributes(rowIdx, columnIdx, tableBodyCell)

Set the attributes on the cell like rowIdx, columnIdx, etc
Parameters:
Name Type Description
rowIdx number row index
columnIdx number column index
tableBodyCell jQuery td DOM element
Source:

setTableBodyRowAttributes(rowIdx, row, tableBodyRow)

Set the attributes on the row like rowIdx, etc
Parameters:
Name Type Description
rowIdx number row index
row Object oj.Row
tableBodyRow jQuery tr DOM element
Source:

styleInitialTable()

Style the initial table
Source:

styleTableBody(tableBody)

Style the tbody element
Parameters:
Name Type Description
tableBody jQuery thead DOM element
Source:

styleTableBodyCell(columnIdx, tableBodyCell)

Style the td element
Parameters:
Name Type Description
columnIdx number column index
tableBodyCell jQuery td DOM element
Source:

styleTableBodyRow(tableBodyRow, rowSelectionMode)

Style the tr element
Parameters:
Name Type Description
tableBodyRow jQuery tr DOM element
rowSelectionMode string row selection mode
Source:

styleTableContainer(tableContainer, height, width)

Style the table container
Parameters:
Name Type Description
tableContainer jQuery div DOM element
height number table height
width number table width
Source:

styleTableFooter(tableFooter)

Style the tfoot element
Parameters:
Name Type Description
tableFooter jQuery tfoot DOM element
Source:

styleTableFooterCell(columnIdx, tableFooterCell)

Style the td element
Parameters:
Name Type Description
columnIdx number column index
tableFooterCell jQuery td DOM element
Source:

styleTableHeader(tableHeader)

Style the thead element
Parameters:
Name Type Description
tableHeader jQuery thead DOM element
Source:

styleTableHeaderColumn(columnIdx, tableHeaderColumn, columnSelectionMode)

Style the th element
Parameters:
Name Type Description
columnIdx number column index
tableHeaderColumn jQuery th DOM element
columnSelectionMode string column selection mode
Source: