Element: <oj-train>

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

Signature:

class ojTrain

QuickNav

Attributes

JET Custom Elements

JET components are implemented as custom HTML elements. In addition to the component attributes documented in this page, JET components also support standard HTML global attributes like id and aria-label.

The JET data binding syntax can be used to define both component and global attributes through the use of dynamically evaluated expressions. All attributes (component and global) support attribute-level binding by prefixing the attribute name with ":" (e.g. :id="[...]"). When using attribute-level binding, all expression values are treated as strings. Additionally, component attributes support property-level binding by using the attribute name directly with no ":" prefix. When using property-level binding, the expressions should evaluate to the types documented by the corresponding attributes. Property-level binding is strongly recommended over attribute-level binding for component attributes.

A detailed description of working with custom HTML elements can be found in: JET Custom Element Usage.



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

Version:
  • 7.1.0
Since:
  • 1.0.0
Module:
  • ojtrain

Module usage

See JET Module Loading for an overview of module usage within JET.

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

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

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.


JET Train

The JET Train element is a navigation visual that allows a user to go between different "steps". Each step can display information about the state of the step("visited", "unvisited", "disabled") and display a message type("error", "confirmation", "warning", "info", "fatal")

<oj-train
  selected-step="{{currentStepValue}}"
  steps="{{stepArray}}">
</oj-train>

Touch End User Information

Target Gesture Action
Step Tap Move to the targeted step
Step Label Tap Move to the targeted step

Keyboard End User Information

Key Action
Tab Move focus to the next selectable step.
Shift+Tab Move focus to the previous selectable step.
Enter Select the focused step.

Styling

The following CSS classes can be applied by the page author as needed.

Class Description
oj-train-stretch Optional class that may be added to the train div which will stretch the train to cover the full width of the container specified.

Train step label wrapping is controlled by the $trainLabelTextWrap SASS Variable. $trainLabelTextWrap accepts css white-space values such as normal or nowrap(default).

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

Attributes

selected-step :string

Indicates the id of the current selected step. Default is the first step in the steps array.
Supports writeback:
  • true
Names
Item Name
Property selectedStep
Property change event selectedStepChanged
Property change listener attribute (must be of type function) on-selected-step-changed

steps :Array.<oj.ojTrain.Step>

The array of step objects. Each oj.ojTrain.Step must have an 'id' and 'label' property.
Names
Item Name
Property steps
Property change event stepsChanged
Property change listener attribute (must be of type function) on-steps-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) on-translations-changed

Events

ojBeforeDeselect

Triggered immediately before a step is deselected. The ojBeforeDeselect can be cancelled by calling event.preventDefault().
Properties:

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

Name Type Description
toStep string The step that is about to be deselected.
fromStep string The step that is about to be selected.

ojBeforeSelect

Triggered immediately before a step is selected. The ojBeforeSelect can be cancelled by calling event.preventDefault().
Properties:

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

Name Type Description
toStep string The step that is about to be deselected.
fromStep string The step that is about to be selected.

ojDeselect

Triggered after a step has been deselected. The ojDeselect can be cancelled by calling event.preventDefault().
Properties:

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

Name Type Description
toStep string The step that is about to be deselected.
fromStep string The step that is about to be selected.

ojSelect

Triggered after a step has been selected.
Properties:

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

Name Type Description
toStep string The step that is about to be deselected.
fromStep string The step that is about to be selected.

Methods

getNextSelectableStep() → {string|null}

Returns the id of the next selectable step based on the current selectedStep. If the current step is the last selectable step, the function returns null
Returns:
next selectable Id
Type
string | null

getPreviousSelectableStep() → {string|null}

Returns the id of the previous selectable step based on the current selectedStep. If the current step is the first selectable step, the function returns null
Returns:
previous selectable Id
Type
string | null

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');

getStep(id) → {(oj.ojTrain.Step|null)}

Returns the step based on the id passed in. If the step doesn't exist, return null.
Parameters:
Name Type Description
id string The id of the step.
Returns:
step object.
Type
(oj.ojTrain.Step|null)

refresh() → {void}

Refreshes the train.

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

updateStep(id, stepProperties) → {void}

Update the step with the specified id with the provided property bag.
Parameters:
Name Type Description
id string The id of the step to update
stepProperties Object The set of step properties to update. Will overwrite any previously set values.
Properties
Name Type Argument Description
id string <optional>
id of step
label string <optional>
label of step
disabled boolean <optional>
whether step is disabled
visited boolean <optional>
whether step has been visited
messageType "info" | "error" | "fatal" | "warning" <optional>
type of message displayed
Returns:
Type
void

Type Definitions

Step

Properties:
Name Type Argument Description
id string id of the step
label string label of the step
disabled boolean <optional>
indicates whether the step is disabled
visited boolean <optional>
indicates whether the step has been visited
messageType "info" | "error" | "fatal" | "warning" <optional>
the type of message icon displayed on the step