This checkin starts updating the javadocs. Wow. Some of these docs
haven't been touched since 1998! A dom/classes/org/mozilla/dom/package.html A dom/classes/org/mozilla/dom/util/package.html A util/classes/org/mozilla/util/package.html A webclient/classes_spec/org/mozilla/webclient/overview.html A webclient/classes_spec/org/mozilla/webclient/package.html M dist/build.xml M util/classes/org/mozilla/util/Debug.java M util/classes/org/mozilla/util/Log.java M util/classes/org/mozilla/util/Range.java M util/classes/org/mozilla/util/Utilities.java M webclient/classes_spec/org/mozilla/webclient/BrowserControl.java M webclient/classes_spec/org/mozilla/webclient/BrowserControlFactory.java M webclient/classes_spec/org/mozilla/webclient/ImplObject.java M webclient/classes_spec/org/mozilla/webclient/Navigation2.java M webclient/classes_spec/org/mozilla/webclient/WebclientFactory.java - Start refresh of javadocs git-svn-id: svn://10.0.0.236/trunk@170679 18797224-902f-48f8-a5cc-f745e15eee43
This commit is contained in:
edburns%acm.org
@@ -29,33 +29,95 @@ package org.mozilla.webclient;
|
||||
|
||||
/**
|
||||
*
|
||||
|
||||
* Provides a common access point for other webclient interfaces. There
|
||||
* is one instance of this class per application-level browser window.
|
||||
* Instances must be created using BrowserControlFactory.
|
||||
|
||||
|
||||
* <p>Provides a common access point for other webclient interfaces.
|
||||
* There is one instance of this class per application-level browser
|
||||
* window. Instances must be created using {@link
|
||||
* BrowserControlFactory}.</p>
|
||||
*
|
||||
* @version $Id: BrowserControl.java,v 1.4 2003-09-28 06:29:04 edburns%acm.org Exp $
|
||||
* @version $Id: BrowserControl.java,v 1.5 2005-03-15 02:49:16 edburns%acm.org Exp $
|
||||
*
|
||||
* @see org.mozilla.webclient.BrowserControlFactory
|
||||
* */
|
||||
*
|
||||
*/
|
||||
|
||||
public interface BrowserControl
|
||||
{
|
||||
public interface BrowserControl {
|
||||
|
||||
/**
|
||||
* <p>The name of the interface for the {@link Bookmarks} API.</p>
|
||||
*/
|
||||
|
||||
public static String BOOKMARKS_NAME = "webclient.Bookmarks";
|
||||
|
||||
/**
|
||||
* <p>The name of the interface for the {@link BrowserControlCanvas}
|
||||
* that must be added to the application to show the browser
|
||||
* window.</p>
|
||||
*/
|
||||
|
||||
public static String BROWSER_CONTROL_CANVAS_NAME = "webclient.BrowserControlCanvas";
|
||||
|
||||
public static String BOOKMARKS_NAME = "webclient.Bookmarks";
|
||||
public static String BROWSER_CONTROL_CANVAS_NAME = "webclient.BrowserControlCanvas";
|
||||
public static String CURRENT_PAGE_NAME = "webclient.CurrentPage";
|
||||
public static String EVENT_REGISTRATION_NAME = "webclient.EventRegistration";
|
||||
public static String EXTENDED_EVENT_REGISTRATION_NAME = "webclient.ExtendedEventRegistration";
|
||||
public static String HISTORY_NAME = "webclient.History";
|
||||
public static String NAVIGATION_NAME = "webclient.Navigation";
|
||||
public static String CACHE_MANAGER_NAME = "webclient.cache.NetDataCacheManager";
|
||||
public static String PREFERENCES_NAME = "webclient.Preferences";
|
||||
public static String PRINT_NAME = "webclient.Print";
|
||||
public static String WINDOW_CONTROL_NAME = "webclient.WindowControl";
|
||||
public static String PROFILE_MANAGER_NAME = "webclient.ProfileManager";
|
||||
/**
|
||||
* <p>The name of the interface for the {@link CurrentPage} API.</p>
|
||||
*/
|
||||
|
||||
public static String CURRENT_PAGE_NAME = "webclient.CurrentPage";
|
||||
|
||||
/**
|
||||
* <p>The name of the interface for the {@link EventRegistration}
|
||||
* API.</p>
|
||||
*/
|
||||
public static String EVENT_REGISTRATION_NAME = "webclient.EventRegistration";
|
||||
|
||||
/**
|
||||
* <p>The name of the interface for the {@link EventRegistration2}
|
||||
* API.</p>
|
||||
*/
|
||||
|
||||
public static String EXTENDED_EVENT_REGISTRATION_NAME = "webclient.ExtendedEventRegistration";
|
||||
|
||||
/**
|
||||
* <p>The name of the interface for the {@link History} API.</p>
|
||||
*/
|
||||
|
||||
public static String HISTORY_NAME = "webclient.History";
|
||||
|
||||
/**
|
||||
* <p>The name of the interface for the {@link Navigation} API.</p>
|
||||
*/
|
||||
|
||||
public static String NAVIGATION_NAME = "webclient.Navigation";
|
||||
|
||||
/**
|
||||
* <p>The name of the interface for the cache management API.
|
||||
* Unimplemented.</p>
|
||||
*/
|
||||
|
||||
public static String CACHE_MANAGER_NAME = "webclient.cache.NetDataCacheManager";
|
||||
|
||||
/**
|
||||
* <p>The name of the interface for the {@link Preferences} API.</p>
|
||||
*/
|
||||
|
||||
public static String PREFERENCES_NAME = "webclient.Preferences";
|
||||
|
||||
/**
|
||||
* <p>The name of the interface for the Print API.
|
||||
* Unimplemented.</p>
|
||||
*/
|
||||
|
||||
public static String PRINT_NAME = "webclient.Print";
|
||||
|
||||
/**
|
||||
* <p>The name of the interface for the {@link WindowControl} API.</p>
|
||||
*/
|
||||
|
||||
public static String WINDOW_CONTROL_NAME = "webclient.WindowControl";
|
||||
|
||||
/**
|
||||
* <p>The name of the interface for the {@link ProfileManager} API.</p>
|
||||
*/
|
||||
|
||||
public static String PROFILE_MANAGER_NAME = "webclient.ProfileManager";
|
||||
|
||||
/**
|
||||
* @deprecated the type of browser implementation is derived using a
|
||||
@@ -63,18 +125,24 @@ public static String PROFILE_MANAGER_NAME = "webclient.ProfileManager";
|
||||
* org.mozilla.util.Utilities#getImplFromServices}
|
||||
*
|
||||
*/
|
||||
|
||||
public static String BROWSER_TYPE_NATIVE = null;
|
||||
public static String BROWSER_TYPE_NON_NATIVE = null;
|
||||
|
||||
|
||||
public static String BROWSER_TYPE_NATIVE = null;
|
||||
public static String BROWSER_TYPE_NON_NATIVE = null;
|
||||
|
||||
|
||||
/**
|
||||
|
||||
*
|
||||
* <p>Obtain a reference to a class implementing the argument
|
||||
* <code>interfaceName</code>.</p>
|
||||
*
|
||||
* @param interfaceName valid values for <code>interfaceName</code>
|
||||
* are any of the *_NAME class variables in this interface.
|
||||
|
||||
*
|
||||
* @throws ClassNotFoundException if the <code>interfaceName</code>
|
||||
* can't be instantiated for whatever reason.
|
||||
*
|
||||
*/
|
||||
|
||||
public Object queryInterface(String interfaceName) throws ClassNotFoundException;
|
||||
|
||||
public Object queryInterface(String interfaceName) throws ClassNotFoundException;
|
||||
|
||||
} // end of interface BrowserControl
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
||||
/* -*- Mode: java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
||||
*
|
||||
* The contents of this file are subject to the Mozilla Public
|
||||
* License Version 1.1 (the "License"); you may not use this file
|
||||
@@ -37,109 +37,143 @@ import java.io.FileNotFoundException;
|
||||
|
||||
|
||||
/**
|
||||
* <p>The factory from which {@link BrowserControl} instances are
|
||||
* created.</p>
|
||||
*
|
||||
* <p><B>BrowserControlFactory</B> uses {@link
|
||||
* Utilities#getImplFromServices} to find an implementation of {@link
|
||||
* WebclientFactory}. All of the public static methods in this class
|
||||
* simply call through to this implemenatation instance.</p>
|
||||
* <p><B>BrowserControlFactory</B> uses {@link
|
||||
* Utilities#getImplFromServices} to find an implementation of {@link
|
||||
* WebclientFactory}. All of the public static methods in this class
|
||||
* simply call through to this implementation instance.</p>
|
||||
*
|
||||
*
|
||||
* @version $Id: BrowserControlFactory.java,v 1.11 2004-11-05 06:40:26 edburns%acm.org Exp $
|
||||
* @version $Id: BrowserControlFactory.java,v 1.12 2005-03-15 02:49:16 edburns%acm.org Exp $
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
public class BrowserControlFactory extends Object
|
||||
{
|
||||
//
|
||||
// Protected Constants
|
||||
//
|
||||
public class BrowserControlFactory extends Object {
|
||||
//
|
||||
// Protected Constants
|
||||
//
|
||||
|
||||
//
|
||||
// Class Variables
|
||||
//
|
||||
|
||||
private static WebclientFactory instance = null;
|
||||
|
||||
//
|
||||
// Constructors and Initializers
|
||||
//
|
||||
|
||||
private BrowserControlFactory() {
|
||||
Assert.assert_it(false, "This class shouldn't be constructed.");
|
||||
}
|
||||
|
||||
//
|
||||
// Class methods
|
||||
//
|
||||
|
||||
//
|
||||
// Class Variables
|
||||
//
|
||||
|
||||
private static WebclientFactory instance = null;
|
||||
|
||||
//
|
||||
// Constructors and Initializers
|
||||
//
|
||||
|
||||
private BrowserControlFactory()
|
||||
{
|
||||
Assert.assert_it(false, "This class shouldn't be constructed.");
|
||||
}
|
||||
|
||||
//
|
||||
// Class methods
|
||||
//
|
||||
|
||||
public static void setProfile(String profileName)
|
||||
{
|
||||
getInstance().setProfile(profileName);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* <p>Initialize the webclient API passing in the path to the browser
|
||||
* binary, if necessary. This must be the first method called in the
|
||||
* Webclient API.</p>
|
||||
*
|
||||
* <p>If we are embedding a native browser, calling this method will
|
||||
* cause the native libraries to be loaded into the JVM.</p>
|
||||
*
|
||||
* @param absolutePathToNativeBrowserBinDir if non-<code>null</code>
|
||||
* this must be the path to the bin dir of the native browser, including
|
||||
* the bin. ie: "D:\\Projects\\mozilla\\dist\\win32_d.obj\\bin". When
|
||||
* embedding a non-native browser, this may be null.
|
||||
*
|
||||
*/
|
||||
|
||||
public static void setAppData(String absolutePathToNativeBrowserBinDir) throws FileNotFoundException, ClassNotFoundException
|
||||
{
|
||||
getInstance().setAppData(absolutePathToNativeBrowserBinDir);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @deprecated Use {@link #setAppData(java.lang.String)} instead.
|
||||
*/
|
||||
|
||||
public static void setAppData(String notUsed, String absolutePathToNativeBrowserBinDir) throws FileNotFoundException, ClassNotFoundException
|
||||
{
|
||||
getInstance().setAppData(absolutePathToNativeBrowserBinDir);
|
||||
}
|
||||
|
||||
public static void appTerminate() throws Exception
|
||||
{
|
||||
getInstance().appTerminate();
|
||||
}
|
||||
|
||||
public static BrowserControl newBrowserControl() throws InstantiationException, IllegalAccessException, IllegalStateException
|
||||
{
|
||||
BrowserControl result = null;
|
||||
result = getInstance().newBrowserControl();
|
||||
return result;
|
||||
}
|
||||
|
||||
public static void deleteBrowserControl(BrowserControl toDelete)
|
||||
{
|
||||
getInstance().deleteBrowserControl(toDelete);
|
||||
}
|
||||
|
||||
//
|
||||
// helper methods
|
||||
//
|
||||
|
||||
protected static WebclientFactory getInstance()
|
||||
{
|
||||
if (null != instance) {
|
||||
return instance;
|
||||
/**
|
||||
* <p>If called before the first {@link BrowserControl} has been
|
||||
* created, set the name of the profile to use for this browser
|
||||
* session. If the underlying browser does not support the concept
|
||||
* of profiles, this method is a no-op.</p>
|
||||
*
|
||||
* @param profileName the name of the profile
|
||||
*/
|
||||
|
||||
public static void setProfile(String profileName) {
|
||||
getInstance().setProfile(profileName);
|
||||
}
|
||||
|
||||
instance = (WebclientFactory)
|
||||
Utilities.getImplFromServices("org.mozilla.webclient.WebclientFactory");
|
||||
return instance;
|
||||
}
|
||||
/**
|
||||
*
|
||||
* <p>Initialize the webclient API passing in the path to the browser
|
||||
* binary, if necessary. This must be the first method called in the
|
||||
* Webclient API, and it must be called once and only once.</p>
|
||||
*
|
||||
* <p>If we are embedding a native browser, calling this method will
|
||||
* cause the native libraries to be loaded into the JVM.</p>
|
||||
*
|
||||
* @param absolutePathToNativeBrowserBinDir if non-<code>null</code>
|
||||
* this must be the path to the bin dir of the native browser, including
|
||||
* the bin. ie: "D:\\Projects\\mozilla\\dist\\win32_d.obj\\bin". When
|
||||
* embedding a non-native browser, this may be null.
|
||||
*
|
||||
*/
|
||||
|
||||
public static void setAppData(String absolutePathToNativeBrowserBinDir) throws FileNotFoundException, ClassNotFoundException {
|
||||
getInstance().setAppData(absolutePathToNativeBrowserBinDir);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @deprecated Use {@link #setAppData(java.lang.String)} instead.
|
||||
*/
|
||||
|
||||
public static void setAppData(String notUsed, String absolutePathToNativeBrowserBinDir) throws FileNotFoundException, ClassNotFoundException {
|
||||
getInstance().setAppData(absolutePathToNativeBrowserBinDir);
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>This method must be called when the application no longer
|
||||
* needs to use the Webclient API for the rest of its lifetime.</p>
|
||||
*/
|
||||
|
||||
public static void appTerminate() throws Exception {
|
||||
getInstance().appTerminate();
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Create, initialize, and return a new {@link BrowserControl}
|
||||
* instance. There is one <code>BrowserControl</code> instance per
|
||||
* browser window. For example, in a tabbed browser application
|
||||
* with three browser tabs open, there will be three
|
||||
* <code>BrowserControl</code> instances, one for each tab. Also,
|
||||
* any pop-up windows that are created during the course of a user
|
||||
* session also correspond to a <code>BrowserControl</code>
|
||||
* instance.</p>
|
||||
*/
|
||||
|
||||
public static BrowserControl newBrowserControl() throws InstantiationException, IllegalAccessException, IllegalStateException {
|
||||
BrowserControl result = null;
|
||||
result = getInstance().newBrowserControl();
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Delete a {@link BrowserControl} instance created with {@link
|
||||
* #newBrowserControl}. This method must be called when the user no
|
||||
* longer needs a <code>BrowserControl</code> instance. For
|
||||
* example, when a browser tab closes.</p>
|
||||
*
|
||||
* @param toDelete the <code>BrowserControl</code> instance to
|
||||
* delete.
|
||||
*/
|
||||
|
||||
public static void deleteBrowserControl(BrowserControl toDelete) {
|
||||
getInstance().deleteBrowserControl(toDelete);
|
||||
}
|
||||
|
||||
//
|
||||
// helper methods
|
||||
//
|
||||
|
||||
/**
|
||||
* <p>This method enables separating the webclient interface from
|
||||
* its implementation via the {@link Utilities#getImplFromServices}
|
||||
* method.</p>
|
||||
*/
|
||||
|
||||
protected static WebclientFactory getInstance()
|
||||
{
|
||||
if (null != instance) {
|
||||
return instance;
|
||||
}
|
||||
|
||||
instance = (WebclientFactory)
|
||||
Utilities.getImplFromServices("org.mozilla.webclient.WebclientFactory");
|
||||
return instance;
|
||||
}
|
||||
|
||||
} // end of class BrowserControlFactory
|
||||
|
||||
@@ -91,8 +91,6 @@ public BrowserControl getBrowserControl() {
|
||||
* Subclasses should override this and call super.delete() at the end of
|
||||
* their overridden delete() method.
|
||||
|
||||
* @see org.mozilla.webclient.wrapper_native.ImplObjectNative#delete
|
||||
|
||||
*/
|
||||
|
||||
public void delete()
|
||||
|
||||
@@ -37,7 +37,7 @@ public interface Navigation2 extends Navigation
|
||||
|
||||
/**
|
||||
|
||||
* @param absoluteUrl, must be absolute
|
||||
* @param absoluteUrl must be absolute
|
||||
|
||||
* @param target null at the moment
|
||||
|
||||
|
||||
@@ -56,9 +56,10 @@ public interface WebclientFactory {
|
||||
throws FileNotFoundException, ClassNotFoundException;
|
||||
|
||||
/**
|
||||
* <p>if called before {@link setAppData}, this will cause the
|
||||
* profile used for starting up the underlying browser to be set.
|
||||
* If not called, the default will be "webclient"</p>
|
||||
* <p>if called before {@link
|
||||
* BrowserControlFactory#setAppData(java.lang.String)}, this will
|
||||
* cause the profile used for starting up the underlying browser to
|
||||
* be set. If not called, the default will be "webclient"</p>
|
||||
*/
|
||||
|
||||
public void setProfile(String profileName);
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||
|
||||
<!--
|
||||
|
||||
* The contents of this file are subject to the Netscape Public
|
||||
* License Version 1.1 (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.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the License is distributed on an "AS
|
||||
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
||||
* implied. See the License for the specific language governing
|
||||
* rights and limitations under the License.
|
||||
*
|
||||
* The Original Code is mozilla.org code.
|
||||
*
|
||||
* The Initial Developer of the Original Code is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All
|
||||
* Rights Reserved.
|
||||
*
|
||||
* Contributor(s):
|
||||
|
||||
* Ed Burns >edburns@acm.org<
|
||||
|
||||
-->
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<title>Webclient</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<p>The API Javadocs for the Webclient specification.</p>
|
||||
|
||||
<p>Brief usage available in the package docs for the
|
||||
<code>org.mozilla.webclient</code> package. Detailed usage instructions
|
||||
are available at <a target="_"
|
||||
href="http://www.mozilla.org/projects/blackwood/webclient/#Using">http://www.mozilla.org/projects/blackwood/webclient/#Using</a>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<!-- Created: Mon Mar 14 19:57:56 Eastern Standard Time 2005 -->
|
||||
<!-- hhmts start -->
|
||||
Last modified: Mon Mar 14 21:40:08 Eastern Standard Time 2005
|
||||
<!-- hhmts end -->
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,75 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||
|
||||
<!--
|
||||
|
||||
* The contents of this file are subject to the Netscape Public
|
||||
* License Version 1.1 (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.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the License is distributed on an "AS
|
||||
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
||||
* implied. See the License for the specific language governing
|
||||
* rights and limitations under the License.
|
||||
*
|
||||
* The Original Code is mozilla.org code.
|
||||
*
|
||||
* The Initial Developer of the Original Code is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All
|
||||
* Rights Reserved.
|
||||
*
|
||||
* Contributor(s):
|
||||
|
||||
* Ed Burns >edburns@acm.org<
|
||||
|
||||
-->
|
||||
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<title>org.mozilla.webclient</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<p>The Webclient public API.</p>
|
||||
|
||||
<p>The first Webclient public API call in the application must be {@link
|
||||
org.mozilla.webclient.BrowserControlFactory#setAppData}. If embedding a
|
||||
native browser, the argument must be the fully qualified path name of
|
||||
the binary directory for the browser. If embedding a non-native
|
||||
browser, <code>null</code> must be passed to this method. This method
|
||||
must be called once and only once.</p>
|
||||
|
||||
<p>For browsers that support the concept of "profiles" it must be
|
||||
possible to set the current profile used for this browsing session by
|
||||
calling {@link org.mozilla.webclient.BrowserControlFactory#setProfile}.
|
||||
This call must be made before the first <code>BrowserControl</code>
|
||||
instance is created. If not specified, the "<code>webclient</code>"
|
||||
profile is used to avoid overwriting any settings in the user's
|
||||
profile.</p>
|
||||
|
||||
<p>Upon from return from
|
||||
<code>BrowserControlFactory.setAppData()</code>, {@link
|
||||
org.mozilla.webclient.BrowserControlFactory#newBrowserControl} may be
|
||||
used to create one or more web browser instances. The returned {@link
|
||||
org.mozilla.webclient.BrowserControl} may then be queried, via {@link
|
||||
org.mozilla.webclient.BrowserControl#queryInterface} for additional
|
||||
features.</p>
|
||||
|
||||
<p>When the application is done with a <code>BrowserControl</code>
|
||||
instance, it must pass the instance to {@link
|
||||
org.mozilla.webclient.BrowserControlFactory#deleteBrowserControl}.</p>
|
||||
|
||||
<p>When the application no longer needs the Webclient API, it must call
|
||||
{@link
|
||||
org.mozilla.webclient.BrowserControlFactory#appTerminate}.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<!-- Created: Mon Mar 14 20:36:26 Eastern Standard Time 2005 -->
|
||||
<!-- hhmts start -->
|
||||
Last modified: Mon Mar 14 20:45:20 Eastern Standard Time 2005
|
||||
<!-- hhmts end -->
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user