All I had time for today was some javadoc updates. Next step is still to

work on the dom viewer in the TestBrowser.

M webclient/classes_spec/org/mozilla/webclient/EventRegistration.java
M webclient/classes_spec/org/mozilla/webclient/EventRegistration2.java

- add javadocs.


git-svn-id: svn://10.0.0.236/trunk@172432 18797224-902f-48f8-a5cc-f745e15eee43
This commit is contained in:
edburns%acm.org 2005-04-19 13:00:40 +00:00
parent f8fb4953c3
commit 30b1cc73be
2 changed files with 124 additions and 44 deletions

View File

@ -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,27 +25,73 @@ package org.mozilla.webclient;
import java.awt.event.WindowListener;
import java.awt.event.MouseListener;
/**
* <p>Allow the user to add and remove listeners on the current {@link
* BrowserControl} instance.</p>
*/
public interface EventRegistration {
// public void addContainerListener(ContainerListener containerListener);
// public void removeContainerListener(ContainerListener containerListener);
// public void addDocumentListener(DocumentListener documentListener);
// public void removeDocumentListener(DocumentListener documentListener);
public void addDocumentLoadListener(DocumentLoadListener listener);
public void removeDocumentLoadListener(DocumentLoadListener listener);
public void addMouseListener(MouseListener listener);
public void removeMouseListener(MouseListener listener);
// public void addDOMListener(DOMListener containerListener);
// public void removeDOMListener(DOMListener containerListener);
// public void addJavaScriptListener(JavaScriptListener containerListener);
// public void removeJavaScriptListener(JavaScriptListener containerListener);
// public void addWindowListener(WindowListener windowListener);
// public void removeWindowListener(WindowListener windowListener);
}
// public void addContainerListener(ContainerListener containerListener);
// public void removeContainerListener(ContainerListener containerListener);
// public void addDocumentListener(DocumentListener documentListener);
// public void removeDocumentListener(DocumentListener documentListener);
/**
* <p>Add the argument <code>listener</code> as a {@link
* DocumentLoadListener} on the current {@link BrowserControl}.</p>
*
* @param listener the listener to install
*
* @throws NullPointerException if argument is <code>null</code>.
*/
public void addDocumentLoadListener(DocumentLoadListener listener);
/**
* <p>Remove the argument <code>listener</code> as a {@link
* DocumentLoadListener} on the current {@link BrowserControl}.</p>
*
* @param listener the listener to remove
*
* @throws NullPointerException if argument is <code>null</code>.
*/
public void removeDocumentLoadListener(DocumentLoadListener listener);
/**
* <p>Add the argument <code>MouseListener</code> to the {@link
* BrowserControlCanvas} for this {@link BrowserControl}.</p>
*
* @param listener the listener to install
*
* @deprecated This method has been replaced by leveraging the
* method of the same name on {@link BrowserControlCanvas}.
*/
public void addMouseListener(MouseListener listener);
/**
* <p>Remove the argument <code>MouseListener</code> from the {@link
* BrowserControlCanvas} for this {@link BrowserControl}.</p>
*
* @param listener the listener to remove
*
* @deprecated This method has been replaced by leveraging the
* method of the same name on {@link BrowserControlCanvas}.
*/
public void removeMouseListener(MouseListener listener);
// public void addDOMListener(DOMListener containerListener);
// public void removeDOMListener(DOMListener containerListener);
// public void addJavaScriptListener(JavaScriptListener containerListener);
// public void removeJavaScriptListener(JavaScriptListener containerListener);
// public void addWindowListener(WindowListener windowListener);
// public void removeWindowListener(WindowListener windowListener);
}

View File

@ -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,28 +24,62 @@ package org.mozilla.webclient;
import java.awt.event.KeyListener;
/**
* <p>Extended event registration features.</p>
*/
public interface EventRegistration2 extends EventRegistration {
public void setNewWindowListener(NewWindowListener listener);
/**
* <p>Set the argument <code>listener</code> as the one and only
* {@link NewWindowListener} for the current {@link
* BrowserControl}.</p>
*
* @param listener the listener to install
*/
public void setNewWindowListener(NewWindowListener listener);
/**
* <p>Add the argument listener as a {@link NewWindowListener} to
* the current {@link BrowserControl}.</p>
*
* @param listener the listener to install
*
* @deprecated Use {@link #setNewWindowListener} instead.
* Implementations must implement this method as a call to {@link
* #setNewWindowListener} passing null, followed by a call to {@link
* #setNewWindowListener} passing the argument listener.
*/
public void addNewWindowListener(NewWindowListener listener);
/**
* <p>Remove the argument listener from the current {@link
* BrowserControl}.</p>
*
* @param listener the listener to remove
*
* @deprecated Use {@link #setNewWindowListener} passing <code>null</code>.
*/
public void removeNewWindowListener(NewWindowListener listener);
/**
* <p>Use {@link #setNewWindowListener} instead. Implementations must
* implement this method as a call to {@link #setNewWindowListener}
* passing null, followed by a call to {@link #setNewWindowListener}
* passing the argument listener.</p>
*
* @deprecated
*/
public void addNewWindowListener(NewWindowListener listener);
/**
* <p>Use {@link #setNewWindowListener} passing <code>null</code>.</p>
*
* @deprecated
*/
public void removeNewWindowListener(NewWindowListener listener);
public void addKeyListener(KeyListener listener);
public void removeKeyListener(KeyListener listener);
/**
* <p>Add the argument <code>listener</code> as a
* <code>KeyListener</code> for the current {@link
* BrowserControl}.</p>
*
* @param listener the listener to install
*/
public void addKeyListener(KeyListener listener);
/**
* <p>Remove the argument <code>listener</code> from the current
* {@link BrowserControl}.</p>
*
* @param listener the listener to remove
*/
public void removeKeyListener(KeyListener listener);
}