Final Class: ExpandedKeySet

Oracle® JavaScript Extension Toolkit (JET)
9.2.0

F30740-01

Signature:

final class ExpandedKeySet<K>

QuickNav

ExpandedKeySet

Version:
  • 9.2.0
Since:
  • 4.1.0
Module:
  • ojkeyset

Module usage

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

Javascript Import Format
define(['ojs/ojkeyset'], function(ExpandedKeySet) {
 // Application should call API on ExpandedKeySet 
})
Typescript Import Format
//To import this class, use the format below.
import {ExpandedKeySet} from "ojs/ojkeyset";
Generic Parameters
ParameterDescription
KType of Key

JET In Typescript

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

Final classes in JET

Classes in JET are generally final and do not support subclassing. At the moment, final is not enforced. However, this will likely change in an upcoming JET release.

Description

The ExpandedKeySet class contains a set of keys of the expanded items. See also the observable version of this class.
Deprecated:
Since Description
7.0.0 Use KeySetImpl instead.

Constructor

new ExpandedKeySet(keys)

Create a new immutable KeySet containing the keys of the expanded items. Use this KeySet when specifying individual keys to expand.
Parameters:
Name Type Argument Description
keys Set<K> | Array<K> <optional>
A set of keys to initialize this KeySet with.
Deprecated:
Since Description
7.0.0 Use KeySetImpl instead.

Methods

add(keys: Set<K>|Array<K>): ExpandedKeySet<K>

Returns a new KeySet based on this set with the specified keys included. If none of the keys specified are added then this KeySet is returned.
Parameters:
Name Type Description
keys Set | Array a set of keys to add to this KeySet.
Returns:
a new KeySet with the specified keys included.
Type
ExpandedKeySet

addAll(): ExpandAllKeySet<K>

Returns a new KeySet that signals all keys are added to this set.
Returns:
a new KeySet that signals all keys are added to this set.
Type
ExpandAllKeySet

clear(): ExpandedKeySet<K>

Returns a new KeySet containing no keys. If this KeySet already contains no keys then the current KeySet is returned.
Returns:
a new KeySet with no keys.
Type
ExpandedKeySet

delete(keys: Set<K>|Array<K>): ExpandedKeySet<K>

Returns a new KeySet based on this set with the specified keys excluded. If none of the keys specified are deleted then this KeySet is returned.
Parameters:
Name Type Description
keys Set | Array a set of keys to remove from this KeySet.
Returns:
a new KeySet with the specified keys excluded.
Type
ExpandedKeySet

has(key) : {boolean}

Returns whether the specified key is contained in this set.
Parameters:
Name Type Description
key K the key to check whether it is contained in this set.
Returns:
true if the specified key is contained in this set, false otherwise.
Type
boolean

isAddAll : {boolean}

Returns whether this set should include all keys.
Returns:
true if this set includes all keys, false otherwise.
Type
boolean

values : {Set<K>}

Returns the keys in this KeySet in the order they are added.
Returns:
the keys in this KeySet in the order they are added.
Type
Set<K>