Class: ExpandAllKeySet

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.

ExpandAllKeySet extends KeySet

Version:
  • 5.0.0
Since:
  • 4.1.0
Module:
  • ojkeyset
The ExpandAllKeySet class represents a set with all keys expanded.

Constructor

new ExpandAllKeySet()

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 collapsed items. Use this KeySet when expanding all keys.
Example

Creates a new ExpandAllKeySet to expand all keys

require(['ojs/ojkeyset'], 
  function(keySet) {
    var expandAllKeySet = new keySet.ExpandAllKeySet();
  }
); 

Methods

add(keys) → {ExpandAllKeySet}

Returns a new KeySet with the specified keys excluded from a set of collapsed keys. If the keys specified are already 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
ExpandAllKeySet

addAll() → {ExpandAllKeySet}

Returns a new KeySet that signals all keys are added to this set. If this KeySet already has all keys added, then this KeySet is returned.
Returns:
a new KeySet that signals all keys are added to this set.
Type
ExpandAllKeySet

clear() → {ExpandedKeySet}

Returns a new KeySet containing no keys.
Returns:
a new KeySet with no keys.
Type
ExpandedKeySet

delete(keys) → {ExpandAllKeySet}

Returns a new KeySet based on this set with the specified keys included in a set of collapsed keys. If the keys specified are already 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
ExpandAllKeySet

deletedValues() → {Set}

Returns a set of keys of the collapsed items.
Returns:
the keys of the collapsed items.
Type
Set

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