Uses of Class
com.jalios.jcms.FileDocument

Packages that use FileDocument

Package	Description
com.jalios.jcms	Contains the core JPlatform classes.
com.jalios.jcms.calendar	Contains the classes used to deal with calendar in JPlatform.
com.jalios.jcms.document.editor
com.jalios.jcms.fileprocessor.test
com.jalios.jcms.handler	Contains the javabean classes uses to process HTTP request (aka form handlers).
com.jalios.jcms.handler.pubchooser
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.publiclink
com.jalios.jcms.quota
com.jalios.jcms.taglib	Provides many of the classes used for JPlatform jsp tags.
com.jalios.jcms.test
com.jalios.jcms.thumbnail
com.jalios.jcms.uicomponent
com.jalios.jcms.uicomponent.image
com.jalios.jcms.uicomponent.image.editor
com.jalios.jcms.upload
com.jalios.jcms.webdav.cat	Contains classes which provides webdav access to Categorie of JPlatform.
com.jalios.jcms.wysiwyg
com.jalios.jcms.wysiwyg.image

Uses of FileDocument in com.jalios.jcms

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

Modifier and Type	Class	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	Description
class	DBFileDocument

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

Modifier and Type	Field	Description
static java.lang.Class<? extends FileDocument>	FileDocument.defaultUploadClass

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

Modifier and Type	Method	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	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	DBFileDocument.getInstance(java.lang.String filename)	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	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	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.
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	FileDocument.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	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	JcmsUtil.rotateImageExif(FileDocument imageDoc)	Rotates the image based on the EXIF orientation (if needed).

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

Modifier and Type	Method	Description
static java.util.Comparator<FileDocument>	FileDocument.getComparator(java.lang.String str, boolean reverse)	Deprecated. use ComparatorManager
static java.lang.Class<? extends FileDocument>	FileDocument.getDefaultUploadClass()	Returns the default document class to use for upload.
java.util.Set<FileDocument>	Publication.getDocumentLinkSet()	Returns all the FileDocument instance (and subclass) targeted by this Publication through its link fields and through wiki and wysiwyg field.
static java.lang.Class<? extends FileDocument>	FileDocument.getFirstDocumentClassAuthorized(Member member, Workspace workspace)	Retrieve the first document class authorized for publication by the specified member.
static java.lang.Class<? extends FileDocument>	FileDocument.getFirstDocumentClassAuthorized(Member member, Workspace workspace, java.lang.String contentType)	Retrieve the first document class authorized for publication by the specified member and workspace, and the most relevant regarding specified contentType.
static java.lang.Class<? extends FileDocument>	FileDocument.getFirstDocumentClassAuthorized(Member member, Workspace workspace, java.lang.String contentType, java.util.Map<java.lang.String,?> contextMap)	Retrieve the first document class authorized for publication by the specified member and workspace, and the most relevant regarding specified contentType.
static java.util.Set<FileDocument>	FileDocument.getLockedDocumentSet(Workspace ws, Member mbr)	Returns the set of FileDocument which have a strong lock.
static java.lang.Class<? extends FileDocument>	FileDocument.getUploadClass(java.lang.String contentType)	Returns the FileDocument class to be used for the given contentType or null if no mapping is declared for this content-type.

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

Modifier and Type	Method	Description
static boolean	FileDocument.canUploadTracks(FileDocument doc, Member member)	Check if this document should allow member to add tracks to it.
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
ControllerStatus	FileDocument.mergeWith(FileDocument tgtDoc, Member loggedMember)	Merges this document with the given the document.
static FileDocument	JcmsUtil.rotateImageExif(FileDocument imageDoc)	Rotates the image based on the EXIF orientation (if needed).
static long	FileDocument.unzipToFileDocuments(java.io.File zipFile, java.io.FileFilter filter, FileDocument refFileDoc, Member opAuthor)	Unzip the specified File to n new FileDocument.

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

Modifier and Type	Method	Description
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... 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[] 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 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.util.List<java.lang.String> filenamesMainLanguageList, java.util.Map<java.lang.String,java.util.List<java.lang.String>> mlMap)	Adds the FileDocuments bound to the given list of filename and to the list of 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	Description
AssociatedFileFilter(FileDocument fileDoc)
DBFileDocument(FileDocument other)
FileDocument(FileDocument other)

Uses of FileDocument in com.jalios.jcms.calendar

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

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

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

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

Uses of FileDocument in com.jalios.jcms.document.editor

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

Modifier and Type	Method	Description
boolean	DocumentEditor.accept(FileDocument doc, Member mbr)	Returns true if the editor accepts the member to edit the document.
boolean	ImageDocumentEditor.accept(FileDocument doc, Member mbr)
java.util.List<DocumentEditor>	DocumentEditorPolicyManager.filterEditorList(java.util.List<DocumentEditor> editorList, FileDocument doc, Member mbr)
default java.lang.String	DocumentEditor.getButtonLabel(java.lang.String lang, FileDocument doc, Member mbr)	Return the localized label used for the button (if only this editor is available).
java.lang.String	ImageDocumentEditor.getButtonLabel(java.lang.String lang, FileDocument doc, Member mbr)
java.util.List<DocumentEditor>	DocumentEditorManager.getDocumentEditorList(FileDocument doc, Member mbr, java.lang.String lang)	Return the list of DocumentEditor available for the given document and the given member.
java.lang.String	DocumentEditor.getIcon(FileDocument doc, Member mbr)	Returns the 16x16-sized icon of the editor (icon property name without the icon.
java.lang.String	ImageDocumentEditor.getIcon(FileDocument doc, Member mbr)
default java.lang.String	DocumentEditor.getIcon48(FileDocument doc, Member mbr)	Returns the 48x48-sized icon of the editor (icon property name without the icon.
default java.lang.String	DocumentEditor.getLinkAttributes(java.lang.String lang, FileDocument doc, Member mbr)	Returns HTML attributes to add to the link.
java.lang.String	ImageDocumentEditor.getLinkAttributes(java.lang.String lang, FileDocument doc, Member mbr)
default java.lang.String	DocumentEditor.getMenuLabel(java.lang.String lang, FileDocument doc, Member mbr)	Return the localized label used in the dropdown menu.
java.lang.String	DocumentEditor.getUrl(FileDocument doc, Member mbr, java.lang.String baseUrl)	Returns the URL to open the document.
default java.lang.String	DocumentEditor.getUrl(FileDocument doc, Member mbr, java.lang.String baseUrl, OpeningMode mode)	Returns the URL to open the document.
java.lang.String	ImageDocumentEditor.getUrl(FileDocument doc, Member mbr, java.lang.String baseUrl)

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

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

Modifier and Type	Method	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	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	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	Description
FileDocument[]	MailEditHandler.getAvailableAttachements()
FileDocument	MergeFileDocumentHandler.getAvailableSrcDoc()
FileDocument	AssociatedPDFUploadHandler.getFileDocument()	Retrieve the FileDocument for which upload is being requested
FileDocument	EditFileDocumentHandler.getFileDocument()
FileDocument	JcmsUploadFormHandler.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	Description
java.util.List<java.lang.Class<? extends FileDocument>>	EditRemoteDocumentHandler.getDocumentClassList()
protected java.lang.Class<? extends FileDocument>	JcmsUploadFormHandler.getFileDocumentClass(java.lang.Class<? extends FileDocument> clazz, Member member, Workspace workspace)	Deprecated. The JcmsUploadFormHandler.getFileDocumentClass(Class, Member, Workspace, String) method is used directly by the JcmsUploadFormHandler.setFileDocuments(String, String, List) method.
protected java.lang.Class<? extends FileDocument>	JcmsUploadFormHandler.getFileDocumentClass(java.lang.Class<? extends FileDocument> clazz, Member member, Workspace workspace, java.lang.String contentType)	Returns the FileDocument Class authorized for publication by the specified member and workspace, and the most relevant regarding specified contentType.
protected java.util.List<? extends FileDocument>	JcmsUploadFormHandler.getFileDocuments(java.lang.String fieldName)	Returns the file documents from the field name.
protected java.util.List<? extends FileDocument>	JcmsUploadFormHandler.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<? extends FileDocument>>	JcmsUploadFormHandler.getFileDocumentsML(java.lang.String fieldName)	Returns the file documents from the field name for all the defined languages to the site.
java.lang.Class<? extends FileDocument>	EditRemoteDocumentHandler.getFirstDocumentClassAuthorized(java.lang.Class<? extends FileDocument> defaultValue)

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

Modifier and Type	Method	Description
protected void	JcmsUploadFormHandler.doPrepareFileDocuments(FileDocument fd, java.lang.String fieldName, java.lang.String language)	Prepares the new uploaded file document.
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	Description
protected boolean	JcmsUploadFormHandler.createUploadedFileDocument(java.util.List<? extends FileDocument> fileDocuments, Member author)	Performs create on given array of data if it is a FileDocument that have just been uploaded.
protected boolean	JcmsUploadFormHandler.createUploadedFileDocument(java.util.List<? extends FileDocument> fileDocuments, Member author, java.util.Map<?,?> context)	Performs create on given array of data if it is a FileDocument that have just been uploaded.
protected boolean	JcmsUploadFormHandler.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	JcmsUploadFormHandler.createUploadedFileDocument(java.util.Map<java.lang.String,java.util.List<FileDocument>> fileDocumentsML, Member author, java.util.Map<?,?> context)	Performs create on given array of data if it is a FileDocument that have just been uploaded.
protected java.lang.Class<? extends FileDocument>	JcmsUploadFormHandler.getFileDocumentClass(java.lang.Class<? extends FileDocument> clazz, Member member, Workspace workspace)	Deprecated. The JcmsUploadFormHandler.getFileDocumentClass(Class, Member, Workspace, String) method is used directly by the JcmsUploadFormHandler.setFileDocuments(String, String, List) method.
protected java.lang.Class<? extends FileDocument>	JcmsUploadFormHandler.getFileDocumentClass(java.lang.Class<? extends FileDocument> clazz, Member member, Workspace workspace, java.lang.String contentType)	Returns the FileDocument Class authorized for publication by the specified member and workspace, and the most relevant regarding specified contentType.
java.lang.Class<? extends FileDocument>	EditRemoteDocumentHandler.getFirstDocumentClassAuthorized(java.lang.Class<? extends FileDocument> defaultValue)
protected void	JcmsUploadFormHandler.setFileDocuments(java.lang.String fieldName, java.lang.String[] documents, java.lang.Class<? extends FileDocument> clazz)	Deprecated. use JcmsUploadFormHandler.setFileDocuments(String, String[], FileUploadOptions)
protected void	JcmsUploadFormHandler.setFileDocuments(java.lang.String fieldName, java.lang.String userLang, java.lang.String[] documents, java.lang.Class<? extends FileDocument> clazz)	Deprecated. use JcmsUploadFormHandler.setFileDocuments(String, String, String[], FileUploadOptions)
protected void	JcmsUploadFormHandler.setFileDocumentsML(java.lang.String fieldName, java.lang.String[] documents, java.lang.Class<? extends FileDocument> clazz)	Deprecated. use JcmsUploadFormHandler.setFileDocumentsML(String, String[], FileUploadOptions)
protected boolean	JcmsUploadFormHandler.validateUploadedFileDocument(java.util.List<? extends FileDocument> fileDocuments, Member author)	Validates the specified fileDocuments to upload.
protected boolean	JcmsUploadFormHandler.validateUploadedFileDocument(java.util.Map<java.lang.String,java.util.List<FileDocument>> fileDocumentsML, Member author)	Validates the specified fileDocuments to upload.

Uses of FileDocument in com.jalios.jcms.handler.pubchooser

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

Modifier and Type	Method	Description
FileDocument	PubChooserActionHandler.getAvailableFileDocument()

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

Modifier and Type	Method	Description
protected java.lang.Class<? extends FileDocument>	PubChooserActionHandler.getFileDocumentClass(java.lang.Class<? extends FileDocument> clazz, Member member, Workspace workspace)
protected java.lang.Class<? extends FileDocument>	PubChooserActionHandler.getFileDocumentClass(java.lang.Class<? extends FileDocument> clazz, Member member, Workspace workspace, java.lang.String contentType)

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

Modifier and Type	Method	Description
protected java.lang.Class<? extends FileDocument>	PubChooserActionHandler.getFileDocumentClass(java.lang.Class<? extends FileDocument> clazz, Member member, Workspace workspace)
protected java.lang.Class<? extends FileDocument>	PubChooserActionHandler.getFileDocumentClass(java.lang.Class<? extends FileDocument> clazz, Member member, Workspace workspace, java.lang.String contentType)

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	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	Description
MailMessage	MailMessage.addAttachements(FileDocument v)

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

Modifier and Type	Method	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	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

Subclasses of FileDocument in com.jalios.jcms.media

Modifier and Type	Class	Description
class	AbstractMedia

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

Modifier and Type	Field	Description
protected FileDocument	EditImageHandler.fd
protected FileDocument	MediaTracksHandler.media

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

Modifier and Type	Method	Description
FileDocument	TemplateInitialisationHandler.getFileDoc()
FileDocument	EditImageHandler.getFileDocument()
FileDocument	MediaTracksHandler.getMedia()	Retrieve the FileDocument for which upload is being requested

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

Modifier and Type	Method	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.

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

Modifier and Type	Method	Description
void	MediaProgressionManager.completeMediaProgression(FileDocument fileDocument, Member member)	Complete a media progression (set "completed" flag to true)
void	MediaProgressionManager.deleteAllMediaProgression(FileDocument fileDocument)	Delete all media progression
void	MediaProgressionManager.deleteMediaProgression(FileDocument fileDocument, Member member)	Delete a media progression
MediaProgression	MediaProgressionManager.getMediaProgression(FileDocument fileDocument, Member member)	Retrieve a media progression associated to a given FileDocument and Member
static boolean	MediaTracksHandler.isMediaTrackAuthorized(FileDocument doc)	Check if the Media track update can be proposed for the specified document.
MediaProgression	MediaProgressionManager.saveMediaProgression(FileDocument fileDocument, Member member, int progression)	Save a media progression
MediaProgression	MediaProgressionManager.saveMediaProgression(FileDocument fileDocument, Member member, int progression, java.util.Map<?,?> context)	Save a media progression

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

Constructor	Description
AbstractMedia(FileDocument other)

Uses of FileDocument in com.jalios.jcms.policy

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

Modifier and Type	Method	Description
boolean	BasicThumbnailPolicyFilter.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, boolean done)
boolean	BasicThumbnailPolicyFilter.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, 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.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)	Deprecated.
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.
java.util.List<DocumentEditor>	DocumentEditorPolicyFilter.filterEditorList(java.util.List<DocumentEditor> editorList, FileDocument doc, Member mbr)	Filter the DocumentEditors
java.lang.String	BasicRemoteDocumentPolicyFilter.getDownloadUrl(FileDocument remoteDocument)
java.lang.String	RemoteDocumentPolicyFilter.getDownloadUrl(FileDocument remoteDocument)
java.lang.String	RemoteDocumentPolicyManager.getDownloadUrl(FileDocument remoteDocument)
java.lang.String	BasicRemoteDocumentPolicyFilter.getRemotePreviewUrl(FileDocument remoteDocument)
java.lang.String	RemoteDocumentPolicyFilter.getRemotePreviewUrl(FileDocument remoteDocument)
java.lang.String	RemoteDocumentPolicyManager.getRemotePreviewUrl(FileDocument remoteDocument)
java.lang.String	BasicRemoteDocumentPolicyFilter.getRemoteThumbnailUrl(FileDocument remoteDocument)
java.lang.String	RemoteDocumentPolicyFilter.getRemoteThumbnailUrl(FileDocument remoteDocument)
java.lang.String	RemoteDocumentPolicyManager.getRemoteThumbnailUrl(FileDocument remoteDocument)
boolean	BasicRemoteDocumentPolicyFilter.previewWithIFrame(FileDocument remoteDocument)
boolean	RemoteDocumentPolicyFilter.previewWithIFrame(FileDocument remoteDocument)
boolean	RemoteDocumentPolicyManager.previewWithIFrame(FileDocument remoteDocument)
boolean	BasicRemoteDocumentPolicyFilter.previewWithMedia(FileDocument remoteDocument)
boolean	RemoteDocumentPolicyFilter.previewWithMedia(FileDocument remoteDocument)
boolean	RemoteDocumentPolicyManager.previewWithMedia(FileDocument remoteDocument)
boolean	BasicThumbnailPolicyFilter.supportsThumbnail(FileDocument doc, boolean jcms)
boolean	DefaultThumbnailPolicyFilter.supportsThumbnail(FileDocument doc)	Deprecated.
boolean	ThumbnailPolicyFilter.supportsThumbnail(FileDocument doc, boolean jcms)	Returns true if a thumbnail can be generated for the given document.

Uses of FileDocument in com.jalios.jcms.publiclink

Fields in com.jalios.jcms.publiclink with type parameters of type FileDocument

Modifier and Type	Field	Description
protected java.util.List<FileDocument>	PublicLink.docList

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

Modifier and Type	Method	Description
java.util.List<FileDocument>	EditPublicLinkHandler.getAvailableDocList()
java.util.List<FileDocument>	PublicLink.getDocList()
java.util.List<FileDocument>	PublicLink.getDocList(boolean modifiable)

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

Modifier and Type	Method	Description
PublicLinkQueryBuilder	PublicLinkQueryBuilder.document(FileDocument doc)
void	PublicLinkManager.processDocumentDeletion(FileDocument doc, Member opAuthor)	Delete or update PublicLink when a document is deleted

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

Modifier and Type	Method	Description
void	PublicLink.setDocList(java.util.List<FileDocument> v)

Uses of FileDocument in com.jalios.jcms.quota

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

Modifier and Type	Method	Description
void	QuotaManager.addDocumentToVersionCache(FileDocument fileDoc)	Add the current filename of the specified FileDocument to the cache.
void	QuotaManager.addDocumentVersionToVersionCache(FileDocument oldFileDoc, FileDocument fileDoc)	Add the current filename of the new FileDocument version to the cache.
void	QuotaManager.deleteDocumentFromVersionCache(FileDocument fileDoc)	Remove filename of the specified FileDocument from the cache.
java.util.List<java.lang.String>	QuotaManager.getCachedVersionList(FileDocument fileDoc)	Retrieve all filename previously cached for the specified FileDocument.
static FileQuotaInfos	QuotaManager.getFileQuotaInfos(FileDocument fileDoc)
void	QuotaManager.updateAfterFileDocumentChange(FileDocument fileDoc)	update quota after a filedocument change
void	QuotaManager.updateAfterFileDocumentDelete(FileDocument fileDoc)	update quota after a filedocument change

Uses of FileDocument in com.jalios.jcms.taglib

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

Modifier and Type	Field	Description
protected FileDocument	FileWebdavTag.doc

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

Modifier and Type	Method	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 java.io.File	ThumbnailTag.getThumbnailFile(FileDocument fileDoc, java.io.File srcFile, java.net.URL url, int maxWidth, int maxHeight, boolean square, java.lang.String extension)	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	FileIconTag.setDoc(FileDocument doc)
void	FileSizeTag.setDoc(FileDocument doc)
void	FileWebdavTag.setDoc(FileDocument doc)	This method set the FileDocument to open with webdav
void	PdfTag.setDoc(FileDocument doc)
void	MediaTag.setFileDoc(FileDocument fileDoc)
void	ThumbnailTag.setFileDoc(FileDocument fd)

Uses of FileDocument in com.jalios.jcms.test

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

Modifier and Type	Method	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.thumbnail

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

Modifier and Type	Method	Description
abstract boolean	AbstractThumbnailPolicyFilterImpl.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)
boolean	DefaultImageThumbnailPolicyFilter.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)
boolean	DefaultOpenOfficeThumbnailPolicyFilter.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)
boolean	DefaultOpenXmlThumbnailPolicyFilter.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)
boolean	ThumbnailPolicyManager.createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square)
boolean	AbstractThumbnailPolicyFilterImpl.supportsThumbnail(FileDocument doc)
boolean	ThumbnailPolicyManager.supportsThumbnail(FileDocument doc, boolean jcms)

Uses of FileDocument in com.jalios.jcms.uicomponent

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

Modifier and Type	Method	Description
static java.lang.String	LightboxUtils.getGlobalContentType(FileDocument doc)
static DataAttribute	LightboxUtils.getImageDataAttribute(FileDocument doc, java.lang.String userLang, java.util.Locale locale, Member mbr, boolean generateThumbnail)	Returns a DataAttribute containing all required parameters for javascript for lightbox / image editor
static java.lang.String	LightboxUtils.getLightboxActionLabel(java.lang.String userLang, java.lang.String propPrefix, FileDocument document)

Uses of FileDocument in com.jalios.jcms.uicomponent.image

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

Modifier and Type	Method	Description
void	DefaultResponsiveImageRenderer.render(org.jsoup.nodes.Element img, FileDocument fileDoc, int uiWidth, int uiHeight)	An empty implementation.
void	ResponsiveImageRenderer.render(org.jsoup.nodes.Element img, FileDocument fileDoc, int mediaTagWidth, int mediaTagHeight)

Uses of FileDocument in com.jalios.jcms.uicomponent.image.editor

Methods in com.jalios.jcms.uicomponent.image.editor with parameters of type FileDocument

Modifier and Type	Method	Description
boolean	ImageEditorManager.canModifyDocument(FileDocument doc, Member mbr)
DataAttribute	ImageEditorManager.getImageEditorContextDataAttributes(FileDocument fileDocument)	Returns a DataAttribute for a given FileDocument for the javascript library

Constructors in com.jalios.jcms.uicomponent.image.editor with parameters of type FileDocument

Constructor	Description
ImageEditorContext(FileDocument document)

Uses of FileDocument in com.jalios.jcms.upload

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

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

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

Modifier and Type	Method	Description
static FileDocument	DocUploadHandler.doUploadDocument(DocUploadInfo info, FileDocument document, java.util.function.Consumer<FileDocument> updateBlock, java.util.function.BiConsumer<FileDocument,FileDocument> workflowBlock, boolean removeFile, boolean unlock, Member mbr, java.lang.String userLang, java.util.HashMap<java.lang.String,java.lang.Object> context, java.util.Map<java.lang.String,java.lang.String> controllerFailedMap, java.util.List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList)
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	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)	Deprecated. Use {getFirstDocumentClassAuthorized(com.jalios.jcms.Member,com.jalios.jcms.workspace.Workspace)
java.lang.Class<? extends FileDocument>	FileUploadOptions.getPreferredClass()
java.lang.Class<? extends FileDocument>	DocUploadHandler.getSelectedDocumentClass(DocUploadInfo info)

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

Modifier and Type	Method	Description
static FileDocument	DocUploadHandler.doUploadDocument(DocUploadInfo info, FileDocument document, java.util.function.Consumer<FileDocument> updateBlock, java.util.function.BiConsumer<FileDocument,FileDocument> workflowBlock, boolean removeFile, boolean unlock, Member mbr, java.lang.String userLang, java.util.HashMap<java.lang.String,java.lang.Object> context, java.util.Map<java.lang.String,java.lang.String> controllerFailedMap, java.util.List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList)

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

Modifier and Type	Method	Description
static FileDocument	DocUploadHandler.doUploadDocument(DocUploadInfo info, FileDocument document, java.util.function.Consumer<FileDocument> updateBlock, java.util.function.BiConsumer<FileDocument,FileDocument> workflowBlock, boolean removeFile, boolean unlock, Member mbr, java.lang.String userLang, java.util.HashMap<java.lang.String,java.lang.Object> context, java.util.Map<java.lang.String,java.lang.String> controllerFailedMap, java.util.List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList)
static FileDocument	DocUploadHandler.doUploadDocument(DocUploadInfo info, FileDocument document, java.util.function.Consumer<FileDocument> updateBlock, java.util.function.BiConsumer<FileDocument,FileDocument> workflowBlock, boolean removeFile, boolean unlock, Member mbr, java.lang.String userLang, java.util.HashMap<java.lang.String,java.lang.Object> context, java.util.Map<java.lang.String,java.lang.String> controllerFailedMap, java.util.List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList)
static FileDocument	DocUploadHandler.doUploadDocument(DocUploadInfo info, FileDocument document, java.util.function.Consumer<FileDocument> updateBlock, java.util.function.BiConsumer<FileDocument,FileDocument> workflowBlock, boolean removeFile, boolean unlock, Member mbr, java.lang.String userLang, java.util.HashMap<java.lang.String,java.lang.Object> context, java.util.Map<java.lang.String,java.lang.String> controllerFailedMap, java.util.List<LuceneDataSearchEngine.IndexingLatch> indexingLatchList)
static java.lang.Class<? extends FileDocument>	DocUploadHandler.getFirstDocumentClassAuthorized(Member member, Workspace workspace, java.lang.Class<? extends FileDocument> defaultValue)	Deprecated. Use {getFirstDocumentClassAuthorized(com.jalios.jcms.Member,com.jalios.jcms.workspace.Workspace)
FileUploadOptions	FileUploadOptions.setPreferredClass(java.lang.Class<? extends FileDocument> preferredClass)	Set the FileDocument class to preferred for upload if enabled and authorized.

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

Constructor	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	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.

Uses of FileDocument in com.jalios.jcms.wysiwyg

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

Modifier and Type	Method	Description
static java.util.Set<FileDocument>	WysiwygMediasRewriter.extractMedias(java.lang.String html)	Find all the "object" tags in the specified html and extract the corresponding FileDocument.

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

Modifier and Type	Method	Description
protected void	WysiwygManager.addResponsiveImageAttributes(org.jsoup.nodes.Element img, FileDocument fileDoc, int mediaTagWidth, int mediaTagHeight)	Adds srcset HTML image tag attribute to allow client side browser to use the more relevant image regarding client viewport.

Uses of FileDocument in com.jalios.jcms.wysiwyg.image

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

Modifier and Type	Method	Description
void	WysiwygResponsiveImageRenderer.render(org.jsoup.nodes.Element img, FileDocument fileDoc, int uiWidth, int uiHeight)