Package de.xima.fc.gui.elfinder

Interface IElFinderFileSystemOptionsProvider<Entry extends IFileSystemEntry<?>>

  • Type Parameters:
    Entry - Common super type of all file system entries.
    All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    DefaultElFinderFileSystemOptionsProvider
    public interface IElFinderFileSystemOptionsProvider<Entry extends IFileSystemEntry<?>>
extends Serializable
    Provider for the settings of file system entries, e.g. whether the directory of file is read-only, or how many files can be uploaded.
    Since:
    8.3.0
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • canDetectUpdateByTimestamp

        boolean canDetectUpdateByTimestamp​(String volume,
                                   ICommonFileSystemManager<Entry> fileSystemManager)
        Whether the file system of the given volume supports detecting updates by comparing the timestamp of the file or directory with the last known modification timestamp. Corresponds to the syncChkAsTs settings from elFinder.
        Parameters:
        volume - The volume of the file system.
        fileSystemManager - The current file system manager.
        Returns:
        Whether the file system supports detecting updates by timestamp.

      • canRead

        boolean canRead​(Entry entry,
                ICommonFileSystemManager<Entry> fileSystemManager)
        Whether the file or directory can be read.
        Parameters:
        entry - The file or directory.
        fileSystemManager - The current file system manager.
        Returns:
        Whether the file or directory can be read.

      • canWrite

        boolean canWrite​(Entry entry,
                 ICommonFileSystemManager<Entry> fileSystemManager)
        Whether the file or directory can be written to.
        Parameters:
        entry - The file or directory.
        fileSystemManager - The current file system manager.
        Returns:
        Whether the file or directory can be written to.

      • cssClass

        String cssClass​(Entry entry,
                ICommonFileSystemManager<Entry> fileSystemManager)
        Gets the optional CSS class for the file or directory. Can be used e.g. to display different icons for different file types.
        Parameters:
        entry - The file or directory.
        fileSystemManager - The current file system manager.
        Returns:
        The optional CSS class for the file or directory. Can be null or empty.

      • disabledCommands

        Set<String> disabledCommands​(String volume,
                             ICommonFileSystemManager<Entry> fileSystemManager)
        Gets a list of commands not allowed on the given volume.
        Parameters:
        volume - The volume.
        fileSystemManager - The current file system manager.
        Returns:
        A set of commands not allowed on the given volume.

      • displayName

        String displayName​(Entry entry,
                   ICommonFileSystemManager<Entry> fileSystemManager,
                   Locale locale)
        Gets the name of the given entry. This can be just the file name, or some localized display name.
        Parameters:
        entry - The file or directory.
        fileSystemManager - The current file system manager.
        locale - The locale to use for localization.
        Returns:
        The display name of the file or directory.

      • filePathSeparator

        String filePathSeparator​(String volume,
                         ICommonFileSystemManager<Entry> fileSystemManager)
        Separator for file paths in the file system for a given volume. Usually "/" or "\".
        Parameters:
        volume - The volume of the file system.
        fileSystemManager - The current file system manager.
        Returns:
        The file path separator.

      • jpegQuality

        int jpegQuality​(Entry entry,
                ICommonFileSystemManager<Entry> fileSystemManager)
        Gets the quality of JPEG images when resizing, cropping, or rotating JPEG images.
        Parameters:
        entry - The file entry.
        fileSystemManager - The current file system manager.
        Returns:
        The quality of JPEG images, between 0 and 100.

      • localizeDirectoryName

        boolean localizeDirectoryName​(String volume,
                              ICommonFileSystemManager<Entry> fileSystemManager)
        Whether to localize the directory name in the elFinder UI. Uses elFinderInstance.messages['folder_'+name] in the client-side JavaScript.
        Parameters:
        volume - The volume.
        fileSystemManager - The current file system manager.
        Returns:
        Whether to localize the directory names in that volume.

      • locked

        boolean locked​(Entry entry,
               ICommonFileSystemManager<Entry> fileSystemManager)
        Whether the file or directory is locked and cannot be modified.
        Parameters:
        entry - The file or directory.
        fileSystemManager - The current file system manager.
        Returns:
        Whether the file or directory is locked.

      • overwriteExistingFilesOnCopy

        boolean overwriteExistingFilesOnCopy​(String volume,
                                     ICommonFileSystemManager<Entry> fileSystemManager)
        Whether to overwrite files with the same name on the given volume when copying files.
        Parameters:
        volume - The volume.
        fileSystemManager - The current file system manager.
        Returns:
        Whether to overwrite files with the same name on the given volume when copying files.

      • overwriteExistingFilesOnUpload

        boolean overwriteExistingFilesOnUpload​(String volume,
                                       ICommonFileSystemManager<Entry> fileSystemManager)
        Whether to overwrite files with the same name on the given volume when uploading files.
        Parameters:
        volume - The volume.
        fileSystemManager - The current file system manager.
        Returns:
        Whether to overwrite files with the same name on the given volume when uploading files.