Initializer
.ojTable(options)
Parameters:
Name | Type | Argument | Description |
---|---|---|---|
options |
Object |
<optional> |
a map of option-value pairs to set on the component |
- Source:
Examples
Initialize the table via the JET ojComponent
binding:
<table id="table" summary="Department List" aria-label="Departments Table"
data-bind="ojComponent: {component: 'ojTable', data: datasource, columns:
[{headerText: 'Department Id', field: 'DepartmentId'},
{headerText: 'Department Name', field: 'DepartmentName'},
{headerText: 'Location Id', field: 'LocationId'},
{headerText: 'Manager Id', field: 'ManagerId'}]}">
Initialize the table with column templates via the JET ojComponent
binding:
<table id="table" summary="Department List" aria-label="Departments Table"
data-bind="ojComponent: {component: 'ojTable', data: datasource, columns:
[{headerText: 'Department Id', field: 'DepartmentId'},
{headerText: 'Department Name', field: 'DepartmentName'},
{headerText: 'Location Id', field: 'LocationId'},
{headerText: 'Manager Id', field: 'ManagerId'}]},
{headerTemplate: 'oracle_link_hdr', template: 'oracle_link'}]}">
<script type="text/html" id="oracle_link_hdr">
<th style="padding-left: 5px; padding-right: 5px;">
Oracle Link
</th>
</script>
<script type="text/html" id="oracle_link">
<td>
<a href="http://www.oracle.com">Oracle</a>
</td>
</script>
Initialize the table with rowTemplate via the JET ojComponent
binding:
<table id="table" summary="Department List" aria-label="Departments Table"
data-bind="ojComponent: {component: 'ojTable', data: datasource, columns:
[{headerText: 'Department Id', field: 'DepartmentId'},
{headerText: 'Department Name', field: 'DepartmentName'},
{headerText: 'Location Id', field: 'LocationId'},
{headerText: 'Manager Id', field: 'ManagerId'}],
rowTemplate: 'row_tmpl'}">
<script type="text/html" id="row_tmpl">
<tr>
<td data-bind="text: DepartmentId">
</td>
<td data-bind="text: DepartmentName">
</td>
<td data-bind="text: LocationId">
</td>
<td data-bind="text: ManagerId">
</td>
</tr>
</script>
Options
-
accessibility :Object.<string, string>|null
-
Accessibility options.
The following options are supported:
- rowHeader: columnId
- Default Value:
null
- Source:
Properties:
Name Type Description rowHeader
string the column id to be used as the row header by screen readers -
columns :Array.<Object>|null
-
An array of column definitions.
- Default Value:
null
- Source:
Example
Initialize the table with the
columns
option specified:<table id="table" summary="Department List" aria-label="Departments Table" data-bind="ojComponent: {component: 'ojTable', data: datasource, columns: [{headerText: 'Department Id', field: 'DepartmentId'}, {headerText: 'Department Name', field: 'DepartmentName']}">
-
columns[].className :string|null
-
The CSS class to apply to the column cells
- Default Value:
null
- Source:
-
columns[].field :string|null
-
The data field this column refers to.
- Default Value:
null
- Source:
-
columns[].footerClassName :string|null
-
The CSS class to apply to the footer cell.
- Default Value:
null
- Source:
-
columns[].footerRenderer :Function|null
-
The renderer function that renders the content of the footer. The function will be passed a context object which contains the following objects:
- columnIndex: The column index
- component: Instance of the component
- datasource: Instance of the datasource used by the table
- status: Contains the rowIndex, rowKey, and currentRow
- parentElement: Empty rendered
element The function returns either a String or a DOM element of the content inside the footer. If the developer chooses to manipulate the footer element directly, the function should return nothing. If no renderer is specified, the Table will treat the footer data as a String. - Default Value:
null
- Source:
columns[].footerStyle :string|null
The CSS styling to apply to the footer cell.- Default Value:
null
- Source:
columns[].headerClassName :string|null
The CSS class to apply to the column header text.- Default Value:
null
- Source:
columns[].headerRenderer :Function|null
The renderer function that renders the content of the header. The function will be passed a context object which contains the following objects:- columnIndex: The column index
- component: Instance of the component
- parentElement: Empty rendered TH element
- columnHeaderDefaultRenderer(options, delegateRenderer): If the column is not sortable then this function will be included in the context. The options parameter specifies the options (future use) for the renderer while the delegateRenderer parameter specifies the function which the developer would like to be called during rendering of the column header.
- columnHeaderSortableIconRenderer(options, delegateRenderer): If the column is sortable then this function will be included in the context. The options parameter specifies the options (future use) for the renderer while the delegateRenderer parameter specifies the function which the developer would like to be called during rendering of the sortable column header. Calling the columnHeaderSortableIconRenderer function enables rendering custom header content while also preserving the sort icons.
- Default Value:
null
- Source:
columns[].headerStyle :string|null
The CSS styling to apply to the column header text.- Default Value:
null
- Source:
columns[].headerText :string|null
Text to display in the header of the column.- Default Value:
null
- Source:
columns[].id :string|null
The identifier for the column- Default Value:
null
- Source:
columns[].renderer :Function|null
The renderer function that renders the content of the cell. The function will be passed a context object which contains the following objects:- data: The cell data
- columnIndex: The column index
- component: Instance of the component
- datasource: Instance of the datasource used by the table
- row: Key/value pairs of the row
- status: Contains the rowIndex, rowKey, and currentRow
- parentElement: Empty rendered
element The function returns either a String or a DOM element of the content inside the header. If the developer chooses to manipulate the cell element directly, the function should return nothing. If no renderer is specified, the Table will treat the cell data as a String. - Default Value:
null
- Source:
columns[].sortable :string|null
Whether or not the column is sortable.A sortable column has a clickable header that (when clicked) sorts the table by that column's property. Note that in order for a column to be sortable, this attribute must be set to "enabled" and the underlying model must support sorting by this column's property. If this attribute is set to "auto" then the column will be sortable if the underlying model supports sorting. A value of "none" will disable sorting on the column.
- Default Value:
"auto"
- Source:
columns[].sortProperty :string|null
Indicates the row attribute used for sorting when sort is invoked on this column. Useful for concatenated columns, where the sort is done by only a subset of the concatenated items.- Default Value:
null
- Source:
columns[].style :string|null
The CSS styling to apply to the column cells- Default Value:
null
- Source:
columnsDefault :Object.<string, string|null>
Default values to apply to all columns objects.- Default Value:
null
- Source:
Example
Initialize the table with the
columnsDefault
option specified:<table id="table" summary="Department List" aria-label="Departments Table" data-bind="ojComponent: {component: 'ojTable', data: datasource, columnsDefault: {headerStyle: 'text-align: left; white-space:nowrap;'}, columns: [{headerText: 'Department Id', field: 'DepartmentId'}, {headerText: 'Department Name', field: 'DepartmentName']}">
columnsDefault.className :string|null
The default CSS class for column cells- Default Value:
null
- Source:
columnsDefault.field :string|null
The default data field for column.- Default Value:
null
- Source:
columnsDefault.footerClassName :string|null
The CSS class to apply to the footer cell.- Default Value:
null
- Source:
columnsDefault.footerRenderer :Function|null
The renderer function that renders the content of the footer. The function will be passed a context object which contains the following objects:- columnIndex: The column index
- component: Instance of the component
- datasource: Instance of the datasource used by the table
- status: Contains the rowIndex, rowKey, and currentRow
- parentElement: Empty rendered
element The function returns either a String or a DOM element of the content inside the footer. If the developer chooses to manipulate the footer element directly, the function should return nothing. If no renderer is specified, the Table will treat the footer data as a String. - Default Value:
null
- Source:
columnsDefault.footerStyle :string|null
The CSS styling to apply to the footer cell.- Default Value:
null
- Source:
columnsDefault.headerClassName :string|null
The default CSS class to apply to the column header.- Default Value:
null
- Source:
columnsDefault.headerRenderer :Function|null
The renderer function that renders the content of the header. The function will be passed a context object which contains the following objects:- columnIndex: The column index
- component: Instance of the component
- parentElement: Empty rendered TH element
- columnHeaderDefaultRenderer(options, delegateRenderer): If the column is not sortable then this function will be included in the context. The options parameter specifies the options (future use) for the renderer while the delegateRenderer parameter specifies the function which the developer would like to be called during rendering of the column header.
- columnHeaderSortableIconRenderer(options, delegateRenderer): If the column is sortable then this function will be included in the context. The options parameter specifies the options (future use) for the renderer while the delegateRenderer parameter specifies the function which the developer would like to be called during rendering of the sortable column header. Calling the columnHeaderSortableIconRenderer function enables rendering custom header content while also preserving the sort icons.
- Default Value:
null
- Source:
columnsDefault.headerStyle :string|null
The default CSS styling to apply to the column header.- Default Value:
null
- Source:
columnsDefault.headerText :string|null
Default text to display in the header of the column.- Default Value:
null
- Source:
columnsDefault.renderer :Function|null
The renderer function that renders the content of the cell. The function will be passed a context object which contains the following objects:- data: The cell data
- columnIndex: The column index
- component: Instance of the component
- datasource: Instance of the datasource used by the table
- row: Key/value pairs of the row
- status: Contains the rowIndex, rowKey, and currentRow
- parentElement: Empty rendered
element The function returns either a String or a DOM element of the content inside the header. If the developer chooses to manipulate the cell element directly, the function should return nothing. If no renderer is specified, the Table will treat the cell data as a String. - Default Value:
null
- Source:
columnsDefault.sortable :string|null
Whether or not the column is sortable.A sortable column has a clickable header that (when clicked) sorts the table by that column's property. Note that in order for a column to be sortable, this attribute must be set to "enabled" and the underlying model must support sorting by this column's property. If this attribute is set to "auto" then the column will be sortable if the underlying model supports sorting. A value of "none" will disable sorting on the column.
- Default Value:
"auto"
- Source:
columnsDefault.sortProperty :string|null
Indicates the row attribute used for sorting when sort is invoked on this column. Useful for concatenated columns, where the sort is done by only a subset of the concatenated items.- Default Value:
null
- Source:
columnsDefault.style :string|null
Default CSS styling to apply to the column cells- Default Value:
null
- Source:
contextMenu :Object
JQ selector identifying the JET Menu that the component should launch as a context menu on right-click, Shift-F10, Press & Hold, or component-specific gesture. If specified, the browser's native context menu will be replaced by the specified JET Menu.
To specify a JET context menu on a DOM element that is not a JET component, see the
ojContextMenu
binding.To make the page semantically accurate from the outset, applications are encouraged to specify the context menu via the standard HTML5 syntax shown in the below example. When the component is initialized, the context menu thus specified will be set on the component.
After create time, the
contextMenu
option should be set via this API, not by setting the DOM attribute.- Default Value:
null
- Inherited From:
- Source:
Examples
Initialize a JET component with a context menu:
// via recommended HTML5 syntax: <div id="myComponent" contextmenu="myMenu" data-bind="ojComponent: { ... }> // via JET initializer (less preferred) : // Foo is the component, e.g., InputText, InputNumber, Select, etc. $( ".selector" ).ojFoo({ "contextMenu": "#myMenu" });
Get or set the
contextMenu
option, after initialization:// getter // Foo is the component, e.g., InputText, InputNumber, Select, etc. var menu = $( ".selector" ).ojFoo( "option", "contextMenu" ); // setter // Foo is the component, e.g., InputText, InputNumber, Select, etc. $( ".selector" ).ojFoo( "option", "contextMenu", ".my-marker-class" );
Set a JET context menu on an ordinary HTML element:
<a href="#" id="myAnchor" contextmenu="myMenu" data-bind="ojContextMenu: {}">Some text
currentRow :Object
The current row the user has navigated to. Can be an index and/or key value. When both are specified, the index is used as a hint. Returns the current row or null if there is none.- Default Value:
null
- Source:
Examples
Get the current row:
$( ".selector" ).ojTable("option", "currentRow");
Set the current row on the table during initialization:
$(".selector").ojTable({"currentRow", {rowKey: '123'}});
Set the current row on the table during initialization:
$(".selector").ojTable({"currentRow", {rowIndex: 1}});
Set the current row on the table after initialization:
$(".selector").ojTable("option", "currentRow", {rowKey: '123'});
Set the current row on the table after initialization:
$(".selector").ojTable("option", "currentRow", {rowIndex: 1});
data :oj.TableDataSource|null
The data to bind to the component.Must be of type oj.TableDataSource oj.TableDataSource
- Default Value:
null
- Source:
display :string
Whether to display table in list or grid mode. Setting a value of grid will cause the table to display in grid mode. The default value of this option is set through the theme.- Source:
dnd :Object
Enable drag and drop functionality.
JET provides support for HTML5 Drag and Drop events. Please refer to third party documentation on HTML5 Drag and Drop to learn how to use it.rows
: An array of objects, with each object representing the data of one selected row in the structure below:data The raw row data index The index for the row key The key value for the row columnIndex
: The index of the column being dropped onrowIndex
: The index of the row being dropped on- Default Value:
{reorder: {columns :'disabled'}, drag: null, drop: null}
- Source:
Properties:
Name Type Description drag
Object An object that describes drag functionlity. Properties
Name Type Description rows
Object If this object is specified, the table will initiate drag operation when the user drags on selected rows. Properties
Name Type Description dataTypes
string | Array.string (optional) The MIME types to use for the dragged data in the dataTransfer object. This can be a string if there is only one type, or an array of strings if multiple types are needed.
For example, if selected rows of employee data are being dragged, dataTypes could be "application/employees+json". Drop targets can examine the data types and decide whether to accept the data. A text input may only accept "text" data type, while a chart for displaying employee data may be configured to accept the "application/employees+json" type.
For each type in the array, dataTransfer.setData will be called with the specified type and the JSON version of the selected rows data as the value. The selected rows data is an array of objects, with each object representing one selected row in the format returned by TableDataSource.get().
This property is required unless the application calls setData itself in a dragStart callback function.dragStart
function (optional) A callback function that receives the "dragstart" event and context information as arguments:
function(event, ui)
Parameters:
event
: The jQuery event object
ui
: Context object with the following properties:
This function can set its own data and drag image as needed. If dataTypes is specified, event.dataTransfer is already populated with the default data when this function is invoked. If dataTypes is not specified, this function must call event.dataTransfer.setData to set the data or else the drag operation will be cancelled. In either case, the drag image is set to an image of the selected rows visible on the table.drag
function (optional) A callback function that receives the "drag" event as argument:
function(event)
Parameters:
event
: The jQuery event objectdragEnd
function (optional) A callback function that receives the "dragend" event as argument:
function(event)
Parameters:
event
: The jQuery event objectdrop
Object An object that describes drop functionality. Properties
Name Type Description columns
Object An object that specifies callback functions to handle dropping columns
For all callback functions, the following arguments will be passed:
event
: The jQuery event object
ui
: Context object with the following properties:Properties
Name Type Description dataTypes
string | Array.string A data type or an array of data types this component can accept.
This property is required unless dragEnter, dragOver, and drop callback functions are specified to handle the corresponding events.dragEnter
function (optional) A callback function that receives the "dragenter" event and context information as arguments:
function(event, ui)
This function should return false to indicate the dragged data can be accepted or true otherwise. Any explict return value will be passed back to jQuery. Returning false will cause jQuery to call stopPropagation and preventDefault on the event, and calling preventDefault is required by HTML5 Drag and Drop to indicate acceptance of data.
If this function doesn't return a value, dataTypes will be matched against the drag data types to determine if the data is acceptable. If there is a match, event.preventDefault will be called to indicate that the data can be accepted.dragOver
function (optional) A callback function that receives the "dragover" event and context information as arguments:
function(event, ui)
Similar to dragEnter, this function should return false to indicate the dragged data can be accepted or true otherwise. If this function doesn't return a value, dataTypes will be matched against the drag data types to determine if the data is acceptable.dragLeave
function (optional) A callback function that receives the "dragleave" event and context information as arguments:
function(event, ui)
drop
function (required) A callback function that receives the "drop" event and context information as arguments:
function(event, ui)
This function should return false to indicate the dragged data is accepted or true otherwise.rows
Object An object that specifies callback functions to handle dropping rows
For all callback functions, the following arguments will be passed:
event
: The jQuery event object
ui
: Context object with the following properties:Properties
Name Type Description dataTypes
string | Array.string A data type or an array of data types this component can accept.
This property is required unless dragEnter, dragOver, and drop callback functions are specified to handle the corresponding events.dragEnter
function (optional) A callback function that receives the "dragenter" event and context information as arguments:
function(event, ui)
This function should return false to indicate the dragged data can be accepted or true otherwise. Any explict return value will be passed back to jQuery. Returning false will cause jQuery to call stopPropagation and preventDefault on the event, and calling preventDefault is required by HTML5 Drag and Drop to indicate acceptance of data.
If this function doesn't return a value, dataTypes will be matched against the drag data types to determine if the data is acceptable. If there is a match, event.preventDefault will be called to indicate that the data can be accepted.dragOver
function (optional) A callback function that receives the "dragover" event and context information as arguments:
function(event, ui)
Similar to dragEnter, this function should return false to indicate the dragged data can be accepted or true otherwise. If this function doesn't return a value, dataTypes will be matched against the drag data types to determine if the data is acceptable.dragLeave
function (optional) A callback function that receives the "dragleave" event and context information as arguments:
function(event, ui)
drop
function (required) A callback function that receives the "drop" event and context information as arguments:
function(event, ui)
This function should return false to indicate the dragged data is accepted or true otherwise.
If the application needs to look at the data for the row being dropped on, it can use the getDataForVisibleRow method.reorder
Object An object with property columns
Enable or disable reordering the columns within the same table using drag and drop.
Specify an object with the property "reorder" set to{'columns':'enabled'}
to enable reordering. Setting the"reorder"
property to{'columns':'disabled'}
, or setting the"dnd"
property tonull
(or omitting it), disables reordering support. Re-ordering is supported one column at a time. In addition, re-ordering will not re-order any cells which have the colspan attribute with value > 1. Such cells will need to be re-ordered manually by listening to the option change event on the columns option.Properties
Name Type Description columns
string column reordering within the table: "enabled", "disabled" Examples
Initialize the table to enable column reorder:
$( ".selector" ).ojTable({ "data":data, "dnd" : {"reorder":{"columns":"enabled"}}});
Initialize the table to enable dragging of selected rows using default behavior:
$( ".selector" ).ojTable({ "data":data, "dnd" : {"drag":{"rows":{"dataTypes":"application/ojtablerows+json"}}}});
emptyText :string|null
The text to display when there are no data in the Table. If it is not defined, then a default empty text is extracted from the resource bundle.- Default Value:
"No data to display."
- Source:
Example
Initialize the table with the
emptyText
option specified:<table id="table" summary="Department List" aria-label="Departments Table" data-bind="ojComponent: {component: 'ojTable', data: datasource, emptyText: 'No data', columns: [{headerText: 'Department Id', field: 'DepartmentId'}, {headerText: 'Department Name', field: 'DepartmentName']}">
horizontalGridVisible :string
Whether the horizontal gridlines are to be drawn. Can be enabled or disabled. The default value of auto means it's determined by the displayStyle option.- Default Value:
"auto"
- Source:
rootAttributes :Object
Attributes specified here will be set on the component's root DOM element at creation time. This is particularly useful for components like Dialog that wrap themselves in a new root element at creation time.
The supported attributes are
id
, which overwrites any existing value, andclass
andstyle
, which are appended to the current class and style, if any.Setting this option after component creation has no effect. At that time, the root element already exists, and can be accessed directly via the
widget
method, per the second example below.- Default Value:
null
- Inherited From:
- Source:
Examples
Initialize a JET component, specifying a set of attributes to be set on the component's root DOM element:
// Foo is the component, e.g., Menu, Button, InputText, InputNumber, Select, etc. $( ".selector" ).ojFoo({ "rootAttributes": { "id": "myId", "style": "max-width:100%; color:blue;", "class": "my-class" }});
After initialization,
rootAttributes
should not be used. It is not needed at that time, as attributes of the root DOM element can simply be set directly, usingwidget
:// Foo is the component, e.g., Menu, Button, InputText, InputNumber, Select, etc. $( ".selector" ).ojFoo( "widget" ).css( "height", "100px" ); $( ".selector" ).ojFoo( "widget" ).addClass( "my-class" );
rowRenderer :Function|null
The row renderer function to use.The renderer function will be passed in an Object which contains the fields:
- component: Instance of the component
- row: Key/value pairs of the row
- status: Contains the rowIndex, rowKey, and currentRow
- parentElement: Empty rendered TR element
- Default Value:
null
- Source:
scrollPolicy :string|null
Specifies the mechanism used to scroll the data inside the table. Possible values are: auto and loadMoreOnScroll. When loadMoreOnScroll is specified, additional data are fetched when the user scrolls to the bottom of the table.- Default Value:
null
- Source:
Example
Initialize the table with the
scrollPolicy
option specified:<table id="table" ummary="Department List" aria-label="Departments Table" data-bind="ojComponent: {component: 'ojTable', data: datasource, scrollPolicy: 'loadMoreOnScroll', columns: [{headerText: 'Department Id', field: 'DepartmentId'}, {headerText: 'Department Name', field: 'DepartmentName']}">
scrollPolicyOptions :Object.<string, string>|null
scrollPolicy options.The following options are supported:
- fetchSize: Fetch size for scroll.
- maxCount: Maximum rows which will be displayed before fetching more rows will be stopped.
- Default Value:
{'fetchSize': 25, 'maxCount': 500}
- Source:
Properties:
Name Type Description fetchSize
string the number of rows to fetch in each block of rows maxCount
string the number of rows which will be displayed before fetching more rows will be stopped selection :Array.<Object>
Specifies the current selections in the table. Can be either an index or key value. When both are specified, the index is used as a hint. Returns an array of range objects, or an empty array if there's no selection.- Default Value:
[]
- Source:
Examples
Get the current selection:
$( ".selector" ).ojTable("option", "selection");
Set a row selection on the table during initialization:
$(".selector").ojTable({"selection", [{startIndex: {"row":1}, endIndex:{"row":3}}]});
Set a column selection on the table during initialization:
$(".selector").ojTable({"selection", [{startIndex: {"column":2}, endIndex: {"column":4}}]});
Set a row selection on the table after initialization:
$(".selector").ojTable("option", "selection", [{startIndex: {"row":1}, endIndex:{"row":3}}]);
Set a column selection on the table after initialization:
$(".selector").ojTable("option", "selection", [{startIndex: {"column":1}, endIndex: {"column":3}}]);
Set a row selection on the table after initialization:
$(".selector").ojTable("option", "selection", [{startKey: {"row":10}, endKey:{"row":30}}]);
Set a column selection on the table after initialization:
$(".selector").ojTable("option", "selection", [{startKey: {"column": column1}, endKey: {"column": column2}}]);
selectionMode :Object.<string, string>|null
The row and column selection modes. Both can be either single or multiple.- Default Value:
null
- Source:
Properties:
Name Type Description row
string single or multiple selection for rows column
string single or multiple selection for columns Example
Initialize the table with the
selectionMode
option specified:<table id="table" summary="Department List" aria-label="Departments Table" data-bind="ojComponent: {component: 'ojTable', data: datasource, selectionMode: {row: 'multiple', column: 'multiple'}, columns: [{headerText: 'Department Id', field: 'DepartmentId'}, {headerText: 'Department Name', field: 'DepartmentName']}">
translations :Object
A collection of translated resources from the translation bundle, or
null
if this component has no resources. Resources may be accessed and overridden individually or collectively, as seen in the examples.If this component has (or inherits) translations, their documentation immediately follows this doc entry.
- Default Value:
- an object containing all resources relevant to the component and all its superclasses, or
null
if none
- an object containing all resources relevant to the component and all its superclasses, or
- Inherited From:
- Source:
Examples
Initialize the component, overriding some translated resources. This syntax leaves the other translations intact at create time, but not if called after create time:
// Foo is InputDate, InputNumber, etc. $( ".selector" ).ojFoo({ "translations": { someKey: "someValue", someOtherKey: "someOtherValue" } });
Get or set the
translations
option, after initialization:// Get one. (Foo is InputDate, InputNumber, etc.) var value = $( ".selector" ).ojFoo( "option", "translations.someResourceKey" ); // Get all. (Foo is InputDate, InputNumber, etc.) var values = $( ".selector" ).ojFoo( "option", "translations" ); // Set one, leaving the others intact. (Foo is InputDate, InputNumber, etc.) $( ".selector" ).ojFoo( "option", "translations.someResourceKey", "someValue" ); // Set many. Any existing resource keys not listed are lost. (Foo is InputDate, InputNumber, etc.) $( ".selector" ).ojFoo( "option", "translations", { someKey: "someValue", someOtherKey: "someOtherValue" } );
translations.labelAccSelectionAffordanceBottom :Object
Label for the bottom selection affordance on touch devices.
See the translations option for usage examples.
- Source:
translations.labelAccSelectionAffordanceTop :Object
Label for the top selection affordance on touch devices.
See the translations option for usage examples.
- Source:
translations.labelDisableNonContiguousSelection :Object
Provides properties to customize the context menu label for exiting non-contigous selection.
See the translations option for usage examples.
- Since:
- 1.2.0
- Source:
translations.labelEnableNonContiguousSelection :Object
Provides properties to customize the context menu label for entering non-contigous selection.
See the translations option for usage examples.
- Since:
- 1.2.0
- Source:
translations.labelSelectColum :string
Select column label.
See the translations option for usage examples.
- Default Value:
"Select Column"
- Source:
translations.labelSelectRow :string
Select row label.
See the translations option for usage examples.
- Default Value:
"Select Row"
- Source:
translations.labelSort :string
Context menu label for sort.
See the translations option for usage examples.
- Default Value:
"Sort"
- Source:
translations.labelSortAsc :string
Context menu label for sort ascending.
See the translations option for usage examples.
- Default Value:
"Sort Ascending"
- Source:
translations.labelSortDsc :string
Context menu label for sort descending.
See the translations option for usage examples.
- Default Value:
"Sort Descending"
- Source:
translations.msgFetchingData :string
Fetching data message.
See the translations option for usage examples.
- Default Value:
"Fetching Data..."
- Source:
translations.msgNoData :string
No data to display message.
See the translations option for usage examples.
- Default Value:
"No data to display."
- Source:
verticalGridVisible :string
Whether the vertical gridlines are to be drawn. Can be enabled or disabled. The default value of auto means it's determined by the displayStyle option.- Default Value:
"auto"
- Source:
Binding Attributes
Binding attributes are similar to component options, but are exposed only via the
ojComponent
binding.-
columns[].footerTemplate :string|null
-
The knockout template used to render the content of the column footer. This attribute is only exposed via the
ojComponent
binding, and is not a component option. The following variables are also passed into the template- $columnIndex: The column index
- $footerContext: The header context
- Default Value:
null
- Source:
Example
Specify the column footer
template
when initializing Table:// set the template <table id="table" summary="Department List" aria-label="Departments Table" data-bind="ojComponent: {component: 'ojTable', data: dataSource, columnsDefault: [{headerText: 'Department Id', field: 'DepartmentId'}, {headerText: 'Department Name', field: 'DepartmentName'}, {headerText: 'Location Id', field: 'LocationId'}, {headerText: 'Manager Id', field: 'ManagerId'}, {footerTemplate: 'oracle_link_ftr'}]}"></table>
-
columns[].headerTemplate :string|null
-
The knockout template used to render the content of the column header. This attribute is only exposed via the
ojComponent
binding, and is not a component option. The following variables are also passed into the template- $columnIndex: The column index
- $data: The header text
- $headerContext: The header context
- Default Value:
null
- Source:
Example
Specify the column header
template
when initializing Table:// set the template <table id="table" summary="Department List" aria-label="Departments Table" data-bind="ojComponent: {component: 'ojTable', data: dataSource, columns: [{headerText: 'Department Id', field: 'DepartmentId'}, {headerText: 'Department Name', field: 'DepartmentName'}, {headerText: 'Location Id', field: 'LocationId'}, {headerText: 'Manager Id', field: 'ManagerId'}, {headerTemplate: 'oracle_link_hdr'}]}"></table>
-
columnsDefault.footerTemplate :string|null
-
The default knockout template used to render the content of the column footer. This attribute is only exposed via the
ojComponent
binding, and is not a component option. The following variables are also passed into the template- $columnIndex: The column index
- $footerContext: The header context
- Default Value:
null
- Source:
Example
Specify the column footer
template
when initializing Table:// set the template <table id="table" summary="Department List" aria-label="Departments Table" data-bind="ojComponent: {component: 'ojTable', data: dataSource, columnsDefault: [{headerText: 'Department Id', field: 'DepartmentId'}, {headerText: 'Department Name', field: 'DepartmentName'}, {headerText: 'Location Id', field: 'LocationId'}, {headerText: 'Manager Id', field: 'ManagerId'}, {footerTemplate: 'oracle_link_ftr'}]}"></table>
-
columnsDefault.headerTemplate :string|null
-
The default knockout template used to render the content of the column header. This attribute is only exposed via the
ojComponent
binding, and is not a component option. The following variables are also passed into the template- $columnIndex: The column index
- $data: The header text
- $headerContext: The header context
- Default Value:
null
- Source:
Example
Specify the column header
template
when initializing Table:// set the template <table id="table" summary="Department List" aria-label="Departments Table" data-bind="ojComponent: {component: 'ojTable', data: dataSource, columnsDefault: [{headerText: 'Department Id', field: 'DepartmentId'}, {headerText: 'Department Name', field: 'DepartmentName'}, {headerText: 'Location Id', field: 'LocationId'}, {headerText: 'Manager Id', field: 'ManagerId'}, {headerTemplate: 'oracle_link_hdr'}]}"></table>
-
rowTemplate :string|null
-
The knockout template used to render the content of the row. This attribute is only exposed via the
ojComponent
binding, and is not a component option. The following variables are also passed into the template- $rowContext: The row context
- Default Value:
null
- Source:
Example
Specify the row
template
when initializing Table:// set the template <table id="table" summary="Department List" aria-label="Departments Table" data-bind="ojComponent: {component: 'ojTable', data: dataSource, rowTemplate: 'row_tmpl'}"></table>
Context Objects
Each context object contains, at minimum, a
subId
property, whose value is a string that identifies a particular DOM node in this component. It can have additional properties to further specify the desired node. See getContextByNode for more details.Properties:
Name Type Description subId
string Sub-id string to identify a particular dom node. Following are the valid subIds:
-
oj-table-cell
-
Context for the ojTable component's cells.
- Source:
Properties:
Name Type Description rowIndex
number the zero based absolute row index columnIndex
number the zero based absolute column index -
oj-table-footer
-
Context for the ojTable component's footers.
- Source:
Properties:
Name Type Description index
number the zero based absolute column index -
oj-table-header
-
Context for the ojTable component's headers.
- Source:
Properties:
Name Type Description index
number the zero based absolute column index
Sub-ID's
Each subId locator object contains, at minimum, a
subId
property, whose value is a string that identifies a particular DOM node in this component. It can have additional properties to further specify the desired node. See getNodeBySubId and getSubIdByNode methods for more details.Properties:
Name Type Description subId
string Sub-id string to identify a particular dom node. Following are the valid subIds:
-
oj-table-cell
-
Sub-ID for the ojTable component's cells.
To lookup a cell the locator object should have the following:- subId: 'oj-table-cell'
- rowIndex: the zero based absolute row index
- columnIndex: the zero based absolute column index
- Source:
Example
Get the cell at row index 1 and column index 2:
var node = $( ".selector" ).ojTable( "getNodeBySubId", {'subId': 'oj-table-cell', 'rowIndex': 1, 'columnIndex': 2} );
-
oj-table-footer
-
Sub-ID for the ojTable component's footers.
To lookup a footer the locator object should have the following:- subId: 'oj-table-footer'
- index: the zero based absolute column index.
- Source:
Example
Get the header at the specified location:
var node = $( ".selector" ).ojTable( "getNodeBySubId", {'subId': 'oj-table-footer', 'index':0} );
-
oj-table-header
-
Sub-ID for the ojTable component's headers.
To lookup a header the locator object should have the following:- subId: 'oj-table-header'
- index: the zero based absolute column index.
- Source:
Example
Get the header at the specified location:
var node = $( ".selector" ).ojTable( "getNodeBySubId", {'subId': 'oj-table-header', 'index':0} );
-
oj-table-sort-ascending
-
Sub-ID for the ojTable component's sort ascending icon in column headers.
To lookup a sort icon the locator object should have the following:- subId: 'oj-table-sort-ascending'
- index: the zero based absolute column index
- Source:
Example
Get the sort ascending icon from the header at the specified location:
var node = $( ".selector" ).ojTable( "getNodeBySubId", {'subId': 'oj-table-sort-ascending', 'index':0} );
-
oj-table-sort-descending
-
Sub-ID for the ojTable component's sort descending icon in column headers.
To lookup a sort icon the locator object should have the following:- subId: 'oj-table-sort-descending'
- index: the zero based absolute column index
- Source:
Example
Get the sort descending icon from the header at the specified location:
var node = $( ".selector" ).ojTable( "getNodeBySubId", {'subId': 'oj-table-sort-descending', 'index':0} );
Events
-
#beforeCurrentRow
-
Triggered before the current row is changed via the
currentRow
option or via the UI.- Source:
Properties:
Name Type Description event
Event jQuery
event objectui
Object Parameters Properties
Name Type Description currentRow
Object the new current row Properties
Name Type Description rowIndex
number current row index rowKey
string current row key previousCurrentRow
number the previous current row Properties
Name Type Description rowIndex
number previous current row index rowKey
string previous current row key Examples
Initialize the table with the
beforeCurrentRow
callback specified:$( ".selector" ).ojTable({ "beforeCurrentRow": function( event, ui ) {} });
Bind an event listener to the
ojbeforecurrentrow
event:$( ".selector" ).on( "ojbeforecurrentrow", function( event, ui ) {} );
-
destroy
-
Triggered before the component is destroyed. This event cannot be canceled; the component will always be destroyed regardless.
- Inherited From:
- Source:
Examples
Initialize component with the
destroy
callback// Foo is Button, InputText, etc. $(".selector").ojFoo({ 'destroy': function (event, data) {} });
Bind an event listener to the destroy event
$(".selector").on({ 'ojdestroy': function (event, data) { window.console.log("The DOM node id for the destroyed component is : %s", event.target.id); }; });
-
#optionChange
-
Fired whenever a supported component option changes, whether due to user interaction or programmatic intervention. If the new value is the same as the previous value, no event will be fired. Currently there are 2 supported options,
"selection"
and"currentRow"
. Additional options may be supported in the future, so listeners should verify which option is changing before taking any action.- Source:
Properties:
Name Type Description event
Event jQuery
event objectui
Object Parameters Properties
Name Type Description option
string the name of the option that is changing previousValue
Object the previous value of the option value
Object the current value of the option optionMetadata
Object information about the option that is changing Properties
Name Type Description writeback
string "shouldWrite"
or"shouldNotWrite"
. For use by the JET writeback mechanism. -
#ready
-
Triggered when the table has finished rendering
- Source:
Examples
Initialize the table with the
ready
callback specified:$( ".selector" ).ojTable({ "ready": function() {} });
Bind an event listener to the
ojready
event:$( ".selector" ).on( "ojready", function() {} );
-
#sort
-
Triggered when a sort is performed on the table
- Source:
Properties:
Name Type Description event
Event jQuery
event objectui
Object Parameters Properties
Name Type Description header
Element the key of the header which was sorted on direction
string the direction of the sort ascending/descending Examples
Initialize the table with the
sort
callback specified:$( ".selector" ).ojTable({ "sort": function( event, ui ) {} });
Bind an event listener to the
ojsort
event:$( ".selector" ).on( "ojsort", function( event, ui ) {} );
Methods
-
getContextByNode(node) → {Object|null}
-
Returns an object with context for the given child DOM node. This will always contain the subid for the node, defined as the 'subId' property on the context object. Additional component specific information may also be included. For more details on returned objects, see context objects.
Parameters:
Name Type Description node
Element The child DOM node - Source:
Returns:
The context for the DOM node, ornull
when none is found.- Type
- Object | null
Example
// Foo is ojInputNumber, ojInputDate, etc. // Returns {'subId': oj-foo-subid, 'property1': componentSpecificProperty, ...} var context = $( ".selector" ).ojFoo( "getContextByNode", nodeInsideComponent );
-
#getDataForVisibleRow(rowIndex) → {Object|null}
-
Return the row data for a rendered row in the table.
Parameters:
Name Type Description rowIndex
Number row index - Source:
Returns:
a compound object which has the structure below. If the row has not been rendered, returns null.data The raw row data index The index for the row key The key value for the row - Type
- Object | null
Example
Invoke the
getDataForVisibleRow
method:$( ".selector" ).ojTable( "getDataForVisibleRow", 2 );
-
#getNodeBySubId(locator) → {Array.<(Element|null)>|Element|null}
-
Return the subcomponent node represented by the documented locator attribute values.
To lookup a cell the locator object should have the following:
(Note: This will return the cell based on displayed index. ie, colspan defined cells
will span the specified number of positions. For example, if the first td has colspan 3
then calling with columnIndex=2 will return that td.)- subId: 'oj-table-cell'
- rowIndex: the zero based absolute row index
- columnIndex: the zero based absolute column index
(Note: This will return the header based on displayed index. ie, colspan defined headers
will span the specified number of positions. For example, if the first th has colspan 3
then calling with index=2 will return that th.)- subId: 'oj-table-header'
- index: the zero based absolute column index.
(Note: This will return the link based on displayed index. ie, colspan defined headers
will span the specified number of positions.)- subId: 'oj-table-sort-ascending'
- index: the zero based absolute column index
(Note: This will return the link based on displayed index. ie, colspan defined headers
will span the specified number of positions.)- subId: 'oj-table-sort-descending'
- index: the zero based absolute column index
(Note: This will return the footer based on displayed index. ie, colspan defined footers
will span the specified number of positions.)- subId: 'oj-table-footer'
- index: the zero based absolute column index.
Parameters:
Name Type Description locator
Object An Object containing at minimum a subId property whose value is a string, documented by the component, that allows the component to look up the subcomponent associated with that string. It contains: component: optional - in the future there may be more than one component contained within a page element
subId: the string, documented by the component, that the component expects in getNodeBySubId to locate a particular subcomponent
- Source:
Returns:
the subcomponent located by the subId string passed in locator, if found.- Type
- Array.<(Element | null)> | Element | null
-
getSubIdByNode(node, ignoreSortIcons) → {Object|null}
-
Returns the subId string for the given child DOM node. For more details, see getNodeBySubId.
Parameters:
Name Type Argument Default Description node
Element child DOM node ignoreSortIcons
boolean <optional>
false true to ignore sort icons and treat them as table header; false to return subId for them. - Source:
Returns:
The subId for the DOM node, ornull
when none is found.- Type
- Object | null
Example
Get the subId for a certain DOM node:
var subId = $( ".selector" ).ojTable( "getSubIdByNode", nodeInsideComponent );
-
option(optionName, value) → {Object|undefined}
-
This method has several overloads, which get and set component options and their fields. The functionality is unchanged from that provided by JQUI. See the examples for details on each overload.
Parameters:
Name Type Argument Description optionName
string | Object <optional>
the option name (string, first two overloads), or the map (Object, last overload). Omitted in the third overload. value
Object <optional>
a value to set for the option. Second overload only. - Inherited From:
- Source:
Returns:
The getter overloads return the retrieved value(s). When called via the public jQuery syntax, the setter overloads return the object on which they were called, to facilitate method chaining.- Type
- Object | undefined
Examples
First overload: get one option:
This overload accepts a (possibly dot-separated)
optionName
param as a string, and returns the current value of that option.var isDisabled = $( ".selector" ).ojFoo( "option", "disabled" ); // Foo is Button, Menu, etc. // For object-valued options, dot notation can be used to get the value of a field or nested field. var startIcon = $( ".selector" ).ojButton( "option", "icons.start" ); // icons is object with "start" field
Second overload: set one option:
This overload accepts two params: a (possibly dot-separated)
optionName
string, and a new value to which that option will be set.$( ".selector" ).ojFoo( "option", "disabled", true ); // Foo is Button, Menu, etc. // For object-valued options, dot notation can be used to set the value // of a field or nested field, without altering the rest of the object. $( ".selector" ).ojButton( "option", "icons.start", myStartIcon ); // icons is object with "start" field
Third overload: get all options:
This overload accepts no params, and returns a map of key/value pairs representing all the component options and their values.
var options = $( ".selector" ).ojFoo( "option" ); // Foo is Button, Menu, etc.
Fourth overload: set one or more options:
This overload accepts a single map of option-value pairs to set on the component. Unlike the first two overloads, dot notation cannot be used.
$( ".selector" ).ojFoo( "option", { disabled: true, bar: 42 } ); // Foo is Button, Menu, etc.
-
#refresh()
-
Refresh the table.
- Source:
Returns:
When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining.Example
Invoke the
refresh
method:$( ".selector" ).ojTable( "refresh" );
-
#refreshRow(rowIdx) → {boolean}
-
Refresh a row in the table.
Parameters:
Name Type Description rowIdx
number Index of the row to refresh. - Source:
Throws:
- Type
- Error
Returns:
true if refreshed, false if not- Type
- boolean
Example
Invoke the
refreshRow
method:$( ".selector" ).ojTable( "refreshRow", 1 );
-
widget() → {jQuery}
-
Returns a jQuery object containing the root dom element of the table
This method does not accept any arguments.
- Source:
Returns:
the root DOM element of table- Type
- jQuery
Non-public Methods
Note: Extending JET components is not currently supported. Thus, non-public methods are for internal use only.
-
<protected, static> _AfterCreate()
-
Initialize the table after creation
- Source:
-
<protected> _activeable(element)
-
Sets the
oj-active
class on mousedown and removes it on mouseup.oj-active
is one of JET's 'marker' style classes. It emulates the css:active
pseudo-class.Unlike _hoverable() and _focusable(), this is an original JET method not inherited from JQUI. (Obviously inspired by those methods.)
Typically the specified element should be within the component subtree, in which case the class will automatically be removed from the element when the component is destroyed, when its
disabled
option is set to true, and when_NotifyDetached()
is called.As a minor exception, for components that wrap themselves in a new root node at create time, if the specified element is within the root node's subtree but not within the init node's subtree, then at destroy time only, the class will not be removed, since
destroy()
is expected to remove such nodes.If the element is NOT in the component subtree, then the caller is responsible for removing the class at the times listed above.
Parameters:
Name Type Description element
jQuery The element to receive the oj-active
class when pressed- Inherited From:
- Source:
-
<protected> _AfterCreate()
-
This method is called after _ComponentCreate, but before the
create
event is fired. The JET base component does tasks here that must happen after the component (subclass) has created itself in its override of _ComponentCreate. Notably, the base component handles the rootAttributes and contextMenu options here, since those options operate on the component root node, which for some components is created in their override of _ComponentCreate.Subclasses should override this method only if they have tasks that must happen after a superclass's implementation of this method, e.g. tasks that must happen after the context menu is set on the component.
Overrides of this method should call
this._super
first.- Inherited From:
- Source:
-
<protected> _AfterCreateEvent()
-
This method is called after the
create
event is fired. Components usually should not override this method, as it is rarely correct to wait until after thecreate
event to perform a create-time task.An example of a correct usage of this method is Dialog's auto-open behavior, which needs to happen after the
create
event.Only behaviors (like Dialog auto-open behavior) should occur in this method. Component initialization must occur earlier, before the
create
event is fired, so thatcreate
listeners see a fully inited component.Overrides of this method should call
this._super
first.Do not confuse this method with the _AfterCreate method, which is more commonly used.
- Inherited From:
- Source:
-
<protected> _CompareOptionValues(option, value1, value2) → {boolean}
-
Compares 2 option values for equality and returns true if they are equal; false otherwise.
Parameters:
Name Type Description option
String the name of the option value1
Object first value value2
Object another value - Inherited From:
- Source:
Returns:
- Type
- boolean
-
<protected> #_ComponentCreate()
-
- Source:
-
<protected> _create()
-
This method is final in JET. Components should instead override one or more of the overridable create-time methods listed in _ComponentCreate.
- Inherited From:
- Source:
-
<protected> _focusable(element)
-
Sets the
oj-focus
class when the element is focused and removes it when focus is lost.Overridden to set the
oj-focus
class instead of JQUI's hard-codedui-
class, and eliminate JQUI's caching.Typically the specified element should be within the component subtree, in which case the class will automatically be removed from the element when the component is destroyed, when its
disabled
option is set to true, and when_NotifyDetached()
is called.As a minor exception, for components that wrap themselves in a new root node at create time, if the specified element is within the root node's subtree but not within the init node's subtree, then at destroy time only, the class will not be removed, since
destroy()
is expected to remove such nodes.If the element is NOT in the component subtree, then the caller is responsible for removing the class at the times listed above.
Parameters:
Name Type Description element
jQuery The element to receive the oj-focus
class on focus- Inherited From:
- Source:
-
<protected> _getCreateOptions()
-
This method is not used in JET. Components should instead override _InitOptions.
- Inherited From:
- Source:
-
<protected> _GetReadingDirection() → {string}
-
Determines whether the component is LTR or RTL.
Component responsibilities:
- All components must determine directionality exclusively by calling this protected superclass method. (So that any future updates to the logic can be made in this one place.)
- Components that need to know the directionality must call this method at create-time
and from
refresh()
, and cache the value. - Components should not call this at other times, and should instead use the cached value. (This avoids constant DOM queries, and avoids any future issues with component reparenting (i.e. popups) if support for directional islands is added.)
App responsibilities:
- The app specifies directionality by setting the HTML
"dir"
attribute on the<html>
node. When omitted, the default is"ltr"
. (Per-component directionality / directional islands are not currently supported due to inadequate CSS support.) - As with any DOM change, the app must
refresh()
the component if the directionality changes dynamically. (This provides a hook for component housekeeping, and allows caching.)
- Default Value:
"ltr"
- Inherited From:
- Source:
Returns:
the reading direction, either"ltr"
or"rtl"
- Type
- string
-
<protected> _GetSavedAttributes(element) → {Object|null}
-
Gets the saved attributes for the provided element.
If you don't override _SaveAttributes and _RestoreAttributes, then this will return null.
If you override _SaveAttributes to call _SaveAllAttributes, then this will return all the attributes. If you override _SaveAttributes/_RestoreAttributes to do your own thing, then you may also have to override _GetSavedAttributes to return whatever you saved if you need access to the saved attributes.
Parameters:
Name Type Description element
Object jQuery selection, should be a single entry - Inherited From:
- Source:
Returns:
savedAttributes - attributes that were saved for this element in _SaveAttributes, or null if none were saved.- Type
- Object | null
-
<protected> _hoverable(element)
-
Sets the
oj-hover
class when the element is hovered and removes it when the hover ends.Overridden to set the
oj-hover
class instead of JQUI's hard-codedui-
class, and eliminate JQUI's caching.Typically the specified element should be within the component subtree, in which case the class will automatically be removed from the element when the component is destroyed, when its
disabled
option is set to true, and when_NotifyDetached()
is called.As a minor exception, for components that wrap themselves in a new root node at create time, if the specified element is within the root node's subtree but not within the init node's subtree, then at destroy time only, the class will not be removed, since
destroy()
is expected to remove such nodes.If the element is NOT in the component subtree, then the caller is responsible for removing the class at the times listed above.
Parameters:
Name Type Description element
jQuery The element to receive the oj-hover
class on hover- Inherited From:
- Source:
-
<protected> _init()
-
JET components should almost never implement this JQUI method. Please consult an architect if you believe you have an exception. Reasons:
- This method is called at create time, after the
create
event is fired. It is rare for that to be the appropriate time to perform a create-time task. For those rare cases, we have the _AfterCreateEvent method, which is preferred over this method since it is called only at that time, not also at re-init time (see next). - This method is also called at "re-init" time, i.e. when the initializer is called after the component has already been created. JET has not yet identified any desired semantics for re-initing a component.
- Inherited From:
- Source:
- This method is called at create time, after the
-
<protected> _InitOptions(originalDefaults, constructorOptions)
-
This method is called before _ComponentCreate, at which point the component has not yet been rendered. Component options should be initialized in this method, so that their final values are in place when _ComponentCreate is called.
This includes getting option values from the DOM, where applicable, and coercing option values (however derived) to their appropriate data type if needed.
No work other than setting options should be done in this method. In particular, nothing should be set on the DOM until _ComponentCreate, e.g. setting the
disabled
DOM attribute from thedisabled
option.A given option (like
disabled
) appears in theconstructorOptions
param iff the app set it in the constructor:- If it appears in
constructorOptions
, it should win over what's in the DOM (e.g.disabled
DOM attribute). If for some reason you need to tweak the value that the app set, then enable writeback when doing so:this.option('foo', bar, {'_context': {writeback: true, internalSet: true}})
. - If it doesn't appear in
constructorOptions
, then that option definitely is not bound, so writeback is not needed. So if you need to set the option (e.g. from a DOM attribute), usethis.option('foo', bar, {'_context': {internalSet: true}})
.
Overrides of this method should call
this._super
first.Parameters:
Name Type Argument Description originalDefaults
Object original default options defined on the component and its ancestors constructorOptions
Object <nullable>
options passed into the widget constructor - Inherited From:
- Source:
- If it appears in
-
<protected> _IsEffectivelyDisabled() → {boolean}
-
Determines whether this component is effectively disabled, i.e. it has its 'disabled' attribute set to true or it has been disabled by its ancestor component.
- Inherited From:
- Source:
Returns:
true if the component has been effectively disabled, false otherwise- Type
- boolean
-
<protected> _NotifyAttached()
-
Notifies the component that its subtree has been connected to the document programmatically after the component has been created.
- Inherited From:
- Source:
-
<protected> _NotifyContextMenuGesture(menu, event, eventType)
-
When the contextMenu option is set, this method is called when the user invokes the context menu via the default gestures: right-click, Press & Hold, and Shift-F10. Components should not call this method directly.
The default implementation simply calls this._OpenContextMenu(event, eventType). Overrides of this method should call that same method, perhaps with additional params, not menu.open().
This method may be overridden by components needing to do things like the following:
- Customize the launcher or position passed to _OpenContextMenu(). See that method for guidance on these customizations.
- Customize the menu contents. E.g. some components need to enable/disable built-in commands like Cut and Paste, based on state at launch time.
- Bail out in some cases. E.g. components with UX approval to use PressHoldRelease rather than Press & Hold can override this method
to say
if (eventType !== "touch") this._OpenContextMenu(event, eventType);
. When those components detect the alternate context menu gesture (e.g. PressHoldRelease), that separate listener should call this._OpenContextMenu(), not this method (_NotifyContextMenuGesture()
), and not menu.open().
Components needing to do per-launch setup like the above tasks should do so in an override of this method, not in a beforeOpen listener or an _OpenContextMenu() override. This is discussed more fully here.
Parameters:
Name Type Description menu
Object The JET Menu to open as a context menu. Always non- null
.event
Event What triggered the menu launch. Always non- null
.eventType
string "mouse", "touch", or "keyboard". Never null
.- Inherited From:
- Source:
-
<protected> _NotifyDetached()
-
Notifies the component that its subtree has been removed from the document programmatically after the component has been created.
- Inherited From:
- Source:
-
<protected> _NotifyHidden()
-
Notifies the component that its subtree has been made hidden programmatically after the component has been created.
- Inherited From:
- Source:
-
<protected> _NotifyShown()
-
Notifies the component that its subtree has been made visible programmatically after the component has been created.
- Inherited From:
- Source:
-
<protected> _OpenContextMenu(event, eventType, openOptions, submenuOpenOptions, shallow)
-
The only correct way for a component to open its context menu is by calling this method, not by calling Menu.open() or _NotifyContextMenuGesture(). This method should be called in two cases:
- This method is called by _NotifyContextMenuGesture() and its overrides. That method is called when the baseComponent detects the default context menu gestures: right-click, Press & Hold, and Shift-F10.
- Components with UX-approved support for alternate context menu gestures like PressHoldRelease should call this method directly when those gestures are detected.
Components needing to customize how the context menu is launched, or do any per-launch setup, should do so in the caller of this method, (which is one of the two callers listed above), often by customizing the params passed to this method (
_OpenContextMenu
) per the guidance below. This setup should not be done in the following ways:- Components should not perform setup in a beforeOpen listener, as this can cause a race
condition where behavior depends on who got their listener registered first: the component or the app. The only correct component use
of a
beforeOpen
listener is when there's a need to detect whether something else launched the menu. - Components should not override this method (
_OpenContextMenu
), as this method is final. Instead, customize the params that are passed to it.
Guidance on setting OpenOptions fields:
Launcher:
Depending on individual component needs, any focusable element within the component can be the appropriate launcher for this launch.
Browser focus returns to the launcher on menu dismissal, so the launcher must at least be focusable. Typically a tabbable (not just focusable) element is safer, since it just focuses something the user could have focused on their own.
By default (i.e. if
openOptions
is not passed, or if it lacks alauncher
field), the component init node is used as the launcher for this launch. If that is not focusable or is suboptimal for a given component, that component should pass something else. E.g. components with a "roving tabstop" (like Toolbar) should typically choose the current tabstop as their launcher.The :focusable and :tabbable selectors may come in handy for choosing a launcher, e.g. something like
this.widget().find(".my-class:tabbable").first()
.Position:
By default, this method applies positioning that differs from Menu's default in the following ways: (The specific settings are subject to change.)
- For mouse and touch events, the menu is positioned relative to the event, not the launcher.
- For touch events,
"my"
is set to"start>40 center"
, to avoid having the context menu obscured by the user's finger.
Usually, if
position
needs to be customized at all, the only thing that needs changing is its"of"
field, and only for keyboard launches (since mouse/touch launches should almost certainly keep the default"event"
positioning). This situation arises anytime the element relative to which the menu should be positioned for keyboard launches is different than thelauncher
element (the element to which focus should be returned upon dismissal). For this case,{ "position": {"of": eventType==="keyboard" ? someElement : "event"} }
can be passed as theopenOptions
param.Be careful not to clobber useful defaults by specifying too much. E.g. if you only want to customize
"of"
, don't pass other fields like"my"
, since your value will be used for all modalities (mouse, touch, keyboard), replacing the modality-specific defaults that are usually correct. Likewise, don't forget theeventType==="keyboard"
check if you only want to customize"of"
for keyboard launches.InitialFocus:
This method forces initialFocus to
"menu"
for this launch, so the caller needn't specify it.Parameters:
Name Type Argument Description event
Event What triggered the context menu launch. Must be non- null
.eventType
string "mouse", "touch", or "keyboard". Must be non- null
. Passed explicitly since caller knows what it's listening for, and since events likecontextmenu
andclick
can be generated by various input modalities, making it potentially error-prone for this method to determine how they were generated.openOptions
Object <optional>
Options to merge with this method's defaults, which are discussed above. The result will be passed to Menu.open(). May be null
or omitted. See also theshallow
param.submenuOpenOptions
Object <optional>
Options to be passed through to Menu.open(). May be null
or omitted.shallow
boolean <optional>
Whether to perform a deep or shallow merge of openOptions
with this method's default value. The default and most commonly correct / useful value isfalse
.- If
true
, a shallow merge is performed, meaning that the caller'sposition
object, if passed, will completely replace this method's defaultposition
object. - If
false
or omitted, a deep merge is performed. For example, if the caller wishes to tweakposition.of
while keeping this method's defaults forposition.my
,position.at
, etc., it can pass{"of": anOfValue}
as theposition
value.
The
shallow
param is n/a forsubmenuOpenOptions
, since this method doesn't apply any defaults to that. (It's a direct pass-through.)- Inherited From:
- Source:
-
<protected> _RestoreAllAttributes()
-
Restores all the element's attributes which were saved in _SaveAllAttributes. This method is final in JET.
If a subclass wants to save/restore all attributes on create/destroy, then the subclass can override _SaveAttributes and call _SaveAllAttributes and also override _RestoreAttributes and call _RestoreAllAttributes.
- Inherited From:
- Source:
-
<protected> _RestoreAttributes()
-
Restore the attributes saved in _SaveAttributes.
_SaveAttributes is called during _create. And _RestoreAttributes is called during _destroy.
This base class default implementation does nothing.
We also have _SaveAllAttributes and _RestoreAllAttributes methods that save and restore all the attributes on an element. Component subclasses can opt into these _SaveAllAttributes/_RestoreAllAttributes implementations by overriding _SaveAttributes and _RestoreAttributes to call _SaveAllAttributes/_RestoreAllAttributes. If the subclass wants a different implementation (like save only the 'class' attribute), it can provide the implementation itself in _SaveAttributes/_GetSavedAttributes/_RestoreAttributes.
- Inherited From:
- Source:
-
<protected> _SaveAllAttributes(element)
-
Saves all the element's attributes within an internal variable. _RestoreAllAttributes will restore the attributes from this internal variable.
This method is final in JET. Subclasses can override _RestoreAttributes and call _RestoreAllAttributes.
The JSON variable will be held as:
[ { "element" : element[i], "attributes" : { attributes[m]["name"] : {"attr": attributes[m]["value"], "prop": $(element[i]).prop(attributes[m]["name"]) } } ]
Parameters:
Name Type Description element
Object jQuery selection to save attributes for - Inherited From:
- Source:
-
<protected> _SaveAttributes(element)
-
Saves the element's attributes. This is called during _create. _RestoreAttributes will restore all these attributes and is called during _destroy.
This base class default implementation does nothing.
We also have _SaveAllAttributes and _RestoreAllAttributes methods that save and restore all the attributes on an element. Component subclasses can opt into these _SaveAllAttributes/_RestoreAllAttributes implementations by overriding _SaveAttributes and _RestoreAttributes to call _SaveAllAttributes/_RestoreAllAttributes. If the subclass wants a different implementation (like save only the 'class' attribute), it can provide the implementation itself in _SaveAttributes/_RestoreAttributes.
Parameters:
Name Type Description element
Object jQuery selection to save attributes for - Inherited From:
- Source:
-
<protected> _SetRootAttributes()
-
Reads the
rootAttributes
option, and sets the root attributes on the component's root DOM element. See rootAttributes for the set of supported attributes and how they are handled.- Inherited From:
- Source:
Throws:
if unsupported attributes are supplied. -
<protected> _UnregisterChildNode()
-
Remove all listener references that were attached to the element.
- Inherited From:
- Source: