KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > workplace > editors > I_CmsEditorHandler


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/editors/I_CmsEditorHandler.java,v $
3  * Date : $Date: 2006/04/28 15:20:52 $
4  * Version: $Revision: 1.8 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */
31
32 package org.opencms.workplace.editors;
33
34 import org.opencms.jsp.CmsJspActionElement;
35 import org.opencms.main.CmsException;
36
37 /**
38  * Provides a method for selecting an individual file editor.<p>
39  *
40  * You can define the class of your own editor handler in the OpenCms XML configuration files.
41  * changing the &lt;class&gt; subnode of the system node &lt;editorhandler&gt; to another value.
42  * The class you enter must implement this interface to obtain the URI of the displayed editor.<p>
43  *
44  * @author Andreas Zahner
45  *
46  * @version $Revision: 1.8 $
47  *
48  * @since 6.0.0
49  */
50 public interface I_CmsEditorHandler {
51
52     /**
53      * Returns the editor URI which will be used for the selected resource in the OpenCms VFS to the editor selector class.<p>
54      *
55      * @param resource the selected resource
56      * @param jsp the CmsJspActionElement
57      *
58      * @return the absolute path to the editor that will be displayed or <code>null</code> if resource is not editable
59      *
60      * @throws CmsException if something goes wrong
61      */
62     String JavaDoc getEditorUri(String JavaDoc resource, CmsJspActionElement jsp) throws CmsException;
63
64 }
65
Popular Tags