Interface TreeFormatCustomization

All Known Implementing Classes:
TreeTableView

public interface TreeFormatCustomization
Customization of TreeTable formatting on a per-instance basis. Methods in this interface are invoked by TreeTableFormat.format(TreeTable, Appendable) before to format the tree. Non-null return values are merged with the TreeTableFormat configuration.
Design note: methods in this class are invoked for configuring the formatter before to write the tree. We do not use this interface as callbacks invoked for individual rows during formatting. The reason is that functions provided by this interface may need to manage a state (for example filtering may depend on previous rows) but we do not want to force implementations to store such state in TreeFormatCustomization instances since objects implementing this interface may be immutable.

This class is not yet in public API. We are waiting for more experience before to decide if it should be committed API.

Since:
1.0
Version:
1.0
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the tree node filter to use when formatting instances of the TreeTable.
  • Method Details

    • filter

      Returns the tree node filter to use when formatting instances of the TreeTable. If non-null, then the filter is combined with TreeTableFormat.getNodeFilter() by a "and" operation.
      Returns:
      the tree node filter to use for the TreeTable instance being formatted.