Element: <oj-indexer>

Oracle® JavaScript Extension Toolkit (JET)
4.2.0

E91398-01

QuickNav

Attributes

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Version:
  • 4.2.0
Since:
  • 1.2.0

JET Custom Elements

JET components are implemented as custom HTML elements. A detailed description of working with these elements can be found in: JET Custom Element Usage.

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.

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.

Slots

JET elements can have up to two types of child content:

  • Any child element with a slot attribute will be moved into that named slot, e.g. <span slot='startIcon'>...</span>. All supported named slots are documented below. Child elements with unsupported named slots will be removed from the DOM.
  • Any child element lacking a slot attribute will be moved to the default slot, also known as a regular child.

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 and demos 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.

Example

Initialize the component with a context menu:

<oj-some-element>
    <-- use the contextMenu slot to designate this as the context menu for this component -->
    <oj-menu slot="contextMenu" style="display:none" aria-label="Some element's context menu">
...
    </oj-menu>
</oj-some-element>

Attributes

data :oj.IndexerModel

The data model for the Indexer which must be a oj.IndexerModel. Currently this option can only be set to the return value of the getIndexerModel method on the ListView instance. The data attribute should always be specified. 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) on-data-changed
Examples

Initialize the Indexer with an IndexModel:

<oj-indexer data='{{myIndexerModel}}'></oj-indexer>

Get or set the data property after initialization:

// getter
var dataValue = myIndexer.data;

// setter
myIndexer.data = myIndexerModel;

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 translations, their documentation immediately follows this doc entry.

Default Value:
  • an object containing all resources relevant to the component, or null if none
Names
Item Name
Property translations
Property change event translationsChanged
Property change listener attribute (must be of type function) on-translations-changed
Examples

Initialize the component, overriding some translated resources and leaving the others intact:

<!-- Using dot notation -->
<oj-some-element translations.some-key='some value' translations.some-other-key='some other value'></oj-some-element>

<!-- Using JSON notation -->
<oj-some-element translations='{"someKey":"some value", "someOtherKey":"some other value"}'></oj-some-element>

Get or set the translations property after initialization:

// Get one
var value = myComponent.translations.someKey;

// Set one, leaving the others intact. Always use the setProperty API for 
// subproperties rather than setting a subproperty directly.
myComponent.setProperty('translations.someKey', 'some value');

// Get all
var values = myComponent.translations;

// Set all.  Must list every resource key, as those not listed are lost.
myComponent.translations = {
    someKey: 'some value',
    someOtherKey: 'some other value'
};

translations.aria-disabled-label :Object

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 :Object

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 :Object

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

Since:
  • 1.2.0
Names
Item Name
Property translations.ariaKeyboardInstructionText

translations.aria-others-label :Object

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 :Object

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

Since:
  • 1.2.0
Names
Item Name
Property translations.ariaTouchInstructionText

translations.indexer-characters :Object

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

Since:
  • 3.0.0
Names
Item Name
Property translations.indexerCharacters

translations.indexer-others :Object

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) → {*}

Retrieves a value for a property or a single subproperty for complex properties.
Parameters:
Name Type Description
property string The property name to get. Supports dot notation for subproperty access.
Returns:
Type
*
Example

Get a single subproperty of a complex property:

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

#refresh()

Redraw the entire indexer after having made some external modification.

This method does not accept any arguments.

Example

Invoke the refresh method:

$( ".selector" ).ojIndexer( "refresh" );

setProperties(properties)

Performs a batch set of properties.
Parameters:
Name Type Description
properties Object An object containing the property and value pairs to set.
Example

Set a batch of properties:

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

setProperty(property, value)

Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a [property]Changed event.
Parameters:
Name Type Description
property string The property name to set. Supports dot notation for subproperty access.
value * The new value to set the property to.
Example

Set a single subproperty of a complex property:

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