01: /*
02: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/list/I_CmsListDirectAction.java,v $
03: * Date : $Date: 2008-02-27 12:05:28 $
04: * Version: $Revision: 1.13 $
05: *
06: * This library is part of OpenCms -
07: * the Open Source Content Management System
08: *
09: * Copyright (c) 2002 - 2008 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: /**
35: * Interface for list direct action, that is an action that may be applied
36: * directly on a list item.<p>
37: *
38: * @author Michael Moossen
39: *
40: * @version $Revision: 1.13 $
41: *
42: * @since 6.0.0
43: */
44: public interface I_CmsListDirectAction extends I_CmsListAction {
45:
46: /**
47: * Generates a confirmation text div tag, to use in lists where all items use
48: * the same confirmation text.<p>
49: *
50: * @return html code
51: */
52: String confirmationTextHtml();
53:
54: /**
55: * Returns the id of the column to use as parameter for the helptext and confirmation message.<p>
56: *
57: * @return the id of the column to use
58: */
59: String getColumnForTexts();
60:
61: /**
62: * Returns the current item.<p>
63: *
64: * @return the current item
65: */
66: CmsListItem getItem();
67:
68: /**
69: * Generates a help text div tag, to use in lists where all items use the same help text.<p>
70: *
71: * @return html code
72: */
73: String helpTextHtml();
74:
75: /**
76: * Sets the id of the column to use as parameter for the helptext and confirmation message.<p>
77: *
78: * @param columnId the id of the column to use
79: */
80: void setColumnForTexts(String columnId);
81:
82: /**
83: * Sets the current item, should be called before the <code>{@link #buttonHtml(org.opencms.workplace.CmsWorkplace)}</code> method.<p>
84: *
85: * @param item the item
86: */
87: void setItem(CmsListItem item);
88:
89: }
|