Element: <oj-indexer>

Oracle® JavaScript Extension Toolkit (JET)
17.1.0
G12196-01

Since:
  • 1.2.0
Module:
  • ojindexer

QuickNav

Slots

Attributes

Methods

Other Topics


JET Indexer Component

Description: The JET Indexer is usually associated with a scrollable JET ListView. It provides a list of sections that corresponds to group headers in ListView. When a section is selected the corresponding group header will be scroll to the top of the ListView. 


<oj-indexer
  aria-controls='listview1'
  data='{{data}}'>
</oj-indexer>

Touch End User Information

Target Gesture Action
Characters Tap Selects the character in the indexer, which scrolls to the corresponding group header in the associated ListView. When tap on the ellipsis character, the character in between will be selected.
Characters Pan Selects the character in the indexer, which scrolls to the corresponding group header in the associated ListView. When pan up and down the ellipsis character, the indexer will select the range of characters represented by the ellipsis.

Keyboard End User Information

Target Key Action
Section DownArrow Move focus to the section below.
UpArrow Move focus to the section above.
Enter Selects the current section. No op if the section is already selected.

Accessibility

The JET Indexer is accessible - it sets and maintains the appropriate aria- attributes, including aria-valuenow, aria-valuemax, aria-valuemin and aria-orientation.

Application developer should associate a ListView with the Indexer by specifying the id of the ListView in the aria-controls attribute in the Indexer.


Usage

Signature:

interface IndexerElement

Typescript Import Format
//To typecheck the element APIs, import as below.
import { IndexerElement } from "ojs/ojindexer";

//For the transpiled javascript to load the element's module, import as below
import "ojs/ojindexer";

For additional information visit:

Note: Application logic should not interact with the component's properties or invoke its methods until the BusyContext indicates that the component is ready for interaction.


Styling

CSS Variables

See JET CSS Variables for additional details.
Name Type Description
--oj-indexer-text-color <color> Indexer text color
--oj-indexer-font-size <length> Indexer font size

Slots

JET components that allow child content support slots. Please see the slots section of the JET component overview doc for more information on allowed slot content and slot types.

contextMenu

The contextMenu slot is set on the oj-menu within this element. This is used to designate the JET Menu that this 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 JET Menu specified in this slot.

The application can register a listener for the Menu's ojBeforeOpen event. The listener can cancel the launch via event.preventDefault(), or it can customize the menu contents by editing the menu DOM directly, and then calling refresh() on the Menu.

To help determine whether it's appropriate to cancel the launch or customize the menu, the ojBeforeOpen listener can use component API's to determine which table cell, chart item, etc., is the target of the context menu. See the JSDoc of the individual components for details.

Keep in mind that any such logic must work whether the context menu was launched via right-click, Shift-F10, Press & Hold, or component-specific touch gesture.

Deprecated:
Since Description
13.0.0 This web component no longer supports launching a context menu.

Attributes

data :IndexerModel

The data model for the Indexer which must be a oj.IndexerModel. Currently the IndexerModelTreeDataProvider is available that applications can use as the data for both ListView and the Indexer. If not specified, then an empty indexer is rendered.
Default Value:
  • null
Names
Item Name
Property data
Property change event dataChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-data-changed

translations :object|null

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 the component does not contain any translatable resource, the default value of this attribute will be null. If not, an object containing all resources relevant to the component.

If this component has translations, their documentation immediately follows this doc entry.

Names
Item Name
Property translations
Property change event translationsChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-translations-changed

translations.aria-disabled-label :string

Provides properties to customize the text to read to the screen reader when there is no matching group header.

Since:
  • 1.2.0
Names
Item Name
Property translations.ariaDisabledLabel

translations.aria-in-between-text :string

Provides properties to customize the text that represents between two characters in the Indexer.

Since:
  • 1.2.0
Names
Item Name
Property translations.ariaInBetweenText

translations.aria-keyboard-instruction-text :string

Provides properties to customize the screen reader keyboard instructional text for the Indexer.

Since:
  • 1.2.0
Names
Item Name
Property translations.ariaKeyboardInstructionText

translations.aria-others-label :string

Provides properties to customize the text to read to the screen reader when the non-letter characters is selected.

Since:
  • 1.2.0
Names
Item Name
Property translations.ariaOthersLabel

translations.aria-touch-instruction-text :string

Provides properties to customize the screen reader touch instructional text for the Indexer.

Since:
  • 1.2.0
Names
Item Name
Property translations.ariaTouchInstructionText

translations.indexer-characters :string

Provides properties to customize the characters to display in the Indexer.

Since:
  • 3.0.0
Names
Item Name
Property translations.indexerCharacters

translations.indexer-others :string

Provides properties to customize the non-letter characters to display in the Indexer.

Since:
  • 1.2.0
Names
Item Name
Property translations.indexerOthers

Methods

getProperty(property) : {any}

Retrieves the value of a property or a subproperty. The return type will be the same as the type of the property as specified in this API document. If the method is invoked with an incorrect property/subproperty name, it returns undefined.
Parameters:
Name Type Description
property string The property name to get. Supports dot notation for subproperty access.
Since:
  • 4.0.0
Returns:
Type
any
Example

Get a single subproperty of a complex property:

let subpropValue = myComponent.getProperty('complexProperty.subProperty1.subProperty2');

refresh : {void}

Redraw the entire indexer after having made some external modification.

This method does not accept any arguments.

Returns:
Type
void

setProperties(properties) : {void}

Performs a batch set of properties. The type of value for each property being set must match the type of the property as specified in this API document.
Parameters:
Name Type Description
properties Object An object containing the property and value pairs to set.
Since:
  • 4.0.0
Returns:
Type
void
Example

Set a batch of properties:

myComponent.setProperties({"prop1": "value1", "prop2.subprop": "value2", "prop3": "value3"});

setProperty(property, value) : {void}

Sets a property or a subproperty (of a complex property) and notifies the component of the change, triggering a [property]Changed event. The value should be of the same type as the type of the attribute mentioned in this API document.
Parameters:
Name Type Description
property string The property name to set. Supports dot notation for subproperty access.
value any The new value to set the property to.
Since:
  • 4.0.0
Returns:
Type
void
Example

Set a single subproperty of a complex property:

myComponent.setProperty('complexProperty.subProperty1.subProperty2', "someValue");