Element: <oj-row-expander>

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.0.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 RowExpander

Description: A JET RowExpander is primarily used inside the JET Table and JET DataGrid. It enables hierarchical data to be display in a JET Table and JET DataGrid.

To enable expand and collapse of rows, developers must specify oj.FlattenedTreeTableDataSource as data when used within JET Table and oj.FlattenedTreeDataGridDataSource as data when used within JET DataGrid.

<oj-row-expander
  context='{{$context}}'>
</oj-row-expander>

Touch End User Information

Target Gesture Action
Icon Tap Expand or collapse the row with the icon in it.

Keyboard End User Information

Target Key Action
Focused Row or Cell with RowExpander Ctrl + RightArrow Expand
Ctrl + LeftArrow Collapse
Icon Enter Expand or Collapse

Reading direction

The location of the RowExpander will be reversed in RTL reading direction.

In the unusual case that the directionality (LTR or RTL) changes post-init, the component containing the RowExpander (JET Table or JET DataGrid) must be refresh()ed.

Performance

Initial expansion

To specify initial expanded rows with RowExpander, it is recommended that applications do this through the initial options in oj.FlattenedTreeDataSource, especially for expanding all rows initially.

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

context :Object

The context object obtained from the column renderer (Table) or cell renderer (DataGrid)
Default Value:
  • null
Names
Item Name
Property context
Property change event contextChanged
Property change listener attribute (must be of type function) on-context-changed

expanded :boolean|null

Specifies if the RowExpander is expanded. The default value is determined by the context obtained from the column renderer (Table) or cell renderer (DataGrid), or null if no context is specified. See performance for recommended usage regarding initial expansion state.
Default Value:
  • null
Supports writeback:
  • true
Names
Item Name
Property expanded
Property change event expandedChanged
Property change listener attribute (must be of type function) on-expanded-changed
Examples

Initialize the RowExpander with the expanded attribute specified:

<oj-row-expander expanded='true'></oj-row-expander>

Get or set the expanded property after initialization:

// getter
var expandedValue = myRowExpander.expanded;

// setter
myRowExpander.expanded = false;

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.accessible-level-description :Object

Provides properties to customize the accessible context level of the expanded or collapsed row

See the translations attribute for usage examples.

Since:
  • 1.1.0
Names
Item Name
Property translations.accessibleLevelDescription

translations.accessible-row-collapsed :Object

Provides properties to customize the accessible context when a row is collapsed

See the translations attribute for usage examples.

Since:
  • 1.1.0
Names
Item Name
Property translations.accessibleRowCollapsed

translations.accessible-row-description :Object

Provides properties to customize the accessible context level and index of the row

See the translations attribute for usage examples.

Since:
  • 1.1.0
Names
Item Name
Property translations.accessibleRowDescription

translations.accessible-row-expanded :Object

Provides properties to customize the accessible context when a row is expanded

See the translations attribute for usage examples.

Since:
  • 1.1.0
Names
Item Name
Property translations.accessibleRowExpanded

translations.accessible-state-collapsed :Object

Provides properties to customize the accessible state of a collapsed row

See the translations attribute for usage examples.

Since:
  • 1.1.0
Names
Item Name
Property translations.accessibleStateCollapsed

translations.accessible-state-expanded :Object

Provides properties to customize the accessible state of an expanded row

See the translations attribute for usage examples.

Since:
  • 1.1.0
Names
Item Name
Property translations.accessibleStateExpanded

Events

ojCollapse

Triggered when a collapse is performed on the RowExpander
Properties:

All of the event payloads listed below can be found under event.detail.

Name Type Description
rowKey string the key of the collapsed row
Examples

Specify an ojCollapse listener via the DOM attribute:

<oj-row-expander on-oj-collapse='[[listener]]'></oj-row-expander>

Specify an ojCollapse listener via the JavaScript property:

myRowExpander.onOjCollapse = listener;

Add an ojCollapse listener via the addEventListener API:

myRowExpander.addEventListener('ojCollapse', listener);

ojExpand

Triggered when a expand is performed on the RowExpander
Properties:

All of the event payloads listed below can be found under event.detail.

Name Type Description
rowKey string the key of the expanded row
Examples

Specify an ojExpand listener via the DOM attribute:

<oj-row-expander on-oj-expand='[[listener]]'></oj-row-expander>

Specify an ojExpand listener via the JavaScript property:

myRowExpander.onOjExpand = listener;

Add an ojExpand listener via the addEventListener API:

myRowExpander.addEventListener('ojExpand', listener);

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 RowExpander element.

This method does not accept any arguments.

Example

Invoke the refresh method:

myRowExpander.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");