Uses of Class
com.jalios.jcms.FileDocument

Packages that use FileDocument

Package	Description
com.jalios.jcms	Contains the core JCMS classes.
com.jalios.jcms.calendar	Contains the classes used to deal with calendar in JCMS.
com.jalios.jcms.fileprocessor.test
com.jalios.jcms.handler	Contains the javabean classes uses to process HTTP request (aka form handlers).
com.jalios.jcms.mail
com.jalios.jcms.mashup	Contains classes used for data Import/Export.
com.jalios.jcms.media	Contains all the classes to provide the Media Browser.
com.jalios.jcms.policy
com.jalios.jcms.taglib	Provides many of the classes used for JCMS jsp tags.
com.jalios.jcms.test
com.jalios.jcms.upload
com.jalios.jcms.webdav.cat	Contains classes which provides webdav access to Categorie of JCMS.

Uses of FileDocument in com.jalios.jcms

Classes in com.jalios.jcms with type parameters of type FileDocument

Modifier and Type	Class and Description
static class	FileDocument.ContentTypeComparator<T extends FileDocument>
static class	FileDocument.DimensionsComparator<T extends FileDocument> This comparators compare FileDocuments of image file type according to their dimensions.
static class	FileDocument.DurationComparator<T extends FileDocument> This comparators compare FileDocuments of audio file type according to their duration.
static class	FileDocument.SizeComparator<T extends FileDocument>

Subclasses of FileDocument in com.jalios.jcms

Modifier and Type	Class and Description
class	DBFileDocument

Methods in com.jalios.jcms with type parameters of type FileDocument

Modifier and Type	Method and Description
static <T extends FileDocument> java.util.Comparator<T>	FileDocument.getContentTypeComparator()
static <T extends FileDocument> java.util.Comparator<T>	FileDocument.getDimensionsComparator()
static <T extends FileDocument> java.util.Comparator<T>	FileDocument.getDurationComparator()
static <T extends FileDocument> java.util.Comparator<T>	FileDocument.getSizeComparator()

Methods in com.jalios.jcms that return FileDocument

Modifier and Type	Method and Description
static FileDocument	FileDocument.getFileDocumentFromFile(java.io.File file) Retrieves the first FileDocument bound to the given File.
static FileDocument	FileDocument.getFileDocumentFromFilename(java.lang.String filename) Retrieves the first FileDocument bound to the given filename.
static FileDocument	FileDocument.getInstance(java.lang.Class<? extends FileDocument> clazz, java.lang.String filename, java.lang.String title, java.lang.String description, Category[] categories, Member author, Workspace ws) Constructs a FileDocument from an existing file for the given class.
static FileDocument	FileDocument.getInstance(java.lang.String filename) Constructs a FileDocument from an existing file.
static FileDocument	DBFileDocument.getInstance(java.lang.String filename) Constructs a FileDocument from an existing file.
static FileDocument	FileDocument.getInstance(java.lang.String filename, Member author, Workspace ws) Constructs a FileDocument from an existing file.
static FileDocument	DBFileDocument.getInstance(java.lang.String filename, Member author, Workspace ws) Constructs a FileDocument from an existing file.
static FileDocument	FileDocument.getInstance(java.lang.String filename, java.lang.String title, java.lang.String description, Category[] categories) Constructs a FileDocument from an existing file.
static FileDocument	DBFileDocument.getInstance(java.lang.String filename, java.lang.String title, java.lang.String description, Category[] categories) Constructs a FileDocument from an existing file.
static FileDocument	FileDocument.getInstance(java.lang.String filename, java.lang.String title, java.lang.String description, Category[] categories, Member author, Workspace ws) Constructs a FileDocument from an existing file.
static FileDocument	DBFileDocument.getInstance(java.lang.String filename, java.lang.String title, java.lang.String description, Category[] categories, Member author, Workspace ws) Constructs a FileDocument from an existing file.

Methods in com.jalios.jcms that return types with arguments of type FileDocument

Modifier and Type	Method and Description
static java.util.Comparator<FileDocument>	FileDocument.getComparator(java.lang.String str, boolean reverse) Deprecated. use ComparatorManager
java.util.Set<FileDocument>	Publication.getDocumentLinkSet() Returns the set of documents attached to this publication.
static java.util.Set<FileDocument>	FileDocument.getLockedDocumentSet(Workspace ws, Member mbr) Returns the set of FileDocument which have a strong lock.

Methods in com.jalios.jcms with parameters of type FileDocument

Modifier and Type	Method and Description
void	QuotaManager.addDocumentToVersionCache(FileDocument fileDoc)
void	QuotaManager.addDocumentVersionToVersionCache(FileDocument oldFileDoc, FileDocument fileDoc)
void	QuotaManager.deleteDocumentFromVersionCache(FileDocument fileDoc)
static long	FileDocument.directoryToFileDocuments(java.io.File dir, java.io.FileFilter filter, FileDocument refFileDoc, Member opAuthor, java.util.Map<java.lang.String,? extends java.lang.Object> contextMap) Create FileDocumens from all files in the specified directory (and its sub directory).
java.io.File	AssociatedFilesManager.getAssociatedDirectory(FileDocument fileDoc) Returns the File which is the directory in which associated files are stored
java.util.List<java.lang.String>	QuotaManager.getCachedVersionList(FileDocument fileDoc)
static long	FileDocument.unzipToFileDocuments(java.io.File zipFile, java.io.FileFilter filter, FileDocument refFileDoc, Member opAuthor) Unzip the specified File to n new FileDocument.
void	QuotaManager.updateAfterFileDocumentChange(FileDocument fileDoc) update quota after a filedocument change

Method parameters in com.jalios.jcms with type arguments of type FileDocument

Modifier and Type	Method and Description
static void	JcmsUtil.addFileDocument(java.util.Set<FileDocument> set, java.util.Collection<java.lang.String> filenameColl) Adds the FileDocuments bound to the given filename collection in the given set.
static void	JcmsUtil.addFileDocument(java.util.Set<FileDocument> set, java.lang.String... filenames) Adds the FileDocuments bound to the given filename array in the given set.
static void	JcmsUtil.addFileDocument(java.util.Set<FileDocument> set, java.lang.String filename) Adds the FileDocument bound to the given filename in the given set.
static void	JcmsUtil.addFileDocument(java.util.Set<FileDocument> set, java.lang.String[] filenamesMainLanguage, java.util.Map<java.lang.String,java.lang.String[]> mlMap) Adds the FileDocuments bound to the given array of filename and to the array of filename contains as value of mlMap in the given set.
static void	JcmsUtil.addFileDocument(java.util.Set<FileDocument> set, java.lang.String filenameMainLanguage, java.util.Map<java.lang.String,java.lang.String> mlMap) Adds the FileDocuments bound to the given filename and to the filename contains as value of mlMap in the given set.
static FileDocument	FileDocument.getInstance(java.lang.Class<? extends FileDocument> clazz, java.lang.String filename, java.lang.String title, java.lang.String description, Category[] categories, Member author, Workspace ws) Constructs a FileDocument from an existing file for the given class.

Constructors in com.jalios.jcms with parameters of type FileDocument

Constructor and Description
DBFileDocument(FileDocument other)
FileDocument.AssociatedFileFilter(FileDocument fileDoc)
FileDocument(FileDocument other)

Uses of FileDocument in com.jalios.jcms.calendar

Methods in com.jalios.jcms.calendar that return FileDocument

Modifier and Type	Method and Description
FileDocument[]	CalendarEventInterface.getDocuments()
abstract FileDocument[]	AbstractCalendarEvent.getDocuments()

Methods in com.jalios.jcms.calendar with parameters of type FileDocument

Modifier and Type	Method and Description
void	CalendarEventInterface.setDocuments(FileDocument[] v)
abstract void	AbstractCalendarEvent.setDocuments(FileDocument[] v)

Uses of FileDocument in com.jalios.jcms.fileprocessor.test

Methods in com.jalios.jcms.fileprocessor.test that return FileDocument

Modifier and Type	Method and Description
protected FileDocument	FileParserTestCase.importFile(java.io.File file) Create a new FileDocument by copying the specified file into JCMS and returning the newly created FileDocument.

Methods in com.jalios.jcms.fileprocessor.test with parameters of type FileDocument

Modifier and Type	Method and Description
protected void	FileParserTestCase.waitForLuceneIndexation(FileDocument fd) Wait appropriate amount of time before the specified FileDocument is indexed in JCMS.

Uses of FileDocument in com.jalios.jcms.handler

Fields in com.jalios.jcms.handler declared as FileDocument

Modifier and Type	Field and Description
protected FileDocument[]	MailEditHandler.attachements
protected FileDocument	AssociatedPDFUploadHandler.fileDoc
protected FileDocument	EditFileDocumentHandler.theContent
protected FileDocument	AssociatedPDFUploadHandler.workingFileDoc

Methods in com.jalios.jcms.handler that return FileDocument

Modifier and Type	Method and Description
FileDocument[]	MailEditHandler.getAvailableAttachements()
FileDocument	EditFileDocumentHandler.getFileDocument()
FileDocument	AssociatedPDFUploadHandler.getFileDocument() Retrieve the FileDocument for which upload is being requested
static FileDocument	EditDataFormHandler.getFileDocument(java.lang.String id, Member member) Returns the file document from its ID.

Methods in com.jalios.jcms.handler that return types with arguments of type FileDocument

Modifier and Type	Method and Description
protected java.util.List<FileDocument>	EditDataFormHandler.getFileDocuments(java.lang.String fieldName, java.lang.String lang) Returns the file documents from the field name and the specified language.
protected java.util.Map<java.lang.String,java.util.List<FileDocument>>	EditDataFormHandler.getFileDocumentsML(java.lang.String fieldName) Returns the file documents from the field name for all the defined languages to the site.

Methods in com.jalios.jcms.handler with parameters of type FileDocument

Modifier and Type	Method and Description
static boolean	AssociatedPDFUploadHandler.isPDFUploadAuthorized(FileDocument doc) Check if the PDF upload should be proposed for the specified document kind.

Method parameters in com.jalios.jcms.handler with type arguments of type FileDocument

Modifier and Type	Method and Description
protected boolean	EditDataFormHandler.createUploadedFileDocument(java.util.List<FileDocument> fileDocuments, Member author) Performs create on given array of data if it is a FileDocument that have just been uploaded.
protected boolean	EditDataFormHandler.createUploadedFileDocument(java.util.Map<java.lang.String,java.util.List<FileDocument>> fileDocumentsML, Member author) Performs create on given array of data if it is a FileDocument that have just been uploaded.
protected boolean	EditDataFormHandler.validateUploadedFileDocument(java.util.List<FileDocument> fileDocuments, Member author, Workspace ws) Validates the specified fileDocuments to upload.
protected boolean	EditDataFormHandler.validateUploadedFileDocument(java.util.Map<java.lang.String,java.util.List<FileDocument>> fileDocumentsML, Member author, Workspace ws) Validates the specified fileDocuments to upload.

Uses of FileDocument in com.jalios.jcms.mail

Methods in com.jalios.jcms.mail that return types with arguments of type FileDocument

Modifier and Type	Method and Description
java.util.Set<FileDocument>	MailMessage.getAttachements()
java.util.Set<FileDocument>	MailMessage.getAttachements(boolean b)

Methods in com.jalios.jcms.mail with parameters of type FileDocument

Modifier and Type	Method and Description
MailMessage	MailMessage.addAttachements(FileDocument v)

Method parameters in com.jalios.jcms.mail with type arguments of type FileDocument

Modifier and Type	Method and Description
MailMessage	MailMessage.addAttachements(java.util.Set<FileDocument> v)
void	MailMessage.setAttachements(java.util.Set<FileDocument> v)

Uses of FileDocument in com.jalios.jcms.mashup

Methods in com.jalios.jcms.mashup with parameters of type FileDocument

Modifier and Type	Method and Description
static java.lang.String	ExportUtil.exportFile(int indentLevel, java.lang.String fieldName, FileDocument doc) Returns a XML representation of a FileDocument.
static java.lang.String	ExportUtil.exportFile(int indentLevel, java.lang.String fieldName, FileDocument[] docs) Returns a XML representation of an array of FileDocument.

Uses of FileDocument in com.jalios.jcms.media

Fields in com.jalios.jcms.media declared as FileDocument

Modifier and Type	Field and Description
protected FileDocument	EditImageHandler.fd

Methods in com.jalios.jcms.media that return FileDocument

Modifier and Type	Method and Description
FileDocument	EditImageHandler.getFileDocument()

Methods in com.jalios.jcms.media that return types with arguments of type FileDocument

Modifier and Type	Method and Description
java.util.Set<java.lang.Class<? extends FileDocument>>	MediaBrowserHandler.getTypeSet() Returns the Set of document type that can used in the given workspace by the given member.

Uses of FileDocument in com.jalios.jcms.policy

Methods in com.jalios.jcms.policy with parameters of type FileDocument

Modifier and Type	Method and Description
boolean	BasicThumbnailPolicyFilter.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, boolean done)
boolean	PolicyManager.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square)
boolean	BasicThumbnailPolicyFilter.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean done)
boolean	ThumbnailPolicyFilter.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done) This method is a hook called by Thumbnail tag to generate a thumbnail of the given FileDocument.
boolean	DefaultThumbnailPolicyFilter.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)
boolean	BasicThumbnailPolicyFilter.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)
boolean	DefaultThumbnailPolicyFilter.supportsThumbnail(FileDocument doc)
boolean	ThumbnailPolicyFilter.supportsThumbnail(FileDocument doc, boolean jcms) Returns true if a thumbnail can be generated for the given document.
boolean	PolicyManager.supportsThumbnail(FileDocument doc, boolean jcms)
boolean	BasicThumbnailPolicyFilter.supportsThumbnail(FileDocument doc, boolean jcms)

Uses of FileDocument in com.jalios.jcms.taglib

Fields in com.jalios.jcms.taglib declared as FileDocument

Modifier and Type	Field and Description
protected FileDocument	FileWebdavTag.doc

Methods in com.jalios.jcms.taglib with parameters of type FileDocument

Modifier and Type	Method and Description
static java.io.File	ThumbnailTag.createThumbnail(FileDocument fileDoc, java.io.File srcFile, java.net.URL url, ImageFormat format, int maxWidth, int maxHeight)
static java.io.File	ThumbnailTag.createThumbnail(FileDocument fileDoc, java.io.File srcFile, java.net.URL url, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background) Create a thumbnail using the first valid source from FileDocument, File or URL using given dimensions.
static java.io.File	ThumbnailTag.createThumbnail(FileDocument fileDoc, java.io.File srcFile, java.net.URL url, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square) Create a thumbnail using the first valid source from FileDocument, File or URL using given dimensions.
static boolean	ThumbnailTag.createThumbnailNow(FileDocument fileDoc, java.io.File srcFile, java.net.URL url, ImageFormat format, int maxWidth, int maxHeight, java.io.File destFile)
static boolean	ThumbnailTag.createThumbnailNow(FileDocument fileDoc, java.io.File srcFile, java.net.URL url, ImageFormat format, int maxWidth, int maxHeight, java.io.File destFile, java.lang.String background) This method create a thumbnail of one of the three source given using the options passed as parameters ("now" as opposed to generation when going through ajax}.
static boolean	ThumbnailTag.createThumbnailNow(FileDocument fileDoc, java.io.File srcFile, java.net.URL url, ImageFormat format, int maxWidth, int maxHeight, java.io.File destFile, java.lang.String background, boolean square) This method create a thumbnail of one of the three source given using the options passed as parameters ("now" as opposed to generation when going through ajax}.
static java.io.File	ThumbnailTag.getThumbnailFile(FileDocument fileDoc, java.io.File srcFile, java.net.URL url, int maxWidth, int maxHeight) Gets the File to use for a thumbnail of the given FileDocument, File or URL using given dimensions.
static java.io.File	ThumbnailTag.getThumbnailFile(FileDocument fileDoc, java.io.File srcFile, java.net.URL url, int maxWidth, int maxHeight, boolean square) Gets the File to use for a thumbnail of the given FileDocument, File or URL using given dimensions.
static void	ThumbnailTag.invalidateCacheAttemptThumbnail(FileDocument fileDoc, java.io.File srcFile, java.net.URL url) Invalidates the cache of failure while attempt to create a thumbnail for the given parameter.
void	FileWebdavTag.Webdav.printDownloadIcon(java.lang.StringBuffer sb, FileDocument doc) Prints a download link for the specified FileDocument.
void	FileWebdavTag.Webdav.printWebdavFileIcon(java.lang.StringBuffer sb, FileDocument doc) Check Webdav rights then print a Webdav edit icon
void	FileWebdavTag.Webdav.printWebdavFileIcon(java.lang.StringBuffer sb, FileDocument doc, boolean checkRights) A convenient method to generate Webdav FileIcon without checking rights
void	FileWebdavTag.Webdav.printWebdavFolderIcon(java.lang.StringBuffer sb, FileDocument doc) Print the Webdav Folder Icon for the first valid parent folder of the specified Document.
void	PdfTag.setDoc(FileDocument doc)
void	FileWebdavTag.setDoc(FileDocument doc) This method set the FileDocument to open with webdav
void	FileSizeTag.setDoc(FileDocument doc)
void	FileIconTag.setDoc(FileDocument doc)
void	ThumbnailTag.setFileDoc(FileDocument fd)
void	MediaTag.setFileDoc(FileDocument fileDoc)

Uses of FileDocument in com.jalios.jcms.test

Methods in com.jalios.jcms.test that return FileDocument

Modifier and Type	Method and Description
static FileDocument	JcmsTestCaseUtil.createFileDocument(Member writer, Workspace ws, java.lang.String title, java.lang.String filename)
static FileDocument	JcmsTestCaseUtil.getFileDocument(Member writer, Workspace ws, java.lang.String title, java.lang.String filename)

Uses of FileDocument in com.jalios.jcms.upload

Fields in com.jalios.jcms.upload declared as FileDocument

Modifier and Type	Field and Description
protected FileDocument	DocUploadHandler.document
static FileDocument	DocUploadInfo.INVALID_DOCUMENT

Methods in com.jalios.jcms.upload that return FileDocument

Modifier and Type	Method and Description
FileDocument	DocUploadHandler.getAvailableFileDocument()
FileDocument[]	DocUploadHandler.getAvailableFileDocuments()
FileDocument	DocUploadInfo.getFileDocument() Returns an instance of FileDocument build from current upload infos.
FileDocument	DocUploadInfo.getFileDocument(java.lang.Class clazz) Returns an instance of FileDocument build from current upload infos.

Methods in com.jalios.jcms.upload that return types with arguments of type FileDocument

Modifier and Type	Method and Description
java.lang.Class<? extends FileDocument>	DocUploadHandler.getAvailableType()
static java.lang.Class<? extends FileDocument>	DocUploadHandler.getFirstDocumentClassAuthorized(Member member, Workspace workspace, java.lang.Class<? extends FileDocument> defaultValue) Retrieve the first document class authorized for publication by the specified member.

Method parameters in com.jalios.jcms.upload with type arguments of type FileDocument

Modifier and Type	Method and Description
static java.lang.Class<? extends FileDocument>	DocUploadHandler.getFirstDocumentClassAuthorized(Member member, Workspace workspace, java.lang.Class<? extends FileDocument> defaultValue) Retrieve the first document class authorized for publication by the specified member.

Constructors in com.jalios.jcms.upload with parameters of type FileDocument

Constructor and Description
DocUploadInfo(FileDocument fd) Convenient constructor to call method checkPermission() from a given existing FileDocument

Uses of FileDocument in com.jalios.jcms.webdav.cat

Methods in com.jalios.jcms.webdav.cat with parameters of type FileDocument

Modifier and Type	Method and Description
static java.lang.String	CatWebdavUtil.getParentPath(FileDocument doc) Retrieve the WebDav path of the first valid parent folder of the specified FileDocument.
static java.lang.String	CatWebdavUtil.getPath(FileDocument doc) Retrieve the WebDav path of the specified FileDocument.
static boolean	CatWebdavUtil.isWebdavEditable(FileDocument doc) Check if the specified document can be edited through WebDAV.
static boolean	CatWebdavUtil.isWebdavEditable(FileDocument doc, Member mbr) Check if the specified document can be edited through WebDAV by the specified member.