Dart API Referencedart:htmlStorageEvent

StorageEvent class

Describes an event occurring on HTML5 client-side storage data.
1.0
11.0
Introduced
Gecko 2.0
Inherits from: nsIDOMEvent Last changed in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

A StorageEvent is sent to a window when a storage area changes.

Gecko 2.0 note
(Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

Although this event existed prior to Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1) , it did not match the specification. The old event format is now represented by the nsIDOMStorageEventObsolete interface.

@DomName('StorageEvent')
class StorageEvent extends Event native "StorageEvent" {
 factory StorageEvent(String type,
   {bool canBubble: false, bool cancelable: false, String key, String oldValue,
   String newValue, String url, Storage storageArea}) {

   var e = document.$dom_createEvent("StorageEvent");
   e.$dom_initStorageEvent(type, canBubble, cancelable, key, oldValue,
       newValue, url, storageArea);
   return e;
 }

 @DomName('StorageEvent.key')
 @DocsEditable
 final String key;

 @DomName('StorageEvent.newValue')
 @DocsEditable
 final String newValue;

 @DomName('StorageEvent.oldValue')
 @DocsEditable
 final String oldValue;

 @DomName('StorageEvent.storageArea')
 @DocsEditable
 final Storage storageArea;

 @DomName('StorageEvent.url')
 @DocsEditable
 final String url;

 @JSName('initStorageEvent')
 @DomName('StorageEvent.initStorageEvent')
 @DocsEditable
 void $dom_initStorageEvent(String typeArg, bool canBubbleArg, bool cancelableArg, String keyArg, String oldValueArg, String newValueArg, String urlArg, Storage storageAreaArg) native;

}

Extends

Interceptor > Event > StorageEvent

Constructors

factory StorageEvent(String type, {bool canBubble: false, bool cancelable: false, String key, String oldValue, String newValue, String url, Storage storageArea}) #

factory StorageEvent(String type,
 {bool canBubble: false, bool cancelable: false, String key, String oldValue,
 String newValue, String url, Storage storageArea}) {

 var e = document.$dom_createEvent("StorageEvent");
 e.$dom_initStorageEvent(type, canBubble, cancelable, key, oldValue,
     newValue, url, storageArea);
 return e;
}

Properties

final bool bubbles #

inherited from Event
A boolean indicating whether the event bubbles up through the DOM or not.
final bool bubbles

final bool cancelable #

inherited from Event
A boolean indicating whether the event is cancelable.
final bool cancelable

bool cancelBubble #

inherited from Event
A boolean indicating whether the bubbling of the event has been canceled or not.
bool cancelBubble

final DataTransfer clipboardData #

inherited from Event
final DataTransfer clipboardData

final EventTarget currentTarget #

inherited from Event
EventTarget get currentTarget => _convertNativeToDart_EventTarget(this._get_currentTarget);

final bool defaultPrevented #

inherited from Event
Indicates whether or not event.preventDefault() has been called on the event.
final bool defaultPrevented

final int eventPhase #

inherited from Event
Indicates which phase of the event flow is being processed.
final int eventPhase

final int hashCode #

inherited from Interceptor

Get a hash code for this object.

All objects have hash codes. Hash codes are guaranteed to be the same for objects that are equal when compared using the equality operator ==. Other than that there are no guarantees about the hash codes. They will not be consistent between runs and there are no distribution guarantees.

If a subclass overrides hashCode it should override the equality operator as well to maintain consistency.

docs inherited from Object
int get hashCode => Primitives.objectHashCode(this);

final String key #

Represents the key changed. The key attribute is null when the change is caused by the storage clear() method. Read only.
final String key

final String newValue #

The new value of the key. The newValue is null when the change has been invoked by storage clear() method or the key has been removed from the storage. Read only.
final String newValue

final String oldValue #

The original value of the key. The oldValue is null when the change has been invoked by storage clear() method or the key has been newly added and therefor doesn't have any previous value. Read only.
final String oldValue

final Type runtimeType #

inherited from Interceptor

A representation of the runtime type of the object.

docs inherited from Object
Type get runtimeType => getRuntimeType(this);

final Storage storageArea #

Represents the Storage object that was affected. Read only.
final Storage storageArea

final EventTarget target #

inherited from Event
EventTarget get target => _convertNativeToDart_EventTarget(this._get_target);

final int timeStamp #

inherited from Event
The time that the event was created.
final int timeStamp

final String type #

inherited from Event
The name of the event (case-insensitive).
final String type

final String url #

The URL of the document whose key changed. Read only.
final String url

Operators

bool operator ==(other) #

inherited from Interceptor

The equality operator.

The default behavior for all Objects is to return true if and only if this and other are the same object.

If a subclass overrides the equality operator it should override the hashCode method as well to maintain consistency.

docs inherited from Object
bool operator ==(other) => identical(this, other);

Methods

dynamic noSuchMethod(Invocation invocation) #

inherited from Interceptor

noSuchMethod is invoked when users invoke a non-existant method on an object. The name of the method and the arguments of the invocation are passed to noSuchMethod in an Invocation. If noSuchMethod returns a value, that value becomes the result of the original invocation.

The default behavior of noSuchMethod is to throw a noSuchMethodError.

docs inherited from Object
dynamic noSuchMethod(Invocation invocation) {
 throw new NoSuchMethodError(
     this,
     _symbolToString(invocation.memberName),
     invocation.positionalArguments,
     _symbolMapToStringMap(invocation.namedArguments));
}

void preventDefault() #

inherited from Event
Cancels the event (if it is cancelable).
@DomName('Event.preventDefault')
@DocsEditable
void preventDefault() native;

void stopImmediatePropagation() #

inherited from Event
For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)
@DomName('Event.stopImmediatePropagation')
@DocsEditable
void stopImmediatePropagation() native;

void stopPropagation() #

inherited from Event
Stops the propagation of events further along in the DOM.
@DomName('Event.stopPropagation')
@DocsEditable
void stopPropagation() native;

String toString() #

inherited from Interceptor

Returns a string representation of this object.

docs inherited from Object
String toString() => Primitives.objectToString(this);

void $dom_initEvent(String eventTypeArg, bool canBubbleArg, bool cancelableArg) #

inherited from Event
Initializes the value of an Event created through the DocumentEvent interface.
@JSName('initEvent')
@DomName('Event.initEvent')
@DocsEditable
void $dom_initEvent(String eventTypeArg, bool canBubbleArg, bool cancelableArg) native;

void $dom_initStorageEvent(String typeArg, bool canBubbleArg, bool cancelableArg, String keyArg, String oldValueArg, String newValueArg, String urlArg, Storage storageAreaArg) #

Initializes the event in a manner analogous to the similarly-named method in the DOM Events interfaces.

Parameters
typeArg
The name of the event.
canBubbleArg
A boolean indicating whether the event bubbles up through the DOM or not.
cancelableArg
A boolean indicating whether the event is cancelable.
keyArg
The key whose value is changing as a result of this event.
oldValueArg
The key's old value.
newValueArg
The key's new value.
urlArg
Missing Description
storageAreaArg
The DOM Storage object representing the storage area on which this event occurred.
@JSName('initStorageEvent')
@DomName('StorageEvent.initStorageEvent')
@DocsEditable
void $dom_initStorageEvent(String typeArg, bool canBubbleArg, bool cancelableArg, String keyArg, String oldValueArg, String newValueArg, String urlArg, Storage storageAreaArg) native;

This page includes content from the Mozilla Foundation that is graciously licensed under a Creative Commons: Attribution-Sharealike license. Mozilla has no other association with Dart or dartlang.org. We encourage you to improve the web by contributing to The Mozilla Developer Network.