Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- add(T) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Adds the item to the list in sort order, if it is not already contained in the list.
- addAll(Collection) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Adds all items of the collection to the list in sort order, if not already contained in the list.
- addAllSubNodes(Collection) - Method in interface de.bernd_michaely.common.filesystem.view.base.NodeView
-
The implementation must append the given subNodeViews in the collections iteration order.
B
- build() - Method in class de.bernd_michaely.common.filesystem.view.base.Configuration.Builder
-
Returns the final Configuration.
- builder() - Static method in record class de.bernd_michaely.common.filesystem.view.base.Configuration
-
Returns a builder instance.
C
- clear() - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
- clear() - Method in interface de.bernd_michaely.common.filesystem.view.base.NodeView
-
The implementation must remove all sub nodes.
- clearSelection() - Method in interface de.bernd_michaely.common.filesystem.view.base.IFileSystemTreeView
-
Clears the current path selection.
- close() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.NodeCtrlFileSystemRootsGlobal
- close() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.WatchServiceCtrl
- comparator() - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Returns the configured comparator.
- Configuration - Record Class in de.bernd_michaely.common.filesystem.view.base
-
Configuration with builder for file system tree view factories.
- Configuration(FileSystem, boolean, Comparator, UserNodeConfiguration) - Constructor for record class de.bernd_michaely.common.filesystem.view.base.Configuration
-
Creates an instance of a
Configurationrecord class. - Configuration.Builder - Class in de.bernd_michaely.common.filesystem.view.base
-
Builder for file system tree view configurations.
- contains(Object) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Searches the collection for the given object.
- containsItem(T) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Searches the collection for the given item.
- create(Configuration, Function) - Static method in class de.bernd_michaely.common.filesystem.view.base.ctrl.NodeCtrlFileSystemRootsGlobal
-
Factory method to construct the tree overall root node.
- create(Configuration, Function) - Static method in interface de.bernd_michaely.common.filesystem.view.base.RootNodeCtrl
-
Factory method to construct the tree overall root node.
- createFileSystemFor(Path) - Method in interface de.bernd_michaely.common.filesystem.view.base.UserNodeConfiguration
-
This method can optionally return a FileSystem for a file path.
D
- de.bernd_michaely.common.filesystem.view.base - module de.bernd_michaely.common.filesystem.view.base
-
Base module for a file system view containing the common control logic.
- de.bernd_michaely.common.filesystem.view.base - package de.bernd_michaely.common.filesystem.view.base
-
Base package of base module of FileSystemTreeView component.
- de.bernd_michaely.common.filesystem.view.base.common - package de.bernd_michaely.common.filesystem.view.base.common
-
This package contains commonly reusable code.
- de.bernd_michaely.common.filesystem.view.base.ctrl - package de.bernd_michaely.common.filesystem.view.base.ctrl
-
Internal control sub package of base module of FileSystemTreeView component.
- DEFAULT_LINK_OPTIONS - Static variable in interface de.bernd_michaely.common.filesystem.view.base.UserNodeConfiguration
-
The default link options, an empty array, which means that symbolic links are always followed.
- DirectoryEntry - Class in de.bernd_michaely.common.filesystem.view.base.ctrl
-
Class to represent a directory entry.
- DirectoryEntryFileSystem - Class in de.bernd_michaely.common.filesystem.view.base.ctrl
-
DirectoryEntry implementation for the global filesystem.
- DirectoryEntryRegularFile - Class in de.bernd_michaely.common.filesystem.view.base.ctrl
-
DirectoryEntry implementation for files.
- DirectoryEntrySubDirectory - Class in de.bernd_michaely.common.filesystem.view.base.ctrl
-
DirectoryEntry implementation for subdirectories.
- DirectoryReaderTask - Class in de.bernd_michaely.common.filesystem.view.base.ctrl
-
Task for reading filesystem roots and directory entries.
E
- equals(Object) - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.DirectoryEntry
- equals(Object) - Method in record class de.bernd_michaely.common.filesystem.view.base.Configuration
-
Indicates whether some other object is "equal to" this one.
- expandPath(Path, boolean) - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.NodeCtrlFileSystemRootsGlobal
- expandPath(Path, boolean) - Method in interface de.bernd_michaely.common.filesystem.view.base.RootNodeCtrl
-
Expands the given path in the tree view.
- expandPath(Path, boolean, boolean) - Method in interface de.bernd_michaely.common.filesystem.view.base.IFileSystemTreeView
-
Expands and optionally selects the given path in the tree view.
F
- fileNameComparator() - Method in record class de.bernd_michaely.common.filesystem.view.base.Configuration
-
Returns the value of the
fileNameComparatorrecord component. - fileSystem() - Method in record class de.bernd_michaely.common.filesystem.view.base.Configuration
-
Returns the value of the
fileSystemrecord component. - FileSystemTreeViewVersion - Class in de.bernd_michaely.common.filesystem.view.base
-
Class to retrieve the semantic version of this and related modules.
- FileSystemTreeViewVersion() - Constructor for class de.bernd_michaely.common.filesystem.view.base.FileSystemTreeViewVersion
-
Protected constructor.
G
- get(int) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Returns the list item at the given index.
- getBaseModuleVersion() - Static method in class de.bernd_michaely.common.filesystem.view.base.FileSystemTreeViewVersion
-
Returns the semantic version of the base module.
- getComparator() - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Deprecated.
- getDefault() - Static method in record class de.bernd_michaely.common.filesystem.view.base.Configuration
-
Returns a default configuration.
- getExpandedPaths() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.NodeCtrl
-
Returns the currently expanded paths of the sub tree of this node.
- getExpandedPaths() - Method in interface de.bernd_michaely.common.filesystem.view.base.IFileSystemTreeView
-
Returns the set of paths currently expanded.
- getExpandedPaths() - Method in interface de.bernd_michaely.common.filesystem.view.base.RootNodeCtrl
-
Returns the set of paths currently expanded.
- getInstance() - Static method in class de.bernd_michaely.common.filesystem.view.base.SimpleUserNodeConfiguration
-
Returns the singleton instance.
- getLinkOptions() - Method in interface de.bernd_michaely.common.filesystem.view.base.UserNodeConfiguration
-
Returns the matching LinkOptions.
- getName() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.DirectoryEntry
-
Returns a name for this path.
- getName() - Method in interface de.bernd_michaely.common.filesystem.view.base.PathView
-
Returns a name for this path.
- getNodeView() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.NodeCtrl
-
Returns the corresponding node view.
- getNodeView() - Method in interface de.bernd_michaely.common.filesystem.view.base.RootNodeCtrl
-
Returns the corresponding node view.
- getOnItemsAdd() - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Returns a previously set event handler.
- getOnItemsAddAll() - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Returns a previously set event handler.
- getOnItemsClear() - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Returns a previously set event handler.
- getOnItemsRemove() - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Returns a previously set event handler.
- getPath() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.DirectoryEntryFileSystem
- getPath() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.DirectoryEntryRegularFile
- getPath() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.DirectoryEntrySubDirectory
- getPath() - Method in interface de.bernd_michaely.common.filesystem.view.base.PathView
-
Returns the encapsulated path.
- getSelectedPath() - Method in interface de.bernd_michaely.common.filesystem.view.base.IFileSystemTreeView
-
Returns the currently selected path.
- getSymbolicLinkTarget() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.DirectoryEntry
- getSymbolicLinkTarget() - Method in interface de.bernd_michaely.common.filesystem.view.base.PathView
-
If the path is a symbolic link, returns the symbolic link target.
- getUserNodeConfigurationFor(Path) - Method in class de.bernd_michaely.common.filesystem.view.base.SimpleUserNodeConfiguration
-
Returns the singleton instance.
- getUserNodeConfigurationFor(Path) - Method in interface de.bernd_michaely.common.filesystem.view.base.UserNodeConfiguration
-
Factory method to create configurations per node.
H
- handleNodeExpansion(boolean) - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.DirectoryEntry
- handleNodeExpansion(boolean) - Method in interface de.bernd_michaely.common.filesystem.view.base.PathView
-
Notifies the file system tree about the node being expanded or collapsed.
- hashCode() - Method in record class de.bernd_michaely.common.filesystem.view.base.Configuration
-
Returns a hash code value for this object.
- hashCode() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.DirectoryEntry
I
- IFileSystemTreeView - Interface in de.bernd_michaely.common.filesystem.view.base
-
Interface describing common API for file system tree views.
- Implementation notes - Section in module de.bernd_michaely.common.filesystem.view.base
- Implementation notes - Section in package de.bernd_michaely.common.filesystem.view.base.ctrl
- indexOfItem(T) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Returns the index of the given item in the list, if the list contains the item, or a negative value otherwise.
- insertSubNodes(SortedMap) - Method in interface de.bernd_michaely.common.filesystem.view.base.NodeView
-
The implementation must insert the given SubNodeViews at the given indices in the given sort order.
- isCreatingNodeForDirectory(Path) - Method in interface de.bernd_michaely.common.filesystem.view.base.UserNodeConfiguration
-
A predicate to indicate which subdirectories to create a node for.
- isCreatingNodeForFile(Path) - Method in interface de.bernd_michaely.common.filesystem.view.base.UserNodeConfiguration
-
A predicate to indicate which files to create a node for.
- isLeafNode(Path) - Method in interface de.bernd_michaely.common.filesystem.view.base.UserNodeConfiguration
-
If this method returns true, the node is conceptually treated as a leaf node.
- isPathSelected() - Method in interface de.bernd_michaely.common.filesystem.view.base.IFileSystemTreeView
-
Returns true, iff a path is currently selected.
- isRequestingUpdateNotifier() - Method in interface de.bernd_michaely.common.filesystem.view.base.UserNodeConfiguration
-
To receive an update notifier callback object for the corresponding tree node, this method must return true.
- isWatchingFileSystemRoots() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.NodeCtrlFileSystemRootsGlobal
- isWatchingFileSystemRoots() - Method in interface de.bernd_michaely.common.filesystem.view.base.RootNodeCtrl
-
Returns true, iff the file system roots are watched for changes.
- iterator() - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
N
- NodeConfig - Class in de.bernd_michaely.common.filesystem.view.base.ctrl
-
Class to describe a configuration global to all tree nodes.
- NodeCtrl - Class in de.bernd_michaely.common.filesystem.view.base.ctrl
-
Base class for controller classes for tree nodes.
- NodeCtrlFileSystemRootsGlobal - Class in de.bernd_michaely.common.filesystem.view.base.ctrl
-
Controller class for the tree global root node.
- NodeView - Interface in de.bernd_michaely.common.filesystem.view.base
-
Encapsulation of the actual tree node UI component.
- Note: - Section in de.bernd_michaely.common.filesystem.view.base.RootNodeCtrl.create(Configuration, Function)
- Note: - Section in de.bernd_michaely.common.filesystem.view.base.ctrl.NodeCtrlFileSystemRootsGlobal.create(Configuration, Function)
O
- onClosingFileSystem(FileSystem) - Method in interface de.bernd_michaely.common.filesystem.view.base.UserNodeConfiguration
-
This method is called when a FileSystem is to be closed.
P
- PathView - Interface in de.bernd_michaely.common.filesystem.view.base
-
Encapsulation of a Path object for tree node UI user object.
R
- readVersionResource(Class, String) - Static method in class de.bernd_michaely.common.filesystem.view.base.FileSystemTreeViewVersion
-
Reads a version String from a resource file in the package from the given class.
- remove(int) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Removes the element at the given position.
- remove(Object) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
- removeItem(T) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Removes the given item from this list, if present.
- removeSubNodes(List) - Method in interface de.bernd_michaely.common.filesystem.view.base.NodeView
-
The implementation must remove the sub nodes at the given indices in the order given by the list.
- requestWatchService() - Method in record class de.bernd_michaely.common.filesystem.view.base.Configuration
-
Returns the value of the
requestWatchServicerecord component. - RESOURCE_NAME - Static variable in class de.bernd_michaely.common.filesystem.view.base.FileSystemTreeViewVersion
-
The name of the resource file containing the semantic version.
- RootNodeCtrl - Interface in de.bernd_michaely.common.filesystem.view.base
-
Interface to describe the global root node control.
- run() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.DirectoryReaderTask
S
- setExpanded(boolean) - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.NodeCtrl
-
Expand or collapse this node.
- setExpanded(boolean) - Method in interface de.bernd_michaely.common.filesystem.view.base.NodeView
-
Sets the expanded state of the node view.
- setExpanded(boolean) - Method in interface de.bernd_michaely.common.filesystem.view.base.RootNodeCtrl
-
Expand or collapse this node.
- setExpandedPaths(Iterable) - Method in interface de.bernd_michaely.common.filesystem.view.base.RootNodeCtrl
-
Expands all given paths.
- setFileNameComparator(Comparator) - Method in class de.bernd_michaely.common.filesystem.view.base.Configuration.Builder
-
Sets a filename comparator.
- setFileSystem(FileSystem) - Method in class de.bernd_michaely.common.filesystem.view.base.Configuration.Builder
-
Sets a file system.
- setLeafNode(boolean) - Method in interface de.bernd_michaely.common.filesystem.view.base.NodeView
-
Determines, whether this node is conceptually a leaf node.
- setOnItemsAdd(SynchronizableSortedDistinctList.ItemsAddHandler) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Set an event handler to receive notifications about added single elements.
- setOnItemsAddAll(SynchronizableSortedDistinctList.ItemsAddAllHandler) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Set an event handler to receive notifications about a bulk add operation.
- setOnItemsClear(SynchronizableSortedDistinctList.ItemsClearHandler) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Set an event handler to receive notifications about a bulk remove operation.
- setOnItemsRemove(SynchronizableSortedDistinctList.ItemsRemoveHandler) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Set an event handler to receive notifications about removed single elements.
- setRequestingWatchService(boolean) - Method in class de.bernd_michaely.common.filesystem.view.base.Configuration.Builder
-
Set to true to request a watch service.
- setUpdateNotifier(Runnable) - Method in interface de.bernd_michaely.common.filesystem.view.base.UserNodeConfiguration
-
Set a notifier callback for tree node updates.
- setUserNodeConfiguration(UserNodeConfiguration) - Method in class de.bernd_michaely.common.filesystem.view.base.Configuration.Builder
-
Sets a user node configuration.
- SimpleUserNodeConfiguration - Class in de.bernd_michaely.common.filesystem.view.base
-
A simple node configuration to show non hidden directories only.
- size() - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
- spliterator() - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
- SubNodes - Class in de.bernd_michaely.common.filesystem.view.base.ctrl
-
Class for synchronized access to directory entry sub nodes.
- SynchronizableSortedDistinctList<T> - Class in de.bernd_michaely.common.filesystem.view.base.common
-
A list implementation to keep a sorted list of distinct items which can be continuously adapted to a target state, tracking adding and removing of list items by callbacks.
- SynchronizableSortedDistinctList() - Constructor for class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Creates a new instance using a
nullcomparator. - SynchronizableSortedDistinctList(SynchronizableSortedDistinctList) - Constructor for class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Creates a new instance using a given instance.
- SynchronizableSortedDistinctList(Comparator) - Constructor for class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Creates a new instance using a given comparator.
- SynchronizableSortedDistinctList(Collection) - Constructor for class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Creates a new instance initialized with the elements of the given collection.
- SynchronizableSortedDistinctList.ItemsAddAllHandler<T> - Interface in de.bernd_michaely.common.filesystem.view.base.common
-
Event handler for adding all elements of a collection to an empty list.
- SynchronizableSortedDistinctList.ItemsAddHandler - Interface in de.bernd_michaely.common.filesystem.view.base.common
-
Event handler for adding elements.
- SynchronizableSortedDistinctList.ItemsClearHandler<T> - Interface in de.bernd_michaely.common.filesystem.view.base.common
-
Event handler for clearing the whole list.
- SynchronizableSortedDistinctList.ItemsRemoveHandler - Interface in de.bernd_michaely.common.filesystem.view.base.common
-
Event handler for removing elements.
- synchronizeTo(Collection) - Method in class de.bernd_michaely.common.filesystem.view.base.common.SynchronizableSortedDistinctList
-
Synchronizes the content of this list with the content of the given data.
T
- toString() - Method in record class de.bernd_michaely.common.filesystem.view.base.Configuration
-
Returns a string representation of this record class.
- toString() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.DirectoryEntry
-
Provides a path name suitable for display in a UI.
- toString() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.NodeCtrl
U
- UML diagrams - Section in package de.bernd_michaely.common.filesystem.view.base.ctrl
- updateTree() - Method in class de.bernd_michaely.common.filesystem.view.base.ctrl.NodeCtrlFileSystemRootsGlobal
- updateTree() - Method in interface de.bernd_michaely.common.filesystem.view.base.IFileSystemTreeView
-
Update the whole tree view.
- updateTree() - Method in interface de.bernd_michaely.common.filesystem.view.base.RootNodeCtrl
-
Updates the content of the whole tree view.
- userNodeConfiguration() - Method in record class de.bernd_michaely.common.filesystem.view.base.Configuration
-
Returns the value of the
userNodeConfigurationrecord component. - UserNodeConfiguration - Interface in de.bernd_michaely.common.filesystem.view.base
-
Clients may implement this interface and provide an instance to the
Configuration.Builderto create a custom configuration for the file system view component.
W
- WatchServiceCtrl - Class in de.bernd_michaely.common.filesystem.view.base.ctrl
-
Class to describe the configuration and availability of a watch service.
All Classes and Interfaces|All Packages|Constant Field Values
SynchronizableSortedDistinctList.comparator()instead