From 3ffcb6c7ff73d6f3468d3d1d04d2e05edc7815cc Mon Sep 17 00:00:00 2001 From: "edburns%acm.org" Date: Thu, 17 Mar 2005 01:56:55 +0000 Subject: [PATCH] [11-StateSavingWindowId] This change-bundle implements the FULL proposal for this, as well as covering some corner-cases not in the initial proposal. I have yet to get the last stamp of approval from the EG, but I'm confident we'll get it, so I'm checking it in now. r=visvan. SECTION: API Changes M jsf-api/src/javax/faces/application/StateManager.java - reword the class description for readability - saveSerializedView Deprecate this. Make it no-longer abstract. Provide default impl that returns null. - saveView new method. Replaces saveSerializedView. Provide default impl that calls through to saveSerializedView(). - writeState that takes Object new method. Provide default impl: + *

For backwards compatability with existing + * StateManager implementations, the default + * implementation of this method checks if the argument is an + * instance of Object [] of length greater than or + * equal to two. If so, it creates a SerializedView + * instance with the tree structure coming frome element zero and + * the component state coming from element one and calls through to + * {@link + * #writeState(javax.faces.context.FacesContext,javax.faces.application.StateManager.SerializedView}. + * If not, does nothing.

- getTreeStructureToSave - getComponentStateToSave - restoreTreeStructure - restoreComponentState Deprecate these. Provide default impl that returns null or no-ops. - SerializedView Deprecate this. M jsf-api/src/javax/faces/application/StateManagerWrapper.java - add new methods. M jsf-api/src/javax/faces/render/ResponseStateManager.java - writeState that takes Object new method. + *

For backwards compatability with existing + * ResponseStateManager implementations, the default + * implementation of this method checks if the argument is an + * instance of SerializedView. If so, it calls through + * to {@link + * #writeState(javax.faces.context.FacesContext,javax.faces.application.StateManager.SerializedView}. + * If not, does nothing.

- writeState that takes SerializedView + * @deprecated This method has been replaced by {@link + * #writeState(javax.faces.context.FacesContext,java.lang.Object)}. + * The default implementation of this method does nothing. + * - getState new method. - getTreeStructureToRestore - getComponentStateToRestore Deprecate these. Provide default impl that returns null or no-ops. SECTION: RI Changes M jsf-ri/src/com/sun/faces/application/StateManagerImpl.java Provide implementations for deprecated methods that will be called by the default implementations of the new methods in StateManager. - saveSerializedView(): no functional change since last version M jsf-ri/src/com/sun/faces/application/ViewHandlerImpl.java - move the responsibility for doing the redirect to createView() from renderView(), since it was only designed to catch the initial request. M jsf-ri/src/com/sun/faces/lifecycle/RestoreViewPhase.java - introduce private isPostback() method. + * @return true if the request method is POST or PUT, or the method + * is GET but there are query parameters, or the request is not an + * instance of HttpServletRequest. Only call restoreView() if isPostback(), otherwise call createView(). M jsf-ri/src/com/sun/faces/renderkit/ResponseStateManagerImpl.java - modify getTreeStructureToRestore() so it knows the value of the hidden field is only a string, not a base64 encoded object tree, if the stateSavingMethod is server. - modify writeState() to not encode the view if we're saving state in the server, just write out the id. - remove unused replaceMarkers method. M jsf-ri/src/com/sun/faces/taglib/jsf_core/ViewTag.java - leverage new APIs and rely on impl to delegate to deprecated APIs for backwards compatability. M jsf-ri/systest/build-tests.xml M jsf-ri/systest/src/com/sun/faces/htmlunit/AbstractTestCase.java M jsf-ri/systest/src/com/sun/faces/jsptest/JspIntegrationTestCase.java M jsf-ri/test/com/sun/faces/FacesTestCaseService.java M jsf-ri/test/com/sun/faces/lifecycle/TestApplyRequestValuesPhase.java M jsf-ri/test/com/sun/faces/lifecycle/TestLifecycleImpl_initial.java M jsf-ri/test/com/sun/faces/lifecycle/TestPhase.java M jsf-ri/test/com/sun/faces/lifecycle/TestProcessValidationsPhase.java M jsf-ri/test/com/sun/faces/lifecycle/TestRestoreViewPhase.java M jsf-ri/web/test/RenderResponse_correct M jsf-ri/web/test/TestLifecycleImpl_initial_correct M jsf-ri/web/test/TestViewHandlerImpl_correct - Oof, mondo changes here. git-svn-id: svn://10.0.0.236/trunk@170818 18797224-902f-48f8-a5cc-f745e15eee43 --- .../org/mozilla/webclient/BookmarkEntry.java | 86 +++++++++-- .../org/mozilla/webclient/Bookmarks.java | 56 +++++-- .../webclient/BrowserControlFactory.java | 6 +- .../org/mozilla/webclient/CurrentPage.java | 106 ++++++++++--- .../org/mozilla/webclient/CurrentPage2.java | 45 ++++++ .../mozilla/webclient/DocumentLoadEvent.java | 96 +++++++++--- .../webclient/DocumentLoadListener.java | 20 ++- .../mozilla/webclient/NewWindowListener.java | 140 ++++++++++++++---- .../org/mozilla/webclient/WebclientEvent.java | 85 +++++++---- .../webclient/WebclientEventListener.java | 32 ++-- .../mozilla/webclient/WebclientFactory.java | 40 +++-- .../org/mozilla/webclient/overview.html | 8 +- .../org/mozilla/webclient/package.html | 5 +- 13 files changed, 567 insertions(+), 158 deletions(-) diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/BookmarkEntry.java b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/BookmarkEntry.java index 72f7425fc3b..9ba2cd7e567 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/BookmarkEntry.java +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/BookmarkEntry.java @@ -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 @@ -25,28 +25,84 @@ package org.mozilla.webclient; import java.util.Properties; import javax.swing.tree.MutableTreeNode; -public interface BookmarkEntry extends MutableTreeNode -{ +/** + *

The TreeModel returned by {@link + * Bookmarks#getBookmarks} is composed of instances of this class.

+ * + *

New instances of this class may only be created with {@link + * Bookmarks#newBookmarkEntry}. Instances may be added to and removed + * from the bookmarks tree by calling {@link Bookmarks#addBookmark} and + * {@link Bookmarks#removeBookmark} respectively. A special entry that is a + * folder may be created with {@link Bookmarks#newBookmarkFolder}.

+ * + *

The meta-data for the bookmark is contained in a + * Properties

instance returned from {@link + * #getProperties}. The constants for this class signify the valid keys + * for this Properties table. + * + */ -/** +public interface BookmarkEntry extends MutableTreeNode { + + /** + *

The date on which this bookmark entry was added.

+ */ + + public final static String ADD_DATE = "AddDate"; - * Property names + /** + *

The date on which this bookmark entry was last modified.

+ */ - */ + public final static String LAST_MODIFIED_DATE = "LastModifiedDate"; -public final static String ADD_DATE = "AddDate"; -public final static String LAST_MODIFIED_DATE = "LastModifiedDate"; -public final static String LAST_VISIT_DATE = "LastVisitDate"; -public final static String NAME = "Name"; -public final static String URL = "URL"; -public final static String DESCRIPTION = "Description"; -public final static String IS_FOLDER = "IsFolder"; + /** + *

The date on which this bookmark entry was last visited by the + * browser.

+ */ -public Properties getProperties(); + public final static String LAST_VISIT_DATE = "LastVisitDate"; -public boolean isFolder(); + /** + *

The name of this bookmark entry.

+ */ + public final static String NAME = "Name"; + /** + *

The URL of this bookmark entry.

+ */ + + public final static String URL = "URL"; + + /** + *

The optional user given description of this bookmark + * entry.

+ */ + + public final static String DESCRIPTION = "Description"; + + /** + *

If this bookmark entry is a folder, the value of this property + * is the string "true" without the quotes.

+ */ + + public final static String IS_FOLDER = "IsFolder"; + + /** + *

Returns the Properties for this instance. Valid + * keys are given by the constants of this interface. Other keys + * may exist depending on the implementation.

+ */ + + public Properties getProperties(); + + /** + *

Returns true if and only if this instance is a + * bookmark folder.

+ */ + + public boolean isFolder(); } // end of interface BookmarkEntry diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/Bookmarks.java b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/Bookmarks.java index ca749e6f481..13c022305ff 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/Bookmarks.java +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/Bookmarks.java @@ -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 @@ -24,19 +24,55 @@ package org.mozilla.webclient; import javax.swing.tree.TreeModel; -public interface Bookmarks -{ +/** + *

Provide an abstraction around the bookmarks facility provided by + * the underlying browser.

+ */ -public void addBookmark(BookmarkEntry mayBeNullParent, - BookmarkEntry bookmark); +public interface Bookmarks { + + /** + *

Add the argument bookmark as a child of the + * argument mayBeNullParent. If + * mayBeNullParentis null, the bookmark is + * added as a child of the root node.

+ * + * @param mayBeNullParent if non-null the parent of + * this bookmark. The parent must return true from + * {@link BookmarkEntry#isFolder}. + */ + + public void addBookmark(BookmarkEntry mayBeNullParent, + BookmarkEntry bookmark); + + /** + *

Return a TreeModel representation of the + * bookmarks for the current profile.

+ */ + + public TreeModel getBookmarks() throws IllegalStateException; + + /** + *

Remove the argument bookmark from its current position in the + * tree.

+ */ -public TreeModel getBookmarks() throws IllegalStateException; - -public void removeBookmark(BookmarkEntry bookmark); + public void removeBookmark(BookmarkEntry bookmark); -public BookmarkEntry newBookmarkEntry(String url); + /** + *

Create a new, un-attached {@link BookmarkEntry} instance + * suitable for passing to {@link #addBookmark}.

+ */ -public BookmarkEntry newBookmarkFolder(String name); + public BookmarkEntry newBookmarkEntry(String url); + + /** + *

Create a new, un-attached {@link BookmarkEntry} instance + * suitable for passing to {@link #addBookmark} that is a + * folder for containing other BookmarkEntry instances.

+ */ + + public BookmarkEntry newBookmarkFolder(String name); } // end of interface Bookmarks diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/BrowserControlFactory.java b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/BrowserControlFactory.java index 701ae7dc70f..9578d9cbf9a 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/BrowserControlFactory.java +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/BrowserControlFactory.java @@ -45,7 +45,7 @@ import java.io.FileNotFoundException; * WebclientFactory}. All of the public static methods in this class * simply call through to this implementation instance.

* - * @version $Id: BrowserControlFactory.java,v 1.12 2005-03-15 02:49:16 edburns%acm.org Exp $ + * @version $Id: BrowserControlFactory.java,v 1.13 2005-03-17 01:56:55 edburns%acm.org Exp $ * * */ @@ -145,7 +145,9 @@ public class BrowserControlFactory extends Object { *

Delete a {@link BrowserControl} instance created with {@link * #newBrowserControl}. This method must be called when the user no * longer needs a BrowserControl instance. For - * example, when a browser tab closes.

+ * example, when a browser tab closes. After returning from this + * call, any extant references to that BrowserControl + * are completely useless.

* * @param toDelete the BrowserControl instance to * delete. diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/CurrentPage.java b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/CurrentPage.java index d8e6aa3e724..b0dd9dad10b 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/CurrentPage.java +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/CurrentPage.java @@ -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 @@ -81,26 +81,98 @@ package org.mozilla.webclient; import java.util.Properties; import org.w3c.dom.Document; -public interface CurrentPage -{ -public void copyCurrentSelectionToSystemClipboard(); - -public void findInPage(String stringToFind, boolean forward, boolean matchCase); - -public void findNextInPage(); - -public String getCurrentURL(); - -public Document getDOM(); +/** + *

Get information about and perform operations on the page currently + * being shown in the {@link BrowserControlCanvas} for the {@link + * BrowserControl} instance from which this CurrentPage + * instance was obtained.

+ */ -public Properties getPageInfo(); +public interface CurrentPage { + + /** + *

Copy the current selection to the system clipboard so its + * contents can be obtained using the standard Java + * Toolkit.getDefaultToolkit().getSystemClipboard() + * method. The selection that is copied may be made either by the + * user, or programmatically via the {@link #selectAll} or {@link + * CurrentPage2#highlightSelection} methods.

+ */ + public void copyCurrentSelectionToSystemClipboard(); + + /** + *

Search for the argument stringToFind in the + * current page, highlighting it and scrolling the view to show + * it.

+ * + * @param stringToFind the search string + * + * @param forward if true, search forward from the + * previous hit + * + * @param matchCase if true, the case must match in + * order to be considered a hit. + * + * @deprecated this method has been replaced by {@link + * CurrentPage2#find}. + */ -public String getSource(); + public void findInPage(String stringToFind, boolean forward, boolean matchCase); + + /** + *

Find the next occurrence of the String found with {@link + * #findInPage}.

+ * + * @deprecated this method has been replaced by {@link + * CurrentPage2#findNext}. + */ + + public void findNextInPage(); + + /** + *

Return the URL of the document currently + * showing.

+ */ + + public String getCurrentURL(); + + /** + *

Return a W3C DOM Document of the document currently + * showing.

+ */ + + public Document getDOM(); + + /** + *

Unimplemented Return meta-information for the current + * page.

+ */ + + public Properties getPageInfo(); + + /** + *

Return the source for the current page as a String.

+ */ + public String getSource(); -public byte [] getSourceBytes(); + /** + *

Return the source for the current page as a byte + * array.

+ */ + public byte [] getSourceBytes(); + + /** + *

Reset the find so that the next find starts from the beginning + * or end of the page.

+ */ -public void resetFind(); + public void resetFind(); -public void selectAll(); + /** + *

Tell the underlying browser to select all text in the current + * page.

+ */ + + public void selectAll(); } // end of interface CurrentPage diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/CurrentPage2.java b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/CurrentPage2.java index 35bb572af4d..98e606ee08c 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/CurrentPage2.java +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/CurrentPage2.java @@ -23,20 +23,65 @@ package org.mozilla.webclient; +/** + *

Extended current page functionality.

+ */ public interface CurrentPage2 extends CurrentPage { + + /** + *

Return a {@link Selection} instance for the current selection. + * This is the only way to obtain a Selection + * instance.

+ */ + public Selection getSelection(); + + /** + *

Take the argument {@link Selection} and highlight it in the + * current page.

+ * + * @param selection the selection, obtained from {@link + * #getSelection} to be highlighted. + */ public void highlightSelection(Selection selection); + /** + *

Make it so the current page has nothing selected.

+ */ + public void clearAllSelections(); + + /** + *

Pop up a native print dialog to allow the user to print the + * current page.

+ */ public void print(); + + /** + *

Turn the browser into print preview mode depending on the + * value of the argument preview.

+ * + * @param preview if true, turn the browser into print preview mode. + * If false, turn the browser to normal view mode. + */ public void printPreview(boolean preview); + + /** + *

Enhanced version of {@link CurrentPage#findInPage} that allows + * the caller to discover the result of the find.

+ */ public boolean find(String stringToFind, boolean forward, boolean matchCase); + /** + *

Enhanced version of {@link CurrentPage#findNextInPage} that allows + * the caller to discover the result of the find.

+ */ + public boolean findNext(); } // end of interface CurrentPage2 diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/DocumentLoadEvent.java b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/DocumentLoadEvent.java index 321087e5aee..bf7c5356d97 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/DocumentLoadEvent.java +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/DocumentLoadEvent.java @@ -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 @@ -22,26 +22,88 @@ package org.mozilla.webclient; -public class DocumentLoadEvent extends WebclientEvent -{ +/** + *

Event class for the {@link DocumentLoadListener} interface.

+ * + */ -public static final long START_DOCUMENT_LOAD_EVENT_MASK = 1; -public static final long END_DOCUMENT_LOAD_EVENT_MASK = 1 << 2; -public static final long START_URL_LOAD_EVENT_MASK = 1 << 3; -public static final long END_URL_LOAD_EVENT_MASK = 1 << 4; -public static final long PROGRESS_URL_LOAD_EVENT_MASK = 1 << 5; -public static final long STATUS_URL_LOAD_EVENT_MASK = 1 << 6; -public static final long UNKNOWN_CONTENT_EVENT_MASK = 1 << 7; -public static final long FETCH_INTERRUPT_EVENT_MASK = 1 << 8; +public class DocumentLoadEvent extends WebclientEvent { + + /** + *

The type of the event to indicate the start of a + * document load.

+ */ + + public static final long START_DOCUMENT_LOAD_EVENT_MASK = 1; + + /** + *

The type of the event to indicate the end of a + * document load.

+ */ + + public static final long END_DOCUMENT_LOAD_EVENT_MASK = 1 << 2; + + /** + *

If the current document is a compound document, this event + * will be generated, indicating the start of a URL load within a + * document load for that compound document.

+ */ + + public static final long START_URL_LOAD_EVENT_MASK = 1 << 3; + + /** + *

If the current document is a compound document, this event + * will be generated, indicating the end of a URL load within a + * document load for that compound document.

+ */ + + public static final long END_URL_LOAD_EVENT_MASK = 1 << 4; + + /** + *

This event indicates a progress message from the browser.

+ */ + + public static final long PROGRESS_URL_LOAD_EVENT_MASK = 1 << 5; + + /** + *

This event indicates a status message from the browser. For + * example, "completed."

+ */ + public static final long STATUS_URL_LOAD_EVENT_MASK = 1 << 6; + + /** + *

This event indicates the browser encountered an unknown + * content that it does not know how to display.

+ */ + + public static final long UNKNOWN_CONTENT_EVENT_MASK = 1 << 7; + + /** + *

This event indicates the current fetch was interrupted.

+ */ + + public static final long FETCH_INTERRUPT_EVENT_MASK = 1 << 8; // // Constructors // + /** + *

Create a new DocumentLoadListener instance.

+ * + * @param source the source of the event, passed to + * super. This will be the {@link EventRegistration} + * instance for this {@link BrowserControl}. + * + * @param newType the eventType. Depends on the {@link + * WebclientEventListener} sub-interface. + * + * @param newEventData the eventType. Depends on the {@link + * WebclientEventListener} sub-interface. + */ -public DocumentLoadEvent(Object source, long newType, - Object newEventData) -{ - super(source, newType, newEventData); -} - + public DocumentLoadEvent(Object source, long newType, + Object newEventData) { + super(source, newType, newEventData); + } + } // end of class DocumentLoadEvent diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/DocumentLoadListener.java b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/DocumentLoadListener.java index 8fbbd35d2a0..4d0a2e7c84e 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/DocumentLoadListener.java +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/DocumentLoadListener.java @@ -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 @@ -23,21 +23,25 @@ package org.mozilla.webclient; /** - *

The eventDispatched() method is passed a {@link - * DocumentLoadEvent} instance. The type property of the - * event will be one of the types defined as a public static final - * int in DocumentLoadEvent.

+ *

The {@link WebclientEventListener#eventDispatched} method is + * passed a {@link DocumentLoadEvent} instance. The type + * property of the event will be one of the types defined as a + * public static final int constant in + * DocumentLoadEvent.

* *

The eventData property of the * DocumentLoadEvent instance will be a - * java.util.Map. For all EVENT_MASK types in + * java.util.Map. For all types in * DocumentLoadEvent the map will contain an entry under * the key "URI" without the quotes. This will be the * fully qualified URI for the event.

* *

For the PROGRESS_URL_LOAD_EVENT_MASK there will be an - * entry in the map for the key "message". This will be - * the progress message from the browser.

+ * entry in the map for the key "message" without the + * quotes. This will be the progress message from the browser.

+ * + *

For extended information about the event, implement {@link + * PageInfoListener}.

* */ diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/NewWindowListener.java b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/NewWindowListener.java index 6cae1e9db77..961743edb72 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/NewWindowListener.java +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/NewWindowListener.java @@ -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 @@ -22,50 +22,134 @@ package org.mozilla.webclient; +/** + *

This interface allows the implementer to be notified of {@link + * NewWindowEvent}s that occur as a result of user browsing. For + * example, pop-ups.

+ * + *

The constants defined in this interface should really be defined + * on {@link NewWindowEvent}, but they remain here for backwards + * compatability. They are given to the user as the value of the + * type property of the NewWindowEvent. They + * advise the user on the characteristics of the new window to be + * created. They should be anded with the argument eventType to + * determine if they are indicated for this event. Here is an example + * of how to create a new window in response to a + * NewWindowEvent:

+ * + * 
+ *
+ *
+public void eventDispatched(WebclientEvent newWindowEvent) {
+
+  BrowserControl newBrowserControl = null;
+  BrowserControlCanvas newCanvas = null;
+
+  Frame newFrame = new Frame();
+
+  long type = newWindowEvent.getType();
+  if (type & NewWindowListener.CHROME_MENUBAR) {
+    // create a menu bar for the new window
+  }
+  if (type & NewWindowListener.CHROME_WINDOW_CLOSE) {
+    // Make it so this window cannot be closed
+  }
+
+  try {
+    newBrowserControl = BrowserControlFactory.newBrowserControl();
+    newCanvas = (BrowserControlCanvas)
+      newBrowserControl.queryInterface(BrowserControl.BROWSER_CONTROL_CANVAS_NAME);
+    // obtain any other interfaces you need.
+  } catch (Throwable e) {
+      System.out.println(e.getMessage());
+  }
+
+  newFrame.add(newCanvas, BorderLayout.CENTER);
+  newFrame.setVisible(true);
+  newCanvas.setVisible(true);
+}
+
+ *
+ * + *

+ */ + public interface NewWindowListener extends WebclientEventListener { -public static final long CHROME_DEFAULT = 1; + public static final long CHROME_DEFAULT = 1; -public static final long CHROME_WINDOW_BORDERS = 1 << 1; + public static final long CHROME_WINDOW_BORDERS = 1 << 1; -/* Specifies whether the window can be closed. */ -public static final long CHROME_WINDOW_CLOSE = 1 << 2; + /* + * Specifies whether the window can be closed. + */ -/* Specifies whether the window is resizable. */ -public static final long CHROME_WINDOW_RESIZE = 1 << 3; + public static final long CHROME_WINDOW_CLOSE = 1 << 2; -/* Specifies whether to display the menu bar. */ -public static final long CHROME_MENUBAR = 1 << 4; + /** + * Specifies whether the window is resizable. + */ -/* Specifies whether to display the browser toolbar, making buttons such as Back, Forward, and Stop available. */ -public static final long CHROME_TOOLBAR = 1 << 5; + public static final long CHROME_WINDOW_RESIZE = 1 << 3; -/* Specifies whether to display the input field for entering URLs directly into the browser. */ -public static final long CHROME_LOCATIONBAR = 1 << 6; + /** + * Specifies whether to display the menu bar. + */ -/* Specifies whether to add a status bar at the bottom of the window. */ -public static final long CHROME_STATUSBAR = 1 << 7; + public static final long CHROME_MENUBAR = 1 << 4; -/* Specifies whether to display the personal bar. (Mozilla only) */ -public static final long CHROME_PERSONAL_TOOLBAR = 1 << 8; + /** + * Specifies whether to display the browser toolbar, making buttons + * such as Back, Forward, and Stop available. + */ -/* Specifies whether to display horizontal and vertical scroll bars. */ -public static final long CHROME_SCROLLBARS = 1 << 9; + public static final long CHROME_TOOLBAR = 1 << 5; -/* Specifies whether to display a title bar for the window. */ -public static final long CHROME_TITLEBAR = 1 << 10; + /** + * Specifies whether to display the input field for entering URLs + * directly into the browser. + */ -public static final long CHROME_EXTRA = 1 << 11; + public static final long CHROME_LOCATIONBAR = 1 << 6; -public static final long CHROME_WITH_SIZE = 1 << 12; + /** + * Specifies whether to add a status bar at the bottom of the window. + */ -public static final long CHROME_WITH_POSITION = 1 << 13; + public static final long CHROME_STATUSBAR = 1 << 7; -/* Specifies whether the window is minimizable. */ -public static final long CHROME_WINDOW_MIN = 1 << 14; + /** + * Specifies whether to display the personal bar. (Mozilla only) + */ + + public static final long CHROME_PERSONAL_TOOLBAR = 1 << 8; -public static final long CHROME_WINDOW_POPUP = 1 << 15; + /** + * Specifies whether to display horizontal and vertical scroll bars. + */ -public static final long CHROME_ALL = 4094; + public static final long CHROME_SCROLLBARS = 1 << 9; + + /** + * Specifies whether to display a title bar for the window. + */ + + public static final long CHROME_TITLEBAR = 1 << 10; + + public static final long CHROME_EXTRA = 1 << 11; + + public static final long CHROME_WITH_SIZE = 1 << 12; + + public static final long CHROME_WITH_POSITION = 1 << 13; + + /** + * Specifies whether the window is minimizable. + */ + + public static final long CHROME_WINDOW_MIN = 1 << 14; + + public static final long CHROME_WINDOW_POPUP = 1 << 15; + + public static final long CHROME_ALL = 4094; } diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/WebclientEvent.java b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/WebclientEvent.java index e357baf1e19..25ac6cb144b 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/WebclientEvent.java +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/WebclientEvent.java @@ -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 @@ -24,37 +24,64 @@ package org.mozilla.webclient; import java.util.EventObject; -public class WebclientEvent extends EventObject -{ +/** + *

Base event class for browser specific events coming from the + * browser.

+ */ -// -// Attribute ivars -// +public class WebclientEvent extends EventObject { -private long type; + // + // Attribute ivars + // + + private long type; + + private Object eventData; + + // + // Constructors + // -private Object eventData; + /** + *

Construct a new instance with the given source, + * type, and eventData. This method is + * typically not called by user code.

+ * + * @param source the source of the event, passed to + * super. Depends on the {@link + * WebclientEventListener} sub-interface. + * + * @param newType the eventType. Depends on the {@link + * WebclientEventListener} sub-interface. + * + * @param newEventData the eventType. Depends on the {@link + * WebclientEventListener} sub-interface. + */ + + public WebclientEvent(Object source, long newType, + Object newEventData) { + super(source); + type = newType; + eventData = newEventData; + } -// -// Constructors -// - -public WebclientEvent(Object source, long newType, - Object newEventData) -{ - super(source); - type = newType; - eventData = newEventData; -} - -public long getType() -{ - return type; -} - -public Object getEventData() -{ - return eventData; -} + /** + *

Return the type of this event. Depends on the {@link + * WebclientEventListener} sub-interface.

+ */ + + public long getType() { + return type; + } + + /** + *

Return the event data for this event. Depends on the {@link + * WebclientEventListener} sub-interface.

+ */ + public Object getEventData() { + return eventData; + } + } // end of class WebclientLoadEvent diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/WebclientEventListener.java b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/WebclientEventListener.java index 27859f2f625..2f06bc3f1ab 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/WebclientEventListener.java +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/WebclientEventListener.java @@ -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 @@ -22,16 +22,28 @@ package org.mozilla.webclient; -public interface WebclientEventListener -{ - /** - - * Important: do not call any webclient methods during this callback. - * It may caus your app to deadlock. - + *

The base interface for many, but not all, events coming from the + * browser. For example, it is possible to add a + * java.awt.event.MouseListener or + * java.awt.event.KeyListener to the {@link + * BrowserControlCanvas}. Doing so will cause events specific to those + * interfaces to be generated. See the sub-interface javadoc for more + * details.

*/ -public void eventDispatched(WebclientEvent event); - +public interface WebclientEventListener { + + /** + *

This method will be called by the browser when a particular + * event occurs. The nature of the argument event + * depends on the particular WebclientEventListener + * sub-interface that is implemented. See the sub-interface javadoc + * for more details.

+ * + * @param event the event object for this event + */ + + public void eventDispatched(WebclientEvent event); + } // end of interface WebclientEventListener diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/WebclientFactory.java b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/WebclientFactory.java index 464290991c8..e38b6f431e9 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/WebclientFactory.java +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/WebclientFactory.java @@ -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 @@ -56,32 +56,40 @@ public interface WebclientFactory { throws FileNotFoundException, ClassNotFoundException; /** - *

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"

+ * + *

See {@link + * BrowserControlFactory#setProfile}.

+ * */ public void setProfile(String profileName); + /** + * + *

See {@link + * BrowserControlFactory#appTerminate}.

+ * + */ + public void appTerminate() throws Exception; + /** + * + *

See {@link + * BrowserControlFactory#newBrowserControl}.

+ * + */ + public BrowserControl newBrowserControl() throws InstantiationException, IllegalAccessException, IllegalStateException; /** - - * BrowserControlFactory.deleteBrowserControl is called with a - * BrowserControl instance obtained from - * BrowserControlFactory.newBrowserControl. This method renders the - * argument instance completely un-usable. It should be called when the - * BrowserControl instance is no longer needed. This method simply - * calls through to the non-public BrowserControlImpl.delete() method. - - * @see org.mozilla.webclient.ImplObject#delete - - */ + * + *

See {@link + * BrowserControlFactory#deleteBrowserControl}.

+ * + */ public void deleteBrowserControl(BrowserControl toDelete); diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/overview.html b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/overview.html index b8ef13b0802..b31042f6353 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/overview.html +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/overview.html @@ -33,16 +33,16 @@

The API Javadocs for the Webclient specification.

-

Brief usage available in the package docs for the -org.mozilla.webclient package. Detailed usage instructions -are available at Brief usage available in the package docs for the org.mozilla.webclient package. Detailed usage +instructions are available at http://www.mozilla.org/projects/blackwood/webclient/#Using.

-Last modified: Mon Mar 14 21:40:08 Eastern Standard Time 2005 +Last modified: Wed Mar 16 19:09:12 Eastern Standard Time 2005 diff --git a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/package.html b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/package.html index d6d15f69751..aaa67bcfc6a 100644 --- a/mozilla/java/webclient/classes_spec/org/mozilla/webclient/package.html +++ b/mozilla/java/webclient/classes_spec/org/mozilla/webclient/package.html @@ -39,7 +39,8 @@ 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, null must be passed to this method. This method -must be called once and only once.

+must be called once and only once in the lifetime of the +application.

For browsers that support the concept of "profiles" it must be possible to set the current profile used for this browsing session by @@ -69,7 +70,7 @@ org.mozilla.webclient.BrowserControlFactory#appTerminate}.

-Last modified: Mon Mar 14 20:45:20 Eastern Standard Time 2005 +Last modified: Wed Mar 16 19:10:03 Eastern Standard Time 2005