Module xaos.ui

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

Class TreeDirectoryItems.TopLevelDirectoryItem<I,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>

eu.ess.xaos.ui.control.tree.directory.TreeDirectoryItems.TopLevelDirectoryItem<I,T>

Type Parameters:

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

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

All Implemented Interfaces:

EventTarget

Enclosing class:

TreeDirectoryItems

public static class TreeDirectoryItems.TopLevelDirectoryItem<I,T>
extends TreeDirectoryItems.DirectoryItem<T>

A TreeItem representing a top-level directory, i.e. the root directory for the tree model.

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	TopLevelDirectoryItem(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.

Method Summary

Modifier and Type	Method	Description
void	addDirectory(Path relativePath, I initiator)	Adds a directory to the model rooted at this item.
void	addFile(Path relativePath, FileTime lastModified, I initiator)	Adds a file to the model rooted at this item.
boolean	contains(Path relativePath)
void	remove(Path relativePath, I initiator)	Removes the given Path from the model rooted at this item.
void	sync(Path root, I initiator)	Adds to the model rooted at this item all the subdirectories and files rooted at the given Path element.
void	updateModificationTime(Path relativePath, FileTime lastModified, I initiator)	Updates the modification time for the item associated to the given Path.

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

addChildDirectory, addChildFile, getInjector, getOnCollapse, getOnExpand, inject, 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

TopLevelDirectoryItem

protected TopLevelDirectoryItem(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 parameter to the newly created TreeDirectoryItems.DirectoryItem.

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.

Method Detail

addDirectory

public void addDirectory(Path relativePath,
                         I initiator)

Adds a directory to the model rooted at this item.

Parameters:

relativePath - The directory Path.

initiator - The initiator of changes to the model.

addFile

public void addFile(Path relativePath,
                    FileTime lastModified,
                    I initiator)

Adds a file to the model rooted at this item.

Parameters:

relativePath - The file Path.

lastModified - The file's last modification time.

initiator - The initiator of changes to the model.

contains

public boolean contains(Path relativePath)

Parameters:

relativePath - The Path to be checked.

Returns:

true if the given Path is contained in the model rooted at this item.

remove

public void remove(Path relativePath,
                   I initiator)

Removes the given Path from the model rooted at this item.

Parameters:

relativePath - The Path to be removed from the model rooted at this item.

initiator - The initiator of changes to the model.

sync

public void sync(Path root,
                 I initiator)

Adds to the model rooted at this item all the subdirectories and files rooted at the given Path element.

Parameters:

root - The path to be synchronized.

initiator - The initiator of changes to the model.

updateModificationTime

public void updateModificationTime(Path relativePath,
                                   FileTime lastModified,
                                   I initiator)

Updates the modification time for the item associated to the given Path.

Parameters:

relativePath - The path whose associated item must be updated.

lastModified - The new modification time.

initiator - The initiator of changes to the model.