public class

StaticTreeDocument

extends AbstractTreeDocument
java.lang.Object
   ↳ com.pnfsoftware.jeb.util.events.EventSource
     ↳ com.pnfsoftware.jeb.core.output.tree.impl.AbstractTreeDocument
       ↳ com.pnfsoftware.jeb.core.output.tree.impl.StaticTreeDocument

Class Overview

A simple tree document. Such tree document objects do not listen to unit changes events; in fact, they are unaware of the IUnit family of classes. They are ideal to distribute static, immutable contents.

Clients should not extend this class. Clients requiring custom tree documents should either extend AbstractTreeDocument or implement ITreeDocument.

Summary

Public Constructors
StaticTreeDocument(INode root)
StaticTreeDocument(List<? extends INode> roots)
StaticTreeDocument(List<? extends INode> roots, List<String> columnLabels, int initialExpansionLevel)
Public Methods
List<String> getColumnLabels()
Provide column labels for table trees.
int getInitialExpansionLevel()
Get the ideal expansion level of the tree.
List<? extends INode> getRoots()
[Expand]
Inherited Methods
From class com.pnfsoftware.jeb.core.output.tree.impl.AbstractTreeDocument
From class com.pnfsoftware.jeb.util.events.EventSource
From class java.lang.Object
From interface com.pnfsoftware.jeb.core.output.IGenericDocument
From interface com.pnfsoftware.jeb.core.output.tree.ITreeDocument
From interface com.pnfsoftware.jeb.util.events.IEventSource

Public Constructors

public StaticTreeDocument (INode root)

public StaticTreeDocument (List<? extends INode> roots)

public StaticTreeDocument (List<? extends INode> roots, List<String> columnLabels, int initialExpansionLevel)

Public Methods

public List<String> getColumnLabels ()

Provide column labels for table trees. A regular tree should return null.

Returns
  • the column labels, in practice at least two elements

public int getInitialExpansionLevel ()

Get the ideal expansion level of the tree. Graphical clients should use this method when doing the initial rendering of a tree document.

Returns
  • the initial expansion level. Special values are: 0 to signify "expand nothing"; -1 to signify "expand all".

public List<? extends INode> getRoots ()