com.ur.urcap.api.domain.program.nodes.builtin

Interface FolderNode

All Superinterfaces:

ProgramNode

@ProviderType
public interface FolderNode
extends ProgramNode

This interface represents a Folder program node. The Folder node is a built-in program node provided by Universal Robots.

The purpose of this program node is to contain other program node (as children) in order thereby to organize and label specific parts of a program, to clean up the program tree, and to make the program easier to read and navigate.

Since:

1.1.0

Method Summary

Modifier and Type	Method and Description
String	getName()
boolean	isSubtreeHidden() Indicates whether the Folder node's subtree is hidden in the Program Tree in PolyScope, i.e.
FolderNode	setName(String name) Sets the name of the Folder node.
FolderNode	setSubtreeHidden(boolean subtreeHidden) Configure whether or not the subtree of the Folder node is hidden, i.e.

Method Detail

setName

FolderNode setName(String name)

Sets the name of the Folder node.

Parameters:

name - The name of the folder.

Returns:

This node.

Throws:

IllegalStateException - If called from a Swing-based URCap outside of an UndoableChanges scope (see also UndoRedoManager).

Since:

1.2.56

getName

String getName()

Returns:

The name of the Folder node.

Since:

1.2.56

setSubtreeHidden

FolderNode setSubtreeHidden(boolean subtreeHidden)

Configure whether or not the subtree of the Folder node is hidden, i.e. whether or not the child nodes under the Folder node are visible in the Program Tree in PolyScope.

Parameters:

subtreeHidden - true, if the Folder node's subtree should be hidden in the Program Tree. false if the subtree should be visible.

Returns:

This node.

Throws:

IllegalStateException - If called from a Swing-based URCap outside of an UndoableChanges scope (see also UndoRedoManager).

Since:

1.12.0

isSubtreeHidden

boolean isSubtreeHidden()

Indicates whether the Folder node's subtree is hidden in the Program Tree in PolyScope, i.e. whether the child nodes under the Folder node are not visible.

Returns:

true if the Folder node's subtree is hidden, and false if the subtree is visible in the Program Tree in PolyScope.

Since:

1.12.0