Module xaos.ui

Package eu.ess.xaos.ui.control.tree.directory

Class TreeDirectoryItems

java.lang.Object

eu.ess.xaos.ui.control.tree.directory.TreeDirectoryItems

public class TreeDirectoryItems
extends Object

Containing the classes used by TreeDirectoryModel.

Author:

claudio.rosati@esss.se

See Also:

LiveDirsFX:org.fxmisc.livedirs.PathItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TreeDirectoryItems.DirectoryItem<T>	A TreeItem representing a directory.
static class	TreeDirectoryItems.FileItem<T>	A TreeItem representing a file.
static class	TreeDirectoryItems.PathItem<T>	An abstract class representing a TreeItem for a given Path.
static class	TreeDirectoryItems.TopLevelDirectoryItem<I,T>	A TreeItem representing a top-level directory, i.e.

Field Summary

Fields

Modifier and Type	Field	Description
static Function<Path,Path>	DEFAULT_INJECTOR	The default Function converting a Path into the object used as value in the corresponding TreeItem when the TreeItem generic type is just Path.
static Function<Path,Path>	DEFAULT_PROJECTOR	The default Function converting the object returned by TreeItem.getValue() into the corresponding Path when the TreeItem generic type is just Path.

Method Summary

Modifier and Type	Method	Description
static <T> TreeDirectoryItems.DirectoryItem<T>	createDirectoryItem(T path, TreeDirectoryModel.GraphicFactory graphicFactory, Function<T,Path> projector, Function<Path,T> injector)	Creates a new instance of TreeDirectoryItems.DirectoryItem for the given parameters.
static <T> TreeDirectoryItems.DirectoryItem<T>	createDirectoryItem(T path, TreeDirectoryModel.GraphicFactory graphicFactory, Function<T,Path> projector, Function<Path,T> injector, Consumer<? super TreeDirectoryItems.DirectoryItem<T>> onCollapse, Consumer<? super TreeDirectoryItems.DirectoryItem<T>> onExpand)	Creates a new instance of TreeDirectoryItems.DirectoryItem for the given parameters.
static <T> TreeDirectoryItems.FileItem<T>	createFileItem(T path, FileTime lastModified, TreeDirectoryModel.GraphicFactory graphicFactory, Function<T,Path> projector)	Creates a new instance of TreeDirectoryItems.FileItem for the given parameters.
static <I,T> TreeDirectoryItems.TopLevelDirectoryItem<I,T>	createTopLevelDirectoryItem(T path, TreeDirectoryModel.GraphicFactory graphicFactory, Function<T,Path> projector, Function<Path,T> injector, DirectoryModel.Reporter<I> reporter)	Creates a new instance of TreeDirectoryItems.TopLevelDirectoryItem for the given parameters.
static <I,T> TreeDirectoryItems.TopLevelDirectoryItem<I,T>	createTopLevelDirectoryItem(T path, TreeDirectoryModel.GraphicFactory graphicFactory, Function<T,Path> projector, Function<Path,T> injector, DirectoryModel.Reporter<I> reporter, Consumer<? super TreeDirectoryItems.DirectoryItem<T>> onCollapse, Consumer<? super TreeDirectoryItems.DirectoryItem<T>> onExpand)	Creates a new instance of TreeDirectoryItems.TopLevelDirectoryItem for the given parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_INJECTOR

public static final Function<Path,Path> DEFAULT_INJECTOR

The default Function converting a Path into the object used as value in the corresponding TreeItem when the TreeItem generic type is just Path.

DEFAULT_PROJECTOR

public static final Function<Path,Path> DEFAULT_PROJECTOR

The default Function converting the object returned by TreeItem.getValue() into the corresponding Path when the TreeItem generic type is just Path.

Method Detail

createDirectoryItem

public static <T> TreeDirectoryItems.DirectoryItem<T> createDirectoryItem(T path,
                                                                          TreeDirectoryModel.GraphicFactory graphicFactory,
                                                                          Function<T,Path> projector,
                                                                          Function<Path,T> injector)

Creates a new instance of TreeDirectoryItems.DirectoryItem for the given parameters.

Type Parameters:

T - Type of the object returned by TreeItem.getValue().

Parameters:

path - The value of this TreeItem.

graphicFactory - The factory class used to get an "icon" representing the created item.

projector - A Function converting the object returned by TreeItem.getValue() into the corresponding Path.

injector - A Function converting a Path into the object used as value in the corresponding TreeItem.

Returns:

A new instance ofTreeDirectoryItems.DirectoryItem.

createDirectoryItem

public static <T> TreeDirectoryItems.DirectoryItem<T> createDirectoryItem(T path,
                                                                          TreeDirectoryModel.GraphicFactory graphicFactory,
                                                                          Function<T,Path> projector,
                                                                          Function<Path,T> injector,
                                                                          Consumer<? super TreeDirectoryItems.DirectoryItem<T>> onCollapse,
                                                                          Consumer<? super TreeDirectoryItems.DirectoryItem<T>> onExpand)

Creates a new instance of TreeDirectoryItems.DirectoryItem for the given parameters.

Note that the TreeDirectoryItems.DirectoryItem.addChildDirectory(Path, TreeDirectoryModel.GraphicFactory) method will pass the given onCollapse and onExpand parameters to the newly created TreeDirectoryItems.DirectoryItem.

Type Parameters:

T - Type of the object returned by TreeItem.getValue().

Parameters:

path - The value of this TreeItem.

graphicFactory - The factory class used to get an "icon" representing the created item.

projector - A Function converting the object returned by TreeItem.getValue() into the corresponding Path.

injector - A Function converting a Path into the object used as value in the corresponding TreeItem.

onCollapse - A Consumer to be invoked when this item is collapsed. Can be null.

onExpand - A Consumer to be invoked when this item is expanded. Can be null.

Returns:

A new instance ofTreeDirectoryItems.DirectoryItem.

createFileItem

public static <T> TreeDirectoryItems.FileItem<T> createFileItem(T path,
                                                                FileTime lastModified,
                                                                TreeDirectoryModel.GraphicFactory graphicFactory,
                                                                Function<T,Path> projector)

Creates a new instance of TreeDirectoryItems.FileItem for the given parameters.

Type Parameters:

T - Type of the object returned by TreeItem.getValue().

Parameters:

path - The value of this TreeItem.

lastModified - The date of last modification for this item.

graphicFactory - The factory class used to get an "icon" representing the created item.

projector - A Function converting the object returned by TreeItem.getValue() into the corresponding Path.

Returns:

A new instance ofTreeDirectoryItems.FileItem.

createTopLevelDirectoryItem

public static <I,T> TreeDirectoryItems.TopLevelDirectoryItem<I,T> createTopLevelDirectoryItem(T path,
                                                                                                          TreeDirectoryModel.GraphicFactory graphicFactory,
                                                                                                          Function<T,Path> projector,
                                                                                                          Function<Path,T> injector,
                                                                                                          DirectoryModel.Reporter<I> reporter)

Creates a new instance of TreeDirectoryItems.TopLevelDirectoryItem for the given parameters.

Type Parameters:

I - Type of the initiator of changes to the model.

T - Type of the object returned by TreeItem.getValue().

Parameters:

path - The value of this TreeItem.

graphicFactory - The factory class used to get an "icon" representing the created item.

projector - A Function converting the object returned by TreeItem.getValue() into the corresponding Path.

injector - A Function converting a Path into the object used as value in the corresponding TreeItem.

reporter - The object reporting changes in the model.

Returns:

A new instance ofTreeDirectoryItems.TopLevelDirectoryItem.

createTopLevelDirectoryItem

public static <I,T> TreeDirectoryItems.TopLevelDirectoryItem<I,T> createTopLevelDirectoryItem(T path,
                                                                                                          TreeDirectoryModel.GraphicFactory graphicFactory,
                                                                                                          Function<T,Path> projector,
                                                                                                          Function<Path,T> injector,
                                                                                                          DirectoryModel.Reporter<I> reporter,
                                                                                                          Consumer<? super TreeDirectoryItems.DirectoryItem<T>> onCollapse,
                                                                                                          Consumer<? super TreeDirectoryItems.DirectoryItem<T>> onExpand)

Creates a new instance of TreeDirectoryItems.TopLevelDirectoryItem for the given parameters.

Note that the TreeDirectoryItems.DirectoryItem.addChildDirectory(Path, TreeDirectoryModel.GraphicFactory) method will pass the given onCollapse and onExpand parameters to the newly created TreeDirectoryItems.DirectoryItem.

Type Parameters:

I - Type of the initiator of changes to the model.

T - Type of the object returned by TreeItem.getValue().

Parameters:

path - The value of this TreeItem.

graphicFactory - The factory class used to get an "icon" representing the created item.

projector - A Function converting the object returned by TreeItem.getValue() into the corresponding Path.

injector - A Function converting a Path into the object used as value in the corresponding TreeItem.

reporter - The object reporting changes in the model.

onCollapse - A Consumer to be invoked when this item is collapsed. Can be null.

onExpand - A Consumer to be invoked when this item is expanded. Can be null.

Returns:

A new instance ofTreeDirectoryItems.TopLevelDirectoryItem.