elemental.html

Interface StorageEvent

All Superinterfaces:

Event

All Known Implementing Classes:

JsStorageEvent

public interface StorageEvent
extends Event

dom/interfaces/storage/nsIDOMStorageEvent.idlScriptable

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.

Field Summary

Fields inherited from interface elemental.events.Event

AT_TARGET, BEFORECOPY, BEFORECUT, BEFOREPASTE, BLUR, BUBBLING_PHASE, CAPTURING_PHASE, CHANGE, CLICK, CONTEXTMENU, COPY, CUT, DBLCLICK, DRAG, DRAGEND, DRAGENTER, DRAGLEAVE, DRAGOVER, DRAGSTART, DROP, ERROR, FOCUS, FOCUSIN, FOCUSOUT, INPUT, INVALID, KEYDOWN, KEYPRESS, KEYUP, MOUSEDOWN, MOUSEMOVE, MOUSEOUT, MOUSEOVER, MOUSEUP, MOUSEWHEEL, NONE, PASTE, RESIZE, SCROLL, SELECTSTART, SUBMIT, TOUCHCANCEL, TOUCHEND, TOUCHMOVE, TOUCHSTART, WEBKITANIMATIONEND, WEBKITANIMATIONITERATION, WEBKITANIMATIONSTART, WEBKITTRANSITIONEND

Method Summary

Modifier and Type	Method and Description
String	getKey() Represents the key changed.
String	getNewValue() The new value of the key.
String	getOldValue() The original value of the key.
Storage	getStorageArea() Represents the Storage object that was affected.
String	getUrl() The URL of the document whose key changed.
void	initStorageEvent(String typeArg, boolean canBubbleArg, boolean 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.

Methods inherited from interface elemental.events.Event

getClipboardData, getCurrentTarget, getEventPhase, getSrcElement, getTarget, getTimeStamp, getType, initEvent, isBubbles, isCancelable, isCancelBubble, isDefaultPrevented, isReturnValue, preventDefault, setCancelBubble, setReturnValue, stopImmediatePropagation, stopPropagation

Method Detail

getKey

String getKey()

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

getNewValue

String getNewValue()

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.

getOldValue

String getOldValue()

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.

getStorageArea

Storage getStorageArea()

Represents the Storage object that was affected. Read only.

getUrl

String getUrl()

The URL of the document whose key changed. Read only.

initStorageEvent

void initStorageEvent(String typeArg,
                      boolean canBubbleArg,
                      boolean 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.