Class: AllKeySetImpl

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

Signature:

class AllKeySetImpl<K>

QuickNav


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

AllKeySetImpl

Version:
  • 7.1.0
Since:
  • 7.0.0
Module:
  • ojkeyset

Module usage

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

Javascript Import Format
define(['ojs/ojkeyset'], function(AllKeySetImpl) {
 // Application should call API on AllKeySetImpl 
})
Typescript Import Format
//To import this class, use the format below.
import {AllKeySetImpl} 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.

Description

The AllKeySetImpl class represents a set with all keys.

Constructor

new AllKeySetImpl()

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 that represents a set with all keys. Use this KeySet when select or expand all keys.

Methods

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

Returns a new KeySet with the specified keys included in the set. Specifically, the specified keys will be deleted from the currently excluded 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
AllKeySetImpl

addAll(): AllKeySetImpl<K>

Returns a new KeySet that represents a set with all keys. If this KeySet already is a set with all keys, then this would just return itself.
Returns:
a new KeySet that represents a set with all keys.
Type
AllKeySetImpl

clear(): KeySetImpl<K>

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

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

Returns a new KeySet based on this set with the specified keys deleted. Specifically, the returned KeySet represents all keys except for the keys deleted. 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
AllKeySetImpl

deletedValues() → {Set<K>}

Returns a set of keys of the items that are excluded from this set.
Returns:
the keys of the deleted items.
Type
Set<K>

has(key) → {boolean}

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

isAddAll() → {boolean}

Determines whether this is a set that represents all keys.
Returns:
true if this is a set that reprsents all keys, false otherwise.
Type
boolean