View Javadoc

1   package net.sourceforge.blogentis.plugins.base;
2   
3   //-----------------------------------------------------------------------
4   //Blogentis - a blog publishing platform.
5   //Copyright (C) 2004 Tassos Bassoukos <abassouk@gmail.com>
6   //
7   //This library is free software; you can redistribute it and/or
8   //modify it under the terms of the GNU Lesser General Public
9   //License as published by the Free Software Foundation; either
10  //version 2.1 of the License, or (at your option) any later version.
11  //
12  //This library is distributed in the hope that it will be useful,
13  //but WITHOUT ANY WARRANTY; without even the implied warranty of
14  //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  //Lesser General Public License for more details.
16  //
17  //You should have received a copy of the GNU Lesser General Public
18  //License along with this library; if not, write to the Free Software
19  //Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  //-----------------------------------------------------------------------
21  //
22  //$Id: INavigationExtension.java,v 1.3 2004/11/02 00:58:50 tassos Exp $
23  //
24  
25  import java.util.List;
26  
27  import net.sourceforge.blogentis.plugins.IBlogExtension;
28  import net.sourceforge.blogentis.turbine.BlogRunData;
29  
30  /***
31   * Extensions to the navigation list should implement this interface. The
32   * navigation model is simple: a navigation list has an name.
33   * 
34   * @author abas
35   */
36  public interface INavigationExtension
37          extends IBlogExtension {
38      /***
39       * This method will be called to fill the list of links. If this extension
40       * does not know about the specified navName, it will simply leave the list
41       * unmodified.
42       * 
43       * @param data
44       *            the BlogRunData of the current request
45       * @param navName
46       *            the navigation lists' name.
47       * @param links
48       *            the navigation list to be modified.
49       */
50      public void addNavigations(BlogRunData data, String navName, List links);
51      
52      public static final String ADMIN_LIST_NAME = "AdminList";
53      public static final String BLOG_SETTINGS_NAME = "BlogSettingsList";
54      public static final String APPEARANCE_LIST_NAME = "AppearanceList";
55      public static final String SIDEBOX_LIST_NAME = "SideboxList";
56      public static final String USER_ACTIONS_NAME = "UserActions";
57      public static final String ADMIN_SITE_NAME = "AdminSiteList";
58      public static final String AUTHORING_ACTIONS_NAME = "AuthoringActions";
59  }