com.opencms.workplace
Interface I_CmsFileListUsers

All Known Implementing Classes:

CmsAdminGallery, CmsDownloadBrowser

public interface I_CmsFileListUsers

Interface for all classes using the workplace file list.

Any class called by CmsXmlTemplateFile for handling the special workplace tag <FILELIST> has to implement this interface.

Version:

$Revision: 1.7 $ $Date: 2003/01/20 23:59:19 $

Author:

Alexander Lucas

See Also:

CmsXmlWpTemplateFile, CmsFileList

Method Summary

void	getCustomizedColumnValues(CmsObject cms, CmsXmlWpTemplateFile filelistTemplate, CmsResource res, CmsXmlLanguageFile lang) Fill all customized columns with the appropriate settings for the given file list entry.
Vector	getFiles(CmsObject cms) Collect all folders and files that are displayed in the file list.
int	modifyDisplayedColumns(CmsObject cms, int prefs) Used to modify the bit pattern for hiding and showing columns in the file list.

Method Detail

getCustomizedColumnValues

public void getCustomizedColumnValues(CmsObject cms,
                                      CmsXmlWpTemplateFile filelistTemplate,
                                      CmsResource res,
                                      CmsXmlLanguageFile lang)
                               throws CmsException

Fill all customized columns with the appropriate settings for the given file list entry. Any column filled by this method may be used in the customized template for the file list.

Parameters:

cms - Cms object for accessing system resources.

res - CmsResource Object of the current file list entry.

lang - Current language file.

Throws:

CmsException - if access to system resources failed.

getFiles

public Vector getFiles(CmsObject cms)
                throws CmsException

Collect all folders and files that are displayed in the file list.

Parameters:

cms - The CmsObject.

Returns:

A vector of folder and file objects.

Throws:

Throws - CmsException if something goes wrong.

CmsException

modifyDisplayedColumns

public int modifyDisplayedColumns(CmsObject cms,
                                  int prefs)

Used to modify the bit pattern for hiding and showing columns in the file list.

Parameters:

cms - Cms object for accessing system resources.

prefs - Old bit pattern.

Returns:

New modified bit pattern.