avail/avail.anvil.nodes/ModuleOrPackageNode

ModuleOrPackageNode

class ModuleOrPackageNode(workbench: AvailWorkbench, originalModuleName: ModuleName, val resolvedModuleName: ResolvedModuleName, val isPackage: Boolean) : OpenableFileNode

This is a tree node representing a module file or a package.

Author

Mark van Gulik

Parameters

workbench

The AvailWorkbench.

originalModuleName

The name of the module/package prior to resolution (renames).

resolvedModuleName

The resolved name of the module or package.

isPackage

Whether it's a package.

Constructors

ModuleOrPackageNode

constructor(workbench: AvailWorkbench, originalModuleName: ModuleName, resolvedModuleName: ResolvedModuleName, isPackage: Boolean)

Construct a new ModuleOrPackageNode.

Properties

isBuilding

open override val isBuilding: Boolean

Whether this AbstractWorkbenchTreeNode represent an Avail module that is actively being BuildTask.

isLoaded

val isLoaded: Boolean

Is the module or package loaded?

isPackage

val isPackage: Boolean

Whether this module's name refers to a package (directory).

resolvedModuleName

val resolvedModuleName: ResolvedModuleName

The resolved name of the module or package.

sortMajor

open override val sortMajor: Int

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

typedChildren

val typedChildren: Iterable<AbstractWorkbenchTreeNode>

Answer an Iterable over the children, but type-strengthening the elements to AbstractWorkbenchTreeNode.

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: AbstractWorkbenchTreeNode): 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

open 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.

initiallyExpanded

open fun initiallyExpanded(): Boolean

Whether to expand this node when the Anvil workbench opens.

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.

labelForText

fun labelForText(text: String, icon: ImageIcon?): JLabel

Given text which is likely to match previously supplied text for this node, answer either a JLabel, using and/or caching it as appropriate.

modulePathString

open override fun modulePathString(): String

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

open

open override fun open()

Open the associated file.

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).

text

open override fun text(selected: Boolean): String

Extract text to display for this node. Presentation styling will be applied separately.

toString

open override fun toString(): String