com.google.code.gwt.storage.client.StorageEvent.java Source code

Introduction

Here is the source code for com.google.code.gwt.storage.client.StorageEvent.java

Source

/*
 * Copyright 2009 Bart Guijt and others.
 * 
 * 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 com.google.code.gwt.storage.client;

import com.google.code.gwt.storage.client.impl.StorageEventImpl;
import com.google.gwt.core.client.GWT;
import com.google.gwt.core.client.JavaScriptObject;

/**
 * Represent a Storage Event.
 * 
 * <p>
 * A Storage Event is fired when a storage area changes, as described in these
 * two sections (for <a
 * href="http://www.w3.org/TR/webstorage/#sessionStorageEvent">session
 * storage</a>, for <a
 * href="http://www.w3.org/TR/webstorage/#localStorageEvent">local storage</a>).
 * </p>
 * 
 * @author bguijt
 * @see StorageEventHandler
 * @see <a href="http://www.w3.org/TR/webstorage/#event-definition">W3C Web
 *      Storage - StorageEvent</a>
 * @see <a
 *      href="https://developer.apple.com/safari/library/documentation/AppleApplications/Reference/WebKitDOMRef/StorageEvent_idl/Classes/StorageEvent/index.html">Safari
 *      StorageEvent reference</a>
 */
public final class StorageEvent extends JavaScriptObject {

    private static final StorageEventImpl impl = GWT.create(StorageEventImpl.class);

    protected StorageEvent() {
    }

    /**
     * Returns the key being changed.
     * 
     * @return the key being changed
     * @see <a href="http://www.w3.org/TR/webstorage/#dom-storageevent-key">W3C
     *      Web Storage - StorageEvent.key</a>
     */
    public String getKey() {
        return impl.getKey(this);
    }

    /**
     * Returns the old value of the key being changed.
     * 
     * @return the old value of the key being changed
     * @see <a
     *      href="http://www.w3.org/TR/webstorage/#dom-storageevent-oldvalue">W3C
     *      Web Storage - StorageEvent.oldValue</a>
     */
    public String getOldValue() {
        return impl.getOldValue(this);
    }

    /**
     * Returns the new value of the key being changed.
     * 
     * @return the new value of the key being changed
     * @see <a
     *      href="http://www.w3.org/TR/webstorage/#dom-storageevent-newvalue">W3C
     *      Web Storage - StorageEvent.newValue</a>
     */
    public String getNewValue() {
        return impl.getNewValue(this);
    }

    /**
     * Returns the address of the document whose key changed.
     * 
     * @return the address of the document whose key changed
     * @see <a href="http://www.w3.org/TR/webstorage/#dom-storageevent-url">W3C
     *      Web Storage - StorageEvent.url</a>
     */
    public String getUrl() {
        return impl.getUrl(this);
    }

    /**
     * Returns the WindowProxy object of the browsing context of the document
     * whose key changed.
     * 
     * @return the WindowProxy object of the browsing context of the document
     *         whose key changed
     * @see <a href="http://www.w3.org/TR/webstorage/#dom-storageevent-source">W3C
     *      Web Storage - StorageEvent.source</a>
     */
    public JavaScriptObject getSource() {
        return impl.getSource(this);
    }

    /**
     * Returns the {@link Storage} object that was affected.
     * 
     * @return the {@link Storage} object that was affected
     * @see <a
     *      href="http://www.w3.org/TR/webstorage/#dom-storageevent-storagearea">W3C
     *      Web Storage - StorageEvent.storageArea</a>
     */
    public Storage getStorageArea() {
        return impl.getStorageArea(this);
    }

    public native String enumerateAttributes() /*-{
                                               var names = "";
                                               for (var key in this) {
                                               if (names.length > 0) {
                                               names += ", ";
                                               }
                                               names += key;
                                               }
                                               return names;
                                               }-*/;
}