Final Class: ExpandAllKeySet

Oracle® JavaScript Extension Toolkit (JET)
8.1.0

F24337-01

Signature:

final class ExpandAllKeySet<K>

QuickNav


ExpandAllKeySet

Version:
  • 8.1.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(ExpandAllKeySet) {
 // Application should call API on ExpandAllKeySet 
})
Typescript Import Format
//To import this class, use the format below.
import {ExpandAllKeySet} 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 ExpandAllKeySet class represents a set with all keys expanded.
Deprecated:
Since Description
7.0.0 Use AllKeySetImpl instead.

Constructor

new ExpandAllKeySet()

Create a new immutable KeySet containing the keys of the collapsed items. Use this KeySet when expanding all keys.
Deprecated:
Since Description
7.0.0 Use AllKeySetImpl instead.

Methods

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

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<K>

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<K>

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

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

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

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

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