KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > workplace > list > I_CmsListDirectAction


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/list/I_CmsListDirectAction.java,v $
3  * Date : $Date: 2006/03/27 14:52:27 $
4  * Version: $Revision: 1.10 $
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.list;
33
34 import org.opencms.workplace.CmsWorkplace;
35
36 /**
37  * Interface for list direct action, that is an action that may be applied
38  * directly on a list item.<p>
39  *
40  * @author Michael Moossen
41  *
42  * @version $Revision: 1.10 $
43  *
44  * @since 6.0.0
45  */
46 public interface I_CmsListDirectAction extends I_CmsListAction {
47
48     /**
49      * Generates a confirmation text div tag, to use in lists where all items use
50      * the same confirmation text.<p>
51      *
52      * @param wp the workplace instance
53      *
54      * @return html code
55      */
56     String JavaDoc confirmationTextHtml(CmsWorkplace wp);
57
58     /**
59      * Returns the id of the column to use as parameter for the helptext and confirmation message.<p>
60      *
61      * @return the id of the column to use
62      */
63     String JavaDoc getColumnForTexts();
64
65     /**
66      * Returns the current item.<p>
67      *
68      * @return the current item
69      */
70     CmsListItem getItem();
71
72     /**
73      * Generates a help text div tag, to use in lists where all items use the same help text.<p>
74      *
75      * @param wp the workplace instance
76      *
77      * @return html code
78      */
79     String JavaDoc helpTextHtml(CmsWorkplace wp);
80
81     /**
82      * Sets the id of the column to use as parameter for the helptext and confirmation message.<p>
83      *
84      * @param columnId the id of the column to use
85      */
86     void setColumnForTexts(String JavaDoc columnId);
87
88     /**
89      * Sets the current item, should be called before the <code>{@link #buttonHtml(org.opencms.workplace.CmsWorkplace)}</code> method.<p>
90      *
91      * @param item the item
92      */
93     void setItem(CmsListItem item);
94
95 }
Popular Tags