Class: ExpandedKeySet

Oracle® JavaScript Extension Toolkit (JET)
5.0.0

E90577-01

QuickNav

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

ExpandedKeySet extends KeySet

Version:
  • 5.0.0
Since:
  • 4.1.0
Module:
  • ojkeyset
The ExpandedKeySet class contains a set of keys of the expanded items.

Constructor

new ExpandedKeySet(keys)

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

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 | Array <optional>
A set of keys to initialize this KeySet with.
Example

Creates a new ExpandedKeySet with an initial set of keys to expand:

require(['ojs/ojkeyset'], 
  function(keySet) {
    var expandedKeySet = new keySet.ExpandedKeySet(['group1', 'group3']);
  }
); 

Methods

add(keys) → {ExpandedKeySet}

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}

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}

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) → {ExpandedKeySet}

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 * 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}

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