EntryPointNode

class EntryPointNode( builder: AvailBuilder, val resolvedModuleName: ResolvedModuleName, val entryPointString: String) : AbstractBuilderFrameTreeNode

This is a tree node representing an entry point of some module. The parent tree node should be an EntryPointModuleNode.

Author

Mark van Gulik

Parameters

builder

The builder for which this node is being built.

resolvedModuleName

The name of the module defining the entry point.

entryPointString

The name of the entry point.

Constructors

EntryPointNode

fun EntryPointNode( builder: AvailBuilder, resolvedModuleName: ResolvedModuleName, entryPointString: String)

Construct a new EntryPointNode, given the name of the module and the name of the entry point.

Functions

add

open fun add(p0: MutableTreeNode)

breadthFirstEnumeration

open fun breadthFirstEnumeration(): Enumeration<TreeNode>

children

open override fun children(): Enumeration<TreeNode>

clone

open override fun clone(): Any

compareTo

open operator override fun compareTo(other: AbstractBuilderFrameTreeNode): Int

Order this node against another.

depthFirstEnumeration

open fun depthFirstEnumeration(): Enumeration<TreeNode>

getAllowsChildren

open override fun getAllowsChildren(): Boolean

getChildAfter

open fun getChildAfter(p0: TreeNode): TreeNode

getChildAt

open override fun getChildAt(p0: Int): TreeNode

getChildBefore

open fun getChildBefore(p0: TreeNode): TreeNode

getChildCount

open override fun getChildCount(): Int

getDepth

open fun getDepth(): Int

getFirstChild

open fun getFirstChild(): TreeNode

getFirstLeaf

open fun getFirstLeaf(): DefaultMutableTreeNode

getIndex

open override fun getIndex(p0: TreeNode): Int

getLastChild

open fun getLastChild(): TreeNode

getLastLeaf

open fun getLastLeaf(): DefaultMutableTreeNode

getLeafCount

open fun getLeafCount(): Int

getLevel

open fun getLevel(): Int

getNextLeaf

open fun getNextLeaf(): DefaultMutableTreeNode

getNextNode

open fun getNextNode(): DefaultMutableTreeNode

getNextSibling

open fun getNextSibling(): DefaultMutableTreeNode

getParent

open override fun getParent(): TreeNode

getPath

open fun getPath(): Array<TreeNode>

getPreviousLeaf

open fun getPreviousLeaf(): DefaultMutableTreeNode

getPreviousNode

open fun getPreviousNode(): DefaultMutableTreeNode

getPreviousSibling

open fun getPreviousSibling(): DefaultMutableTreeNode

getRoot

open fun getRoot(): TreeNode

getSharedAncestor

open fun getSharedAncestor(p0: DefaultMutableTreeNode): TreeNode

getSiblingCount

open fun getSiblingCount(): Int

getUserObject

open fun getUserObject(): Any

getUserObjectPath

open fun getUserObjectPath(): Array<Any>

htmlText

fun htmlText(selected: Boolean): String

Construct HTML text to present for this node.

icon

fun icon(lineHeight: Int): ImageIcon?

Return a suitable icon to display for this instance with the given line height.

insert

open override fun insert(p0: MutableTreeNode, p1: Int)

isLeaf

open override fun isLeaf(): Boolean

isNodeAncestor

open fun isNodeAncestor(p0: TreeNode): Boolean

isNodeChild

open fun isNodeChild(p0: TreeNode): Boolean

isNodeDescendant

open fun isNodeDescendant(p0: DefaultMutableTreeNode): Boolean

isNodeSibling

open fun isNodeSibling(p0: TreeNode): Boolean

isRoot

open fun isRoot(): Boolean

isSpecifiedByString

fun isSpecifiedByString(string: String): Boolean

Answer whether string is an appropriate semantic label for this node.

modulePathString

open override fun modulePathString(): String

Answer a String suitable for identifying this node even after refreshing the tree.

pathFromAncestorEnumeration

open fun pathFromAncestorEnumeration(p0: TreeNode): Enumeration<TreeNode>

postorderEnumeration

open fun postorderEnumeration(): Enumeration<TreeNode>

preorderEnumeration

open fun preorderEnumeration(): Enumeration<TreeNode>

remove

open override fun remove(p0: MutableTreeNode)

open override fun remove(p0: Int)

removeAllChildren

open fun removeAllChildren()

removeFromParent

open override fun removeFromParent()

setAllowsChildren

open fun setAllowsChildren(p0: Boolean)

setParent

open override fun setParent(p0: MutableTreeNode)

setUserObject

open override fun setUserObject(p0: Any)

sortChildren

fun sortChildren()

Sort the direct children of this node. The default sort order is alphabetic by the nodes' text (passing false).

toString

open override fun toString(): String

Properties

entryPointString

val entryPointString: String

The entry point, which is a String.

resolvedModuleName

val resolvedModuleName: ResolvedModuleName

The name of the module containing the entry point.

sortMajor

open val sortMajor: Int

The primary order by which to sort this node relative to siblings.