uk.co.strangeskies.fx

Interface TreeContribution<T>

Type Parameters:

T - the type of data item to apply to

All Known Subinterfaces:

EclipseTreeContribution<T>, PseudoClassTreeCellContribution<T>, TreeCellContribution<T>, TreeChildContribution<T>, TreeTextContribution<T>

All Known Implementing Classes:

CommandTreeCellContribution, DefaultTreeCellContribution, MenuTreeCellContribution

public interface TreeContribution<T>

A type of contribution for items in a ModularTreeView. Tree contributions may optionally extend interfaces such as TreeTextContribution, TreeCellContribution, and TreeChildContribution to provide behavior and information for the tree items which the contribution applies to.

Tree items may apply to all items in a tree of the appropriate type, and which also satisfy any condition specified via implementation of appliesTo(TreeItemData).

Method Summary

Modifier and Type	Method and Description
default <U extends T> boolean	appliesTo(TreeItemData<U> data) Determine whether the contribution should be applied to the given data item.
default TypeToken<T>	getDataType() Get the type of item which the contribution applies to.

Method Detail

getDataType

default TypeToken<T> getDataType()

Get the type of item which the contribution applies to. It is possible to include wildcards in the type, and any tree item whose type is assignable to this type are suitable for application of this contribution.

Returns:

the type of data item to apply to

appliesTo

default <U extends T> boolean appliesTo(TreeItemData<U> data)

Determine whether the contribution should be applied to the given data item. This method will only be invoked after getDataType() has checked against the exact item type.

Type Parameters:

U - the specific type of the tree item

Parameters:

data - a data item in the tree

Returns:

true if the contribution is applicable, false otherwise