KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > opencms > workplace > I_CmsFileListUsers


1 /*
2 * File : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/I_CmsFileListUsers.java,v $
3 * Date : $Date: 2005/05/17 13:47:28 $
4 * Version: $Revision: 1.1 $
5 *
6 * This library is part of OpenCms -
7 * the Open Source Content Mananagement System
8 *
9 * Copyright (C) 2001 The OpenCms Group
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 OpenCms, please see the
22 * OpenCms Website: http://www.opencms.org
23 *
24 * You should have received a copy of the GNU Lesser General Public
25 * License along with this library; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 */
28
29
30 package com.opencms.workplace;
31
32 import org.opencms.file.CmsObject;
33 import org.opencms.file.CmsResource;
34 import org.opencms.main.CmsException;
35
36 import java.util.List JavaDoc;
37
38 /**
39  * Interface for all classes using the workplace file list.
40  * <P>
41  * Any class called by CmsXmlTemplateFile for handling the special workplace tag
42  * <code>&lt;FILELIST&gt;</code> has to implement this interface.
43  *
44  * @author Alexander Lucas
45  * @version $Revision: 1.1 $ $Date: 2005/05/17 13:47:28 $
46  * @see com.opencms.workplace.CmsXmlWpTemplateFile
47  * @see com.opencms.workplace.CmsFileList
48  *
49  * @deprecated Will not be supported past the OpenCms 6 release.
50  */
51
52 public interface I_CmsFileListUsers {
53     
54     /**
55      * Fill all customized columns with the appropriate settings for the given file
56      * list entry. Any column filled by this method may be used in the customized template
57      * for the file list.
58      * @param cms Cms object for accessing system resources.
59      * @param filelist Template file containing the definitions for the file list together with
60      * the included customized defintions.
61      * @param res CmsResource Object of the current file list entry.
62      * @param lang Current language file.
63      * @throws CmsException if access to system resources failed.
64      */
65     
66     public void getCustomizedColumnValues(CmsObject cms, CmsXmlWpTemplateFile filelistTemplate,
67             CmsResource res, CmsXmlLanguageFile lang) throws CmsException;
68     
69     /**
70      * Collect all folders and files that are displayed in the file list.
71      * @param cms The CmsObject.
72      * @return A vector of folder and file objects.
73      * @throws Throws CmsException if something goes wrong.
74      */
75     
76     public List JavaDoc getFiles(CmsObject cms) throws CmsException;
77     
78     /**
79      * Used to modify the bit pattern for hiding and showing columns in
80      * the file list.
81      * @param cms Cms object for accessing system resources.
82      * @param prefs Old bit pattern.
83      * @return New modified bit pattern.
84      */
85     
86     public int modifyDisplayedColumns(CmsObject cms, int prefs);
87 }
88
Popular Tags