Element: <oj-train>

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

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

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.

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

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`

Examples

Initialize the Train with the selected-step attribute specified

<oj-train selected-step='{{selectedStepValue}}'></oj-train>

Get or set the selectedStep property after initialization

//Get train selected step
var selectedStep = myTrain.selectedStep;

//Set train selected step
myTrain.selectedStep = 'stp1';

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`

Examples

Initialize the Train with the steps attribute specified

<oj-train steps='[{"id":"id1", "label":"Label 1"}, {"id":"id2", "label":"Label 2", "disabled": false, "visited": true, "messageType":"info"}]'></oj-train>

Get or set the steps property after initialization

//Get one
var step = myTrain.steps[0];

//Get all
var steps = myTrain.steps;

//Set all.  Must list every resource key, as those not listed are lost.
myTrain.steps = [{
     'id':'id1',
     'label': 'Label 1'},
    {'id':'id2',
     'label': 'Label 2',
     "disabled": false,
     "visited": true,
     "messageType":"info"}];

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`

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

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.

Examples

Specify an ojBeforeDeselect listener via the DOM attribute:

<oj-train on-oj-before-deselect='[[listener]]'></oj-train>

Specify an ojBeforeDeselect listener via the JavaScript property:

myTrain.onOjBeforeDeselect = listener;

Add an ojBeforeDeselect listener via the addEventListener API:

myTrain.addEventListener('ojBeforeDeselect', listener);

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.

Examples

Specify an ojBeforeSelect listener via the DOM attribute:

<oj-train on-oj-before-select='[[listener]]'></oj-train>

Specify an ojBeforeSelect listener via the JavaScript property:

myTrain.onOjBeforeSelect = listener;

Add an ojBeforeSelect listener via the addEventListener API:

myTrain.addEventListener('ojBeforeSelect', listener);

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.

Examples

Specify an ojDeselect listener via the DOM attribute:

<oj-train on-oj-deselect='[[listener]]'></oj-train>

Specify an ojDeselect listener via the JavaScript property:

myTrain.onOjDeselect = listener;

Add an ojDeselect listener via the addEventListener API:

myTrain.addEventListener('ojDeselect', listener);

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.

Examples

Specify an ojSelect listener via the DOM attribute:

<oj-train on-oj-select='[[listener]]'></oj-train>

Specify an ojSelect listener via the JavaScript property:

myTrain.onOjSelect = listener;

Add an ojSelect listener via the addEventListener API:

myTrain.addEventListener('ojSelect', listener);

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

Since:

4.0.0

Returns:

Type: any

Example

Get a single subproperty of a complex property:

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

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 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`	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		string id of the step
`label`	string		string label of the step
`disabled`	boolean	<optional>	boolean indicates whether the step is disabled
`visited`	boolean	<optional>	boolean indicates whether the step has been visited
`messageType`	"info" \| "error" \| "fatal" \| "warning"	<optional>	string the type of message icon displayed on the step