elemental.html.StorageEvent Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package elemental.html;
import elemental.events.Event;

import elemental.events.*;
import elemental.util.*;
import elemental.dom.*;
import elemental.html.*;
import elemental.css.*;
import elemental.stylesheets.*;

import java.util.Date;

/**
  * 

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.

  */
public interface StorageEvent extends Event {


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


  /**
    * 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.
    */
  String getNewValue();


  /**
    * 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.
    */
  String getOldValue();


  /**
    * Represents the Storage object that was affected. Read only.
    */
  Storage getStorageArea();


  /**
    * The URL of the document whose key changed. Read only.
    */
  String getUrl();


  /**
    * 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.

    */
  void initStorageEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, String keyArg, String oldValueArg, String newValueArg, String urlArg, Storage storageAreaArg);
}