KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > workplace > I_CmsDialogHandler


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/I_CmsDialogHandler.java,v $
3  * Date : $Date: 2005/06/23 11:11:33 $
4  * Version: $Revision: 1.9 $
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;
33
34 import org.opencms.jsp.CmsJspActionElement;
35
36 /**
37  * Provides a method for selecting an individual jsp dialog.<p>
38  *
39  * You can define the class of your own dialog handler in the OpenCms opencms-workplace.xml
40  * changing the &lt;class&gt; attribute of the node &lt;dialoghandler&gt; to another value.
41  * The class you enter must implement this interface to obtain the URI of the displayed dialog.<p>
42  *
43  * @author Andreas Zahner
44  *
45  * @version $Revision: 1.9 $
46  *
47  * @since 6.0.0
48  */

49 public interface I_CmsDialogHandler {
50
51     /**
52      * Returns the name of the handler which is used as key for the OpenCms runtime properties.<p>
53      *
54      * Store the name of the key as a public String constant in the CmsDialogSelector class.<p>
55      *
56      * @return the name of the dialog handler
57      */

58     String JavaDoc getDialogHandler();
59
60     /**
61      * Returns the dialog URI in the OpenCms VFS to the dialog selector class.<p>
62      *
63      * @param resource the selected resource
64      * @param jsp the CmsJspActionElement
65      * @return the absolute path to the property dialog
66      */

67     String JavaDoc getDialogUri(String JavaDoc resource, CmsJspActionElement jsp);
68
69 }
70
Popular Tags