wamblee.org Git - utils/blob - wicket/components/src/main/java/org/wamblee/wicket/page/PageBehavior.java

   1 /*
   2  * Copyright 2005-2010 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.wicket.page;
  17
  18 import java.io.Serializable;
  19
  20 import org.apache.wicket.markup.html.WebPage;
  21 import org.apache.wicket.protocol.http.WebResponse;
  22
  23 /**
  24  * Page behavior interface. This provides a mechanism to extend page behavior
  25  * without subclassing. Implementations of this interface should be serializable.
  26  *
  27  * @author Erik Brakkee
  28  */
  29 public interface PageBehavior extends Serializable {
  30
  31     /**
  32      * To be called as part of the Page's <code>onBeforeRender</code>
  33      *
  34      * @param aPage
  35      *            Page this is called for.
  36      */
  37     void onBeforeRender(WebPage aPage);
  38
  39     /**
  40      * To be called as part of the Page's <code>setHeaders</code>
  41      *
  42      * @param aPage
  43      *            Page this is called for.
  44      * @param aResponse
  45      *            Response to set headers for.
  46      */
  47     void setHeaders(WebPage aPage, WebResponse aResponse);
  48
  49     /**
  50      * To be called as part of the Page's <code>onAfterRender</code>
  51      *
  52      * @param aPage
  53      *            Page this is called for.
  54      */
  55     void onAfterRender(WebPage aPage);
  56
  57     /**
  58      * To be called in the {@link Page#onDetach
  59      */
  60     void onDetach(WebPage aPage);
  61 }