Element: <oj-toolbar>

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:
  • 0.6

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 Toolbar

Description: Themeable, WAI-ARIA-compliant toolbar element.

<oj-toolbar id="myToolbar">
    <oj-button id="myButton">
         <span>My Button</span>
    </oj-button>
</oj-toolbar>

The JET Toolbar can contain JET Buttons, JET Menu Buttons, JET Buttonsets, and non-focusable content such as separator icons. Toolbar provides WAI-ARIA-compliant focus management.

A toolbar that contains radios should contain all radios in the radio group.

Touch End User Information

All Toolbar touch interaction is with the individual buttons. See the JET Button touch gesture doc.

Keyboard End User Information

JET Toolbar is a single tabstop, with arrow-key navigation within the toolbar, as follows:

Key Action
LeftArrow Navigate to the previous enabled button on the left, wrapping around at the end.
RightArrow Navigate to the next enabled button on the right, wrapping around at the end.

See also the JET Button keyboard doc, for details on interacting with the individual buttons.

Keyboard Application Developer Information

Any buttonsets placed in the toolbar should have focusManagement set to "none", so as not to compete with the toolbar's focus management.

The application should not do anything to interfere with the Toolbar's focus management, such as setting the tabindex of the buttons. Also, enabled buttons should remain user-visible, without which arrow-key navigation to the button would cause the focus to seemingly disappear.

Accessibility

JET Toolbar takes care of focus management, as noted above.

As shown in the online demos, the application is responsible for applying aria-label and/or aria-controls attributes to the toolbar element, if applicable per the instructions that follow:

If this toolbar is (or might be) placed in context with other toolbars, then the application should apply an aria-label to the toolbar element to distinguish it, e.g. an "Edit" toolbar. The aria-label is optional when there is only one toolbar.

If the toolbar is controlling something else on the page, e.g. bold / italic / underline buttons controlling a rich text editor, then the application should apply an aria-controls attribute to the toolbar element, e.g. aria-controls="myTextEditor".

See the Styling section for information on how to create accessible toolbar separators.

Disabled content: JET supports an accessible luminosity contrast ratio, as specified in WCAG 2.0 - Section 1.4.3 "Contrast", in the themes that are accessible. (See the "Theming" chapter of the JET Developer Guide for more information on which themes are accessible.) Note that Section 1.4.3 says that text or images of text that are part of an inactive user interface component have no contrast requirement. Because disabled content may not meet the minimum contrast ratio required of enabled content, it cannot be used to convey meaningful information.

Styling

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

Class Description Example
oj-toolbar-separator Separators should be placed around any buttonsets in the toolbar, and anywhere else in the toolbar that a separator is desirable. For accessibility, additionally apply role and aria-orientation as shown.
<oj-toolbar id="myToolbar" aria-label="Foo" aria-controls="bar">
  <oj-button ...></oj-button>
  <span role="separator" aria-orientation="vertical"
        class="oj-toolbar-separator"></span>
  <oj-button ...></oj-button>
</oj-toolbar>
oj-toolbar-top-border Applies a top border to the toolbar, or to the oj-toolbars element, in themes not having this border by default.
<!-- These classes can be mixed and matched, and can also be applied to the 
     oj-toolbars element seen in the next example. -->
<oj-toolbar id="myToolbar" aria-label="Foo" aria-controls="bar"
     class="oj-toolbar-top-border oj-toolbar-bottom-border oj-toolbar-no-chrome">
  <!-- toolbar contents -->
</oj-toolbar>
oj-toolbar-bottom-border Applies a bottom border to the toolbar, or to the oj-toolbars element, in themes not having this border by default.
oj-toolbar-no-chrome Removes "chrome" (background and border) from the toolbar(s), in themes having this chrome by default.
oj-toolbars An outer element representing a multiple toolbar layout. Contains one or more oj-toolbar-row elements.
<div class="oj-toolbars">
  <div class="oj-toolbar-row">
    <oj-toolbar id="toolbar1" ...>...</oj-toolbar>
    <oj-toolbar id="toolbar2" ...>...</oj-toolbar>
  </div>
  <div class="oj-toolbar-row">
    <oj-toolbar id="toolbar3" ...>...</oj-toolbar>
  </div>
</div>
oj-toolbar-row Each oj-toolbar-row element is a row containing one or more toolbars. These rows go inside an oj-toolbars element.

Reading direction

The only supported way to set the reading direction (LTR or RTL) is to set the "dir" attribute on the <html> element of the page. As with any JET component, in the unusual case that the reading direction is changed post-create, the toolbar must be refresh()ed, or the page must be reloaded.

Declarative Binding

For elements like Toolbar and Menu that contain a number of like items, applications may wish to use a foreach Knockout binding to stamp out the contents. This binding cannot live on the same node as the JET ojComponent binding, and must instead live on a nested virtual element as follows:

<oj-toolbar id="myToolbar">
    <!-- ko foreach: myButtons -->
        <oj-button data-bind="attr: {id: id, label: label}">
        </oj-buton>
    <!-- /ko -->
</oj-toolbar>

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

chroming :string

Indicates in what states the toolbar's buttons and buttonsets have chrome (background and border).

This option only affects buttons and buttonsets that have never had their own chroming option set. This allows individual buttons and buttonsets to opt out of their toolbar's chroming if needed.

The default chroming varies by theme. Each theme can set its default by setting $toolbarChromingOptionDefault as seen in the example below.

Once a value has been set on this option, that value applies regardless of theme.

Supported Values:
<oj-toolbar chroming='half'></oj-toolbar>
Name Type Description
"full" string In typical themes, full-chrome buttons always have chrome.
"half" string In typical themes, half-chrome buttons acquire chrome only in their hover, active, and selected states. Half-chroming is recommended for buttons in a toolbar. (This is the toolbar default in most themes.)
"outlined" string In typical themes, outlined buttons are similar to half-chrome buttons, but have a border in the default state. * @example
Initialize the Toolbar with the chroming attribute specified:
Since:
  • 1.2.0
Names
Item Name
Property chroming
Property change event chromingChanged
Property change listener attribute (must be of type function) on-chroming-changed
Examples

Get or set the chroming property after initialization:

// getter
var chromingValue = myToolbar.chroming;

// setter
myToolbar.chroming = 'half';

Set the default in the theme (SCSS) :

$toolbarChromingOptionDefault: half !default;

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

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()

Refreshes the toolbar, including the following:
  • Re-applies focus management / keyboard navigation.
  • Rechecks the reading direction (LTR vs. RTL).

A refresh() is required in the following circumstances:

  • After buttons or buttonsets are added to, removed from, or reordered within the toolbar.
  • After a change to the disabled status of any of the buttons in the toolbar.
  • After a programmatic change to the checked status of a radio button in the toolbar (which should be done via Buttonset's checked option). This applies only to radios, not to checkboxes or push buttons.
  • After the reading direction (LTR vs. RTL) changes.

Example

Invoke the refresh method:

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