Element: <oj-buttonset-many>

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. This is documented under the "Default" heading below.

Default

The <oj-buttonset-many> element accepts oj-options as children. See the oj-option doc for details about accepted children and slots.

Example

Initialize the Buttonset with child content specified:

<oj-buttonset-many>
  <oj-option value="myValue">myValue</span>
</oj-buttonset-many>

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 buttonset's buttons have chrome (background and border).

A buttonset's chroming must be set by setting this buttonset attribute (or setting the chroming attribute of a containing toolbar).

The default chroming varies by theme and containership as follows:

• If the buttonset is in a toolbar, then the default chroming is the current value of the toolbar's chroming attribute.
• Else, if $buttonsetChromingOptionDefault is set in the current theme as seen in the example below, then that value is the chroming default.
• Else, the default chroming is "full".

Once a value has been set on this buttonset attribute, that value applies regardless of theme and containership.

Supported Values:

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.

Names

Item	Name
Property	chroming
Property change event	chromingChanged
Property change listener attribute (must be of type function)	on-chroming-changed

Examples

Initialize the Buttonset with the chroming attribute specified:

<oj-buttonset-many chroming='half'></oj-buttonset-many>

Get or set the chroming property after initialization:

// getter
var chromingValue = myButtonset.chroming;

// setter
myButtonset.chroming = 'half';

Set the default in the theme (SCSS) :

$buttonsetChromingOptionDefault: half !default;

disabled :boolean

Setting the Buttonset's disabled attribute effectively disables all its Buttons, without affecting their disabled attributes. Thus, a Button is effectively disabled if either its own disabled attribute is set, or the Buttonset's disabled attribute is set.

Default Value:

• false

Names

Item	Name
Property	disabled
Property change event	disabledChanged
Property change listener attribute (must be of type function)	on-disabled-changed

Examples

Initialize the Buttonset with the disabled attribute specified:

<oj-buttonset-many disabled='true'></oj-buttonset-many>

Get or set the disabled property after initialization:

// getter
var disabledValue = myButtonset.disabled;

// setter
myButtonset.disabled = true;

display :string

Whether to display both the label and icons ("all") or just the icons ("icons") of the buttons. In the latter case, the label is displayed in a tooltip instead.

The display attribute will be ignored if no icons exist in the button.

Supported Values:

Name	Type	Description
"all"	string	Display both the label and icons.
"icons"	string	Display only the icons.

Default Value:

• "all"

Names

Item	Name
Property	display
Property change event	displayChanged
Property change listener attribute (must be of type function)	on-display-changed

Examples

Initialize the Buttonset with the display attribute specified:

<oj-buttonset-many display='icons'></oj-buttonset-many>

Get or set the display property after initialization:

// getter
var displayValue = myButtonset.display;

// setter
myButtonset.display = 'icons';

focus-management :string

The focusManagement attribute should be set to "none" when the Buttonset is placed in a JET Toolbar. This allows the Toolbar to manage the focus with no interference from the Buttonset, so that arrow keys move within the entire Toolbar, not just within the Buttonset.

Supported Values:

Name	Type	Description
"none"	string	Focus management is disabled, to avoid interfering with the focus management of a containing component.
"oneTabstop"	string	Focus management is enabled. The Buttonset is a single tabstop with arrow-key navigation.

Default Value:

• "oneTabstop"

Names

Item	Name
Property	focusManagement
Property change event	focusManagementChanged
Property change listener attribute (must be of type function)	on-focus-management-changed

Examples

Initialize the Buttonset with the focusManagement attribute specified:

<oj-buttonset-many focus-management='none'></oj-buttonset-many>

Get or set the focusManagement property after initialization:

// getter
var focusManagementValue = myButtonset.focusManagement;

// setter
myButtonset.focusManagement = 'none';

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

value :Array.<any>|null

The value attribute indicates which oj-options in the Buttonset are selected. It corresponds to the value attribute of those elements, which should always be set. value is a possibly empty, non-null string array containing the value attributes of the selected oj-options. This array has "set", not "list", semantics; i.e. order is neither important nor guaranteed. Thus, an n-oj-option set has 2^n valid value values: the 2^n possible subsets of n oj-options.

In all other cases, value is null.

It's still possible for the value attribute and DOM to get out of sync by other means. In this case, the app is responsible for updating the value attribute. A typical case is when the set of Buttons contained in the Buttonset changes, possibly due to a Knockout binding, in which case the app must first call refresh (as in all cases when the DOM changes underneath a component), and then update the value attribute to the desired value.

Often there is no need to listen for this event, since the value binding, discussed above, will update the bound observable whenever the value state changes. The declarative binding is often preferable to an explicit listener.

A click listener should not be used to detect changes to the value state. The attribute value binding and/or the valueChange event should be used instead.

Default Value:

• null

Supports writeback:

• true

Names

Item	Name
Property	value
Property change event	valueChanged
Property change listener attribute (must be of type function)	on-value-changed

Examples

Initialize the Buttonset with the value attribute specified:

<oj-buttonset-many value='{{["bold", "italic"]}}'></oj-buttonset-many>

Get or set the value property after initialization:

// Get one (if many)
var value = myButtonset.value[0];

// Get all
var values = myButtonset.value;

// Set one.  (If many. No property change event will be fired.)
myButtonset.value[1] = 'bold';

// Set all.
myButtonset.value = ["bold", "italic"];

Methods

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

refresh() → {void}

Refreshes the component.

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