View Javadoc

1   /*
2    * Copyright 2000-2001,2004 The Apache Software Foundation.
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  
17  package org.apache.jetspeed.portal.portlets;
18  
19  /***
20   * This subclass of VelocityPortlet should be used as base portlet
21   * for all VelocityPortlets that implement their own customizer
22   * <p>
23   *  <strong>NOTE:</strong>This supports the pre-MVC style of template based portlet development.  
24   *  The perefered method for defining customization is to set a parameter
25   *  named "provides.customization" in the portlet config
26   *  to either "true" or "false" depending on
27   *  whether or not that portlet will provide it's own customizer.  The portlet 
28   *  should also being using @see org.apache.jetspeed.portal.portlets.GenericMVCPortlet
29   *  or a sub-class there of.
30   * </p>
31   * 
32   * @author <a href="mailto:raphael@apache.org">RaphaŽl Luta</a>
33   */
34  public class CustomizerVelocityPortlet extends VelocityPortlet
35  {
36      /***
37      * @return true if the portlet does its own customization
38      */
39      public boolean providesCustomization()
40      {
41          return true;
42      }
43  }