FilesystemList class

A widget that displays a list of folders and files of the file system.

Inheritance

Constructors

FilesystemList({Key? key, bool isRoot = false, required Directory rootDirectory, FilesystemType fsType = FilesystemType.all, Color? folderIconColor, List<String>? allowedExtensions, required ValueChanged<Directory> onChange, required ValueSelected onSelect, required FileTileSelectMode fileTileSelectMode, FilesystemPickerFileListThemeData? theme, bool showGoUp = true, bool caseSensitiveFileExtensionComparison = false, ScrollController? scrollController, FilesystemListFilter? itemFilter})
Creates a list widget that displays a list of folders and files of the file system.
const

Properties

allowedExtensions → List<String>?
A list of file extensions, only files with the specified extensions will be displayed in the list. If the list is not specified or an empty list is specified, all files will be displayed. Does not affect the display of subfolders.
final
caseSensitiveFileExtensionComparison → bool
Specifies the mode of comparing extensions with the allowedExtensions list, case-sensitive or case-insensitive, by default it is insensitive.
final
fileTileSelectMode → FileTileSelectMode
Specifies how to files can be selected (either tapping on the whole tile or only on trailing button).
final
folderIconColor → Color?
The color of the folder icon in the list.
final
fsType → FilesystemType
The type of filesystem view (folder and files, folder only or files only), by default FilesystemType.all.
final
hashCode → int
The hash code for this object.
no setterinherited
isRoot → bool
Is the displayed directory the root directory? If yes, then the item .. will not be displayed at the beginning of the list to go to the parent directory.
final
itemFilter → FilesystemListFilter?
Specifies a callback to filter the displayed folders and files in the list; the filesystem entity, path to the file/directory and its name are passed to the callback, the callback should return a boolean value - to display the file/directory or not.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onChange → ValueChanged<Directory>
Called when the user has touched a subfolder list item.
final
onSelect → ValueSelected
Called when a file system item is selected.
final
rootDirectory → Directory
The displayed directory.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollController → ScrollController?
An object that can be used to control the position to which this list is scrolled.
final
showGoUp → bool
Specifies the option to display the go to the previous level of the file system in the filesystem view, the default is true.
final
theme → FilesystemPickerFileListThemeData?
Specifies a list theme in which colors, fonts, icons, etc. can be customized.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<FilesystemList>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited