Author: ivaynberg
Date: Tue Apr 17 14:43:13 2007
New Revision: 529779
URL: http://svn.apache.org/viewvc?view=rev&rev=529779
Log:
javadoc improvement
Modified:
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/org/apache/wicket/markup/html/IHeaderContributor.java
Modified:
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/org/apache/wicket/markup/html/IHeaderContributor.java
URL:
http://svn.apache.org/viewvc/incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/org/apache/wicket/markup/html/IHeaderContributor.java?view=diff&rev=529779&r1=529778&r2=529779
==============================================================================
---
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/org/apache/wicket/markup/html/IHeaderContributor.java
(original)
+++
incubator/wicket/branches/wicket-1.x/jdk-1.4/wicket/src/main/java/org/apache/wicket/markup/html/IHeaderContributor.java
Tue Apr 17 14:43:13 2007
@@ -19,11 +19,26 @@
import org.apache.wicket.IClusterable;
/**
- * An interface to be implemented by components which are able to render the
- * header section associated with the markup. Default implementations are with
- * WebComponent and WebMarkupContainer.
+ * An interface to be implemented by components or behaviors that wish to
+ * contribute to the header section of the page.
+ *
+ * Example:
+ *
+ * <pre>
+ * class MyPanel extends Panel implements IHeaderContributor {
+ * public MyPanel(String id) {
+ * super(id);
+ * }
+ *
+ * public void renderHead(IHeaderResponse response) {
+ * response.renderOnLoadJavascript("alert('page loaded!');");
+ * }
+ * }
+ * </pre>
+ *
*
* @author Juergen Donnerstag
+ * @author Matej Knopp
*/
public interface IHeaderContributor extends IClusterable
{
