public interface Node extends TaggedObject
Tree
.
The node represents the single row of the tree.
Modifier and Type | Interface and Description |
---|---|
static class |
Node.DragType
Represents the drag type
|
static class |
Node.DropType
Represents the drop type
|
static class |
Node.ExpandOption
Represents the Expand/Collapse option
|
static class |
Node.Scroll
Represents the scroll position to be applied on node.
|
Modifier and Type | Method and Description |
---|---|
boolean |
crossSelection()
Returns the flag indicating whether cross section is allowed.
|
String |
displayIcon()
Returns the display icon.
|
String |
displayText()
Returns the display text of node.
|
void |
expand(Node.ExpandOption expandOption)
Expands/collapses the node
License requirements: None. |
Node |
firstChildNode()
Returns the first child node.
|
int |
foregroundColor()
Returns the text color of the node.
|
String |
getColumnDisplayText(int columnID)
Gets the column text for the given columnId.
|
DataContainer |
getNodeData()
Gets node data which contains the data in the form of unique name-value pairs.
|
int |
getState()
Gets the node state associated with node state icon.
|
boolean |
isExpanded()
Returns the flag indicating whether the node is in expanded state
License requirements: None. |
boolean |
isInserted()
Returns the flag indicating whether the node is inserted in
Tree
License requirements: None. |
boolean |
isSelected()
Returns the flag indicating whether the node is in selected state
License requirements: None. |
Node |
nextNode()
Returns the next node which might not belong to the same hierarchy.
|
Node |
nextSelectedNode()
Returns the next selected node in the whole tree hierarchy.
|
Node |
nextSiblingNode()
Returns the next node which belongs to the same hierarchy.
|
Node |
parentNode()
Returns the parent node.
|
Node |
previousNode()
Returns the previous node which might not belong to the same hierarchy.
|
Node |
previousSelectedNode()
Returns the previous selected node in the whole tree hierarchy.
|
Node |
previousSiblingNode()
Returns the previous node which belongs to the same hierarchy.
|
void |
scrollTo(int columnID,
Node.Scroll visibleOption)
Scrolls horizontally and vertically to make the specific column of
node appear on the tree window.
|
String |
selectedIcon()
Returns the selected icon.
|
void |
setColumnDisplayText(int columnID,
String columnDisplayText)
Sets the text in the column which corresponds to given columnId.
|
void |
setCrossSelection(boolean crossSelection)
License requirements: None. |
void |
setDisplayIcon(String icon)
License requirements: None. |
void |
setDisplayText(String displayTest)
License requirements: None. |
void |
setForegroundColor(int nodeForgroundColor)
License requirements: None. |
void |
setSelectedIcon(String icon)
License requirements: None. |
void |
setState(int state)
Sets the node state which is associated with node state icon.
|
printTestData, printTestData, tag, tagValue
void scrollTo(int columnID, Node.Scroll visibleOption) throws NXException, RemoteException
columnID
- ColumnId of the column to which tree window scrolls horizontally.visibleOption
- Option to scroll the tree window vertically.NXException
RemoteException
void expand(Node.ExpandOption expandOption) throws NXException, RemoteException
expandOption
- Expand optionNXException
RemoteException
int getState() throws NXException, RemoteException
NXException
RemoteException
void setState(int state) throws NXException, RemoteException
state
- Node stateNXException
RemoteException
String displayText() throws NXException, RemoteException
setColumnDisplayText(int, java.lang.String)
to fetch the text of other column of the same node.
NXException
RemoteException
void setDisplayText(String displayTest) throws NXException, RemoteException
displayTest
- Display textNXException
RemoteException
String getColumnDisplayText(int columnID) throws NXException, RemoteException
Tree.ColumnDisplay.ICON
.
columnID
- Unique column id of the column.NXException
RemoteException
void setColumnDisplayText(int columnID, String columnDisplayText) throws NXException, RemoteException
Tree.ColumnDisplay.ICON
.
columnID
- Unique coulmn id of the column.columnDisplayText
- Text associated with columnNXException
RemoteException
boolean crossSelection() throws NXException, RemoteException
DisplayableObject
as
data. If the flag is true then the DisplayableObject
is
highlighted, else not. The default value is True
NXException
RemoteException
void setCrossSelection(boolean crossSelection) throws NXException, RemoteException
crossSelection
- Flag indicating whether cross selection is allowed.NXException
RemoteException
int foregroundColor() throws NXException, RemoteException
NXException
RemoteException
void setForegroundColor(int nodeForgroundColor) throws NXException, RemoteException
nodeForgroundColor
- Foreground color.NXException
RemoteException
Node firstChildNode() throws NXException, RemoteException
NXException
RemoteException
Node nextNode() throws NXException, RemoteException
NXException
RemoteException
Node nextSiblingNode() throws NXException, RemoteException
NXException
RemoteException
Node parentNode() throws NXException, RemoteException
NXException
RemoteException
Node previousNode() throws NXException, RemoteException
NXException
RemoteException
Node previousSelectedNode() throws NXException, RemoteException
NXException
RemoteException
Node nextSelectedNode() throws NXException, RemoteException
NXException
RemoteException
Node previousSiblingNode() throws NXException, RemoteException
NXException
RemoteException
String displayIcon() throws NXException, RemoteException
NXException
RemoteException
void setDisplayIcon(String icon) throws NXException, RemoteException
icon
- Icon.NXException
RemoteException
String selectedIcon() throws NXException, RemoteException
displayIcon()
and setDisplayIcon(java.lang.String)
.
NXException
RemoteException
void setSelectedIcon(String icon) throws NXException, RemoteException
icon
- Icon.NXException
RemoteException
DataContainer getNodeData() throws NXException, RemoteException
Node
represents a
feature object then property name should be "Data" and the value should be feature object. The primary data is used by NX
for some operations such cross selection.
DataContainer
on how property name-value pair is added
to the container or list.
NXException
RemoteException
boolean isInserted() throws NXException, RemoteException
Tree
NXException
RemoteException
boolean isExpanded() throws NXException, RemoteException
NXException
RemoteException
boolean isSelected() throws NXException, RemoteException
NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.