ComponentListLocator


1   /* ***** BEGIN LICENSE BLOCK *****
2    * Version: MPL 1.1
3    * The contents of this file are subject to the Mozilla Public License Version
4    * 1.1 (the "License"); you may not use this file except in compliance with
5    * the License. You may obtain a copy of the License at
6    * http://www.mozilla.org/MPL/
7    *
8    * Software distributed under the License is distributed on an "AS IS" basis,
9    * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10   * for the specific language governing rights and limitations under the
11   * License.
12   *
13   * The Original Code is Riot.
14   *
15   * The Initial Developer of the Original Code is
16   * Neteye GmbH.
17   * Portions created by the Initial Developer are Copyright (C) 2007
18   * the Initial Developer. All Rights Reserved.
19   *
20   * Contributor(s):
21   *   Felix Gnass [fgnass at neteye dot de]
22   *
23   * ***** END LICENSE BLOCK ***** */
24  package org.riotfamily.components;
25  
26  import javax.servlet.http.HttpServletRequest  ;
27  
28  import org.riotfamily.components.render.InheritingRenderStrategy;
29  
30  /**
31   * Interface that returns the {@link Location} of the ComponentList that should
32   * be rendered.
33   *
34   * @author Felix Gnass [fgnass at neteye dot de]
35   * @since 6.5
36   */
37  public interface ComponentListLocator {
38  
39      /**
40       * Returns whether the locator supports the given type.
41       * @see Location#getType()
42       */
43      public boolean supports(String   type);
44  
45      /**
46       * Returns the {@link Location} for the given request.
47       */
48      public Location getLocation(HttpServletRequest   request);
49  
50      /**
51       * Returns the location that should be used to display inherited components.
52       * @see InheritingRenderStrategy
53       */
54      public Location getParentLocation(Location location);
55  
56      /**
57       * Returns the URL under which the given location can be seen.
58       */
59      public String   getUrl(Location location);
60  
61  }
62
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags