summaryrefslogtreecommitdiffstats
path: root/src/com/vaadin/terminal/gwt/server
diff options
context:
space:
mode:
authorLeif Åstrand <leif@vaadin.com>2012-06-20 14:36:21 +0300
committerLeif Åstrand <leif@vaadin.com>2012-06-20 14:36:29 +0300
commitf505d99754fa0139fbbe1b52236ad622c8c3246d (patch)
treeef1a33af9503b202045c60c6fdb1f8a738595aba /src/com/vaadin/terminal/gwt/server
parent29d592938cabec07c72e007008d019136fbe5f4f (diff)
downloadvaadin-framework-f505d99754fa0139fbbe1b52236ad622c8c3246d.tar.gz
vaadin-framework-f505d99754fa0139fbbe1b52236ad622c8c3246d.zip
Javadocs and minor tweaks for extensions, JavaScript and js wrappers
Diffstat (limited to 'src/com/vaadin/terminal/gwt/server')
-rw-r--r--src/com/vaadin/terminal/gwt/server/ClientConnector.java56
1 files changed, 26 insertions, 30 deletions
diff --git a/src/com/vaadin/terminal/gwt/server/ClientConnector.java b/src/com/vaadin/terminal/gwt/server/ClientConnector.java
index 860627a352..dfdd58879d 100644
--- a/src/com/vaadin/terminal/gwt/server/ClientConnector.java
+++ b/src/com/vaadin/terminal/gwt/server/ClientConnector.java
@@ -12,7 +12,6 @@ import com.vaadin.terminal.gwt.client.Connector;
import com.vaadin.terminal.gwt.client.communication.SharedState;
import com.vaadin.ui.Component;
import com.vaadin.ui.ComponentContainer;
-import com.vaadin.ui.Root;
/**
* Interface implemented by all connectors that are capable of communicating
@@ -30,8 +29,6 @@ public interface ClientConnector extends Connector, RpcTarget {
*
* @return an unmodifiable ordered list of pending server to client method
* calls (not null)
- *
- * @since 7.0
*/
public List<ClientMethodInvocation> retrievePendingRpcCalls();
@@ -61,7 +58,7 @@ public interface ClientConnector extends Connector, RpcTarget {
* Causes a repaint of this connector, and all connectors below it.
*
* This should only be used in special cases, e.g when the state of a
- * descendant depends on the state of a ancestor.
+ * descendant depends on the state of an ancestor.
*/
public void requestRepaintAll();
@@ -69,18 +66,18 @@ public interface ClientConnector extends Connector, RpcTarget {
* Sets the parent connector of the connector.
*
* <p>
- * This method automatically calls {@link #attach()} if the parent becomes
- * attached to the application, regardless of whether it was attached
- * previously. Conversely, if the parent is {@code null} and the connector
- * is attached to the application, {@link #detach()} is called for the
- * connector.
+ * This method automatically calls {@link #attach()} if the connector
+ * becomes attached to the application, regardless of whether it was
+ * attached previously. Conversely, if the parent is {@code null} and the
+ * connector is attached to the application, {@link #detach()} is called for
+ * the connector.
* </p>
* <p>
* This method is rarely called directly. One of the
* {@link ComponentContainer#addComponent(Component)} or
- * {@link AbstractClientConnector#addFeature(Feature)} methods is normally
- * used for adding connectors to a container and it will call this method
- * implicitly.
+ * {@link AbstractClientConnector#addExtension(Extension)} methods are
+ * normally used for adding connectors to a parent and they will call this
+ * method implicitly.
* </p>
*
* <p>
@@ -103,15 +100,13 @@ public interface ClientConnector extends Connector, RpcTarget {
* The caller of this method is {@link #setParent(ClientConnector)} if the
* parent is itself already attached to the application. If not, the parent
* will call the {@link #attach()} for all its children when it is attached
- * to the application. This method is always called before the connector is
- * painted for the first time.
+ * to the application. This method is always called before the connector's
+ * data is sent to the client-side for the first time.
* </p>
*
* <p>
* The attachment logic is implemented in {@link AbstractClientConnector}.
* </p>
- *
- * @see #getApplication()
*/
public void attach();
@@ -119,25 +114,26 @@ public interface ClientConnector extends Connector, RpcTarget {
* Notifies the component that it is detached from the application.
*
* <p>
- * The {@link #getApplication()} and {@link #getRoot()} methods might return
- * <code>null</code> after this method is called.
- * </p>
- *
- * <p>
- * This method must call {@link Root#componentDetached(Component)} to let
- * the Root know that a new Component has been attached.
- * </p>
- * *
- * <p>
- * The caller of this method is {@link #setParent(Component)} if the parent
- * is in the application. When the parent is detached from the application
- * it is its response to call {@link #detach()} for all the children and to
- * detach itself from the terminal.
+ * The caller of this method is {@link #setParent(ClientConnector)} if the
+ * parent is in the application. When the parent is detached from the
+ * application it is its response to call {@link #detach()} for all the
+ * children and to detach itself from the terminal.
* </p>
*/
public void detach();
+ /**
+ * Get a read-only collection of all extensions attached to this connector.
+ *
+ * @return a collection of extensions
+ */
public Collection<Extension> getExtensions();
+ /**
+ * Remove an extension from this connector.
+ *
+ * @param extension
+ * the extension to remove.
+ */
public void removeExtension(Extension extension);
}