Module xaos.ui

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

Class TreeDirectoryItems.DirectoryItem<T>

java.lang.Object

javafx.scene.control.TreeItem<T>

eu.ess.xaos.ui.control.tree.directory.TreeDirectoryItems.PathItem<T>

eu.ess.xaos.ui.control.tree.directory.TreeDirectoryItems.DirectoryItem<T>

Type Parameters:

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

All Implemented Interfaces:

EventTarget

Direct Known Subclasses:

TreeDirectoryItems.TopLevelDirectoryItem

Enclosing class:

TreeDirectoryItems

public static class TreeDirectoryItems.DirectoryItem<T>
extends TreeDirectoryItems.PathItem<T>

A TreeItem representing a directory.

Property Summary

Properties inherited from class javafx.scene.control.TreeItem

expanded, graphic, leaf, parent, value

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.control.TreeItem

TreeItem.TreeModificationEvent<T extends Object>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DirectoryItem(T path, Node collapsedGraphic, Node expandedGraphic, 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.

Method Summary

Modifier and Type	Method	Description
TreeDirectoryItems.DirectoryItem<T>	addChildDirectory(Path dir, TreeDirectoryModel.GraphicFactory graphicFactory)	Adds a new child representing a directory to this item.
TreeDirectoryItems.FileItem<T>	addChildFile(Path file, FileTime lastModified, TreeDirectoryModel.GraphicFactory graphicFactory)	Adds a new child representing a directory to this item.
Function<Path,T>	getInjector()
Consumer<? super TreeDirectoryItems.DirectoryItem<T>>	getOnCollapse()
Consumer<? super TreeDirectoryItems.DirectoryItem<T>>	getOnExpand()
T	inject(Path path)	Applies getInjector() to the given Path.
boolean	isDirectory()

Methods inherited from class eu.ess.xaos.ui.control.tree.directory.TreeDirectoryItems.PathItem

asDirectoryItem, asFileItem, getPath, getProjector, getRelativeChild, isLeaf, resolve

Methods inherited from class javafx.scene.control.TreeItem

addEventHandler, branchCollapsedEvent, branchExpandedEvent, buildEventDispatchChain, childrenModificationEvent, expandedItemCountChangeEvent, expandedProperty, getChildren, getGraphic, getParent, getValue, graphicChangedEvent, graphicProperty, isExpanded, leafProperty, nextSibling, nextSibling, parentProperty, previousSibling, previousSibling, removeEventHandler, setExpanded, setGraphic, setValue, toString, treeNotificationEvent, valueChangedEvent, valueProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryItem

protected DirectoryItem(T path,
                        Node collapsedGraphic,
                        Node expandedGraphic,
                        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 addChildDirectory(Path, TreeDirectoryModel.GraphicFactory) method will pass the given onCollapse and onExpand parameter to the newly created TreeDirectoryItems.DirectoryItem.

Parameters:

path - The value of this TreeItem.

collapsedGraphic - The graphic Node to be used when this item is collapsed.

expandedGraphic - The graphic Node to be used when this item is expanded.

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.

Method Detail

addChildDirectory

public TreeDirectoryItems.DirectoryItem<T> addChildDirectory(Path dir,
                                                             TreeDirectoryModel.GraphicFactory graphicFactory)

Adds a new child representing a directory to this item.

Parameters:

dir - The directory Path.

graphicFactory - The factory returning a suitable icon.

Returns:

The child TreeDirectoryItems.DirectoryItem.

addChildFile

public TreeDirectoryItems.FileItem<T> addChildFile(Path file,
                                                   FileTime lastModified,
                                                   TreeDirectoryModel.GraphicFactory graphicFactory)

Adds a new child representing a directory to this item.

Parameters:

file - The file Path.

lastModified - The file's last modification time.

graphicFactory - The factory returning a suitable icon.

Returns:

The child TreeDirectoryItems.FileItem.

getInjector

public final Function<Path,T> getInjector()

Returns:

A Function converting a Path into the object used as value in the correspondingTreeItem.

getOnCollapse

public Consumer<? super TreeDirectoryItems.DirectoryItem<T>> getOnCollapse()

Returns:

The Consumer invoked when this item is collapsed. Can be null.

getOnExpand

public Consumer<? super TreeDirectoryItems.DirectoryItem<T>> getOnExpand()

Returns:

The Consumer invoked when this item is expanded. Can be null.

inject

public final T inject(Path path)

Applies getInjector() to the given Path.

Parameters:

path - The Path to be converted.

Returns:

The value obtained applying getInjector() to the given Path.

isDirectory

public final boolean isDirectory()

Specified by:

isDirectory in class TreeDirectoryItems.PathItem<T>

Returns:

true if this item represents a directory.