com.gargoylesoftware.htmlunit.javascript.host.OfflineResourceList Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-client-compiler-deps Show documentation
Show all versions of vaadin-client-compiler-deps Show documentation
Vaadin is a web application framework for Rich Internet Applications (RIA).
Vaadin enables easy development and maintenance of fast and
secure rich web
applications with a stunning look and feel and a wide browser support.
It features a server-side architecture with the majority of the logic
running
on the server. Ajax technology is used at the browser-side to ensure a
rich
and interactive user experience.
/*
* Copyright (c) 2002-2011 Gargoyle Software 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 com.gargoylesoftware.htmlunit.javascript.host;
import com.gargoylesoftware.htmlunit.javascript.SimpleScriptable;
/**
* A collection of offline resources as defined in the
* HTML5 spec.
* Intended to support offline web applications.
*
* NOTE: This class is essentially a skeleton implementation providing minimal
* compatibility while we wait for the HTML5 dust to settle. The first real browser we should
* worry about supporting with this implementation will probably be either Firefox 3.5
* or Firefox 4.
*
* @version $Revision: 6204 $
* @author Daniel Gredler
* @see Offline Resources in Firefox
* @see Mozilla Documentation
*/
public class OfflineResourceList extends SimpleScriptable {
/** The object isn't associated with an application cache. */
public static final short STATUS_UNCACHED = 0;
/** The application cache is not in the process of being updated. */
public static final short STATUS_IDLE = 1;
/** The application cache manifest is being fetched and checked for updates. */
public static final short STATUS_CHECKING = 2;
/** Resources are being downloaded to be added to the cache. */
public static final short STATUS_DOWNLOADING = 3;
/** There is a new version of the application cache available. */
public static final short STATUS_UPDATEREADY = 4;
/** The application cache group is now obsolete. */
public static final short STATUS_OBSOLETE = 5;
private short status_ = STATUS_UNCACHED;
private Object onchecking_;
private Object onerror_;
private Object onnoupdate_;
private Object ondownloading_;
private Object onprogress_;
private Object onupdateready_;
private Object oncached_;
/**
* Returns the event listener to be called when fetching the application cache manifest and checking for updates.
* @return the event listener to be called when fetching the application cache manifest and checking for updates
*/
public Object jsxGet_onchecking() {
return onchecking_;
}
/**
* Sets the event listener to be called when fetching the application cache manifest and checking for updates.
* @param o the event listener to be called when fetching the application cache manifest and checking for updates
*/
public void jsxSet_onchecking(final Object o) {
onchecking_ = o;
}
/**
* Returns the event listener to be called when an error occurs during the caching process.
* @return the event listener to be called when an error occurs during the caching process
*/
public Object jsxGet_onerror() {
return onerror_;
}
/**
* Sets the event listener to be called when an error occurs during the caching process.
* @param o the event listener to be called when an error occurs during the caching process
*/
public void jsxSet_onerror(final Object o) {
onerror_ = o;
}
/**
* Returns the event listener to be called when there is no update to download.
* @return the event listener to be called when there is no update to download
*/
public Object jsxGet_onnoupdate() {
return onnoupdate_;
}
/**
* Sets the event listener to be called when there is no update to download.
* @param o the event listener to be called when there is no update to download
*/
public void jsxSet_onnoupdate(final Object o) {
onnoupdate_ = o;
}
/**
* Returns the event listener to be called when resources are being downloaded into the cache.
* @return the event listener to be called when resources are being downloaded into the cache
*/
public Object jsxGet_ondownloading() {
return ondownloading_;
}
/**
* Sets the event listener to be called when resources are being downloaded into the cache.
* @param o the event listener to be called when resources are being downloaded into the cache
*/
public void jsxSet_ondownloading(final Object o) {
ondownloading_ = o;
}
/**
* Returns the event listener to be called periodically throughout the download process.
* @return the event listener to be called periodically throughout the download process
*/
public Object jsxGet_onprogress() {
return onprogress_;
}
/**
* Sets the event listener to be called periodically throughout the download process.
* @param o the event listener to be called periodically throughout the download process
*/
public void jsxSet_onprogress(final Object o) {
onprogress_ = o;
}
/**
* Returns the event listener to be called when a resource update is ready.
* @return the event listener to be called when a resource update is ready
*/
public Object jsxGet_onupdateready() {
return onupdateready_;
}
/**
* Sets the event listener to be called when a resource update is ready.
* @param o the event listener to be called when a resource update is ready
*/
public void jsxSet_onupdateready(final Object o) {
onupdateready_ = o;
}
/**
* Returns the event listener to be called when caching is complete.
* @return the event listener to be called when caching is complete
*/
public Object jsxGet_oncached() {
return oncached_;
}
/**
* Sets the event listener to be called when caching is complete.
* @param o the event listener to be called when caching is complete
*/
public void jsxSet_oncached(final Object o) {
oncached_ = o;
}
/**
* Returns the status of the application cache.
* @return the status of the application cache
*/
public short jsxGet_status() {
return status_;
}
/**
* Returns the number of entries in the dynamically managed offline resource list.
* @return the number of entries in the dynamically managed offline resource list
*/
public int jsxGet_length() {
return 0; // TODO: implement
}
/**
* Adds an item to the dynamically managed entries. The resource will be fetched and added to the application cache.
* @param uri the URI of the item to add to the dynamically managed entries
*/
public void jsxFunction_add(final String uri) {
// TODO: implement
}
/**
* Returns true if the specified URI represents a resource that's in the application cache's list.
* @param uri the URI to check
* @return true if the specified URI represents a resource that's in the application cache's list
*/
public boolean jsxFunction_hasItem(final String uri) {
return false; // TODO: implement
}
/**
* Returns the URI of the item at the specific offset into the list of cached resources.
* @param index the index of the cached item whose URI should be returned
* @return the URI of the item at the specific offset into the list of cached resources
*/
public String jsxFunction_item(final int index) {
return null; // TODO: implement
}
/**
* Removes an item from the list of dynamically managed entries. If this was the last reference
* to the given URI in the application cache, the cache entry is removed.
* @param uri the URI to remove
*/
public void jsxFunction_remove(final String uri) {
// TODO: implement
}
/**
* Swaps in the newest version of the application cache.
*/
public void jsxFunction_swapCache() {
// TODO: implement
}
/**
* Begins the application cache update process.
*/
public void jsxFunction_update() {
// TODO: implement
}
}