INodeData (yFiles-for-JavaFX-Complete-3.0 API)

```
public interface INodeData
```
This interface provides layout information about the nodes of the graph during the layout.
INodeData is a multi-purpose node descriptor for each node of the graph during the hierarchic layout used internally by the algorithm implementations.

Instances of this interface can be obtained during the layout from instances of the ILayoutDataProvider interface.

INodeData typically carries the type of the node and depending on the type an optional associated edge and associated node. Optionally, it may carry a geometric description of the borders of the node and descriptors for various aspects of the layout.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BorderLine`	`createBorderLine(int side, INodeLayout nodeLayout)` Creates, stores and returns a `BorderLine` for the given side or returns the current `BorderLine` instance if it already exists.
`Edge`	`getAssociatedEdge()` Gets the associated `Edge` of the `Node` of this `INodeData` instance (in case of e.g.
`Node`	`getAssociatedNode()` Gets the associated `Node` of this `INodeData` instance (in case of e.g.
`ListCell`	`getFirstSameLayerEdgeCell()` Gets the first same-layer edge `ListCell` of all same-layer edges or `null` if there exists no same-layer edge.
`Object`	`getGroupId()` Gets the group ID of the `Node` of this `INodeData` instance if it is a bus-group node.
`ILayers`	`getGroupLayers()` Gets the inner layers of the group `Node` of this `INodeData` instance.
`Node`	`getGroupNode()` Gets the group node this node belongs to.
`Object`	`getIncrementalHint()` Gets the hint of the incremental mode of the `Node` of this `INodeData` instance if this node is of type `NodeDataType.NORMAL`.
`int`	`getLayer()` Gets the index of the `ILayer` instance to which the `Node` of this `INodeData` instance belongs.
`NodeLayoutDescriptor`	`getNodeLayoutDescriptor()` Gets the `NodeLayoutDescriptor` instance initially bound to the `Node` of this `INodeData` instance or `null` if no `NodeLayoutDescriptor` has been registered.
`BorderLine`	`getNormalizedBorderLine(int side)` Returns a `BorderLine` for the given side which is treated as if the position of the node is at (0,0).
`Node`	`getParentGroupNode()` Gets the parent group node of the `Node` of this `INodeData` instance (if any).
`int`	`getPosition()` Gets the current position of the `Node` of this `INodeData` instance within its layer.
`SwimlaneDescriptor`	`getSwimLaneDescriptor()` Gets the `SwimlaneDescriptor` instance initially bound to the `Node` of this `INodeData` instance or `null` if no `SwimlaneDescriptor` has been registered.
`NodeDataType`	`getType()` Gets the type constant for the `Node` of this `INodeData` instance.
`int`	`sameLayerEdgeCount()` Returns the number of same-layer edges associated with the `Node` of this `INodeData` instance.

- Method Detail
  - createBorderLine
```
BorderLine createBorderLine(int side,
                            INodeLayout nodeLayout)
```
    Creates, stores and returns a BorderLine for the given side or returns the current BorderLine instance if it already exists.
    Not every type of node supports this operation. NodeDataType.NORMAL supports BorderLines.
    
    Side value must be inside [0,3] interval, where 0 corresponds to the top side, 1 to the right side, 2 to the bottom side and 3 to the left side.
    
    Throws:
    
    UnsupportedOperationException - if this type of node does not support node borders
    
    Parameters:
    
    side - an integer value from [0,3] interval
    
    nodeLayout - the INodeLayout of the current node
    
    Returns:
    
    a BorderLine instance
    
    See Also:
    
    getNormalizedBorderLine(int)
  - getAssociatedEdge
```
Edge getAssociatedEdge()
```
    Gets the associated Edge of the Node of this INodeData instance (in case of e.g.
    bend or same-layer center node).
    
    Returns:
    
    the associated Edge
  - getAssociatedNode
```
Node getAssociatedNode()
```
    Gets the associated Node of this INodeData instance (in case of e.g.
    back-loop proxy and side proxy).
    
    Returns:
    
    the associated Node
  - getFirstSameLayerEdgeCell
```
ListCell getFirstSameLayerEdgeCell()
```
    Gets the first same-layer edge ListCell of all same-layer edges or null if there exists no same-layer edge.
    
    Returns:
    
    a ListCell containing the first same-layer edge or null if no same-layer edge exists
  - getGroupId
```
Object getGroupId()
```
    Gets the group ID of the Node of this INodeData instance if it is a bus-group node.
    
    Returns:
    
    a group ID or null if this node does not belong to an edge group node construct
    
    See Also:
    
    NodeDataType.SOURCE_GROUP_NODE, NodeDataType.TARGET_GROUP_NODE
  - getGroupLayers
```
ILayers getGroupLayers()
```
    Gets the inner layers of the group Node of this INodeData instance.
    If this node is of type NodeDataType.GROUP, this method returns the ILayers object that describes the layering in the subgraph.
    
    Returns:
    
    the layers of the subgraph
  - getGroupNode
```
Node getGroupNode()
```
    Gets the group node this node belongs to.
    
    Returns:
    
    the group node to which the associated Node belongs or null if the associated Node is a top level node.
  - getIncrementalHint
```
Object getIncrementalHint()
```
    Gets the hint of the incremental mode of the Node of this INodeData instance if this node is of type NodeDataType.NORMAL.
    The corresponding hint has been set by a IDataProvider using key HierarchicLayoutCore.INCREMENTAL_HINTS_DPKEY.
    
    Returns:
    
    the hint of this Node or com.yworks.yfiles.layout.hierarchic.HierarchicLayoutCore.IncrementalHint#NONE
  - getLayer
```
int getLayer()
```
    Gets the index of the ILayer instance to which the Node of this INodeData instance belongs.
    
    Returns:
    
    the index of the ILayer instance to which this Node belongs
  - getNodeLayoutDescriptor
```
NodeLayoutDescriptor getNodeLayoutDescriptor()
```
    Gets the NodeLayoutDescriptor instance initially bound to the Node of this INodeData instance or null if no NodeLayoutDescriptor has been registered.
    
    Returns:
    
    a NodeLayoutDescriptor instance or null if no NodeLayoutDescriptor has been registered
  - getNormalizedBorderLine
```
BorderLine getNormalizedBorderLine(int side)
```
    Returns a BorderLine for the given side which is treated as if the position of the node is at (0,0).
    Clients may modify this instance but should always reset it to the original position, since this is a shared instance.
    
    It may return null to indicate that the BorderLine can be determined through the INodeLayout instance.
    
    Side value must be inside [0,3] interval, where 0 corresponds to the top side, 1 to the right side, 2 to the bottom side and 3 to the left side.
    
    Parameters:
    
    side - an integer value from [0,3] interval
    
    Returns:
    
    a BorderLine instance or null
    
    See Also:
    
    createBorderLine(int, INodeLayout)
  - getParentGroupNode
```
Node getParentGroupNode()
```
    Gets the parent group node of the Node of this INodeData instance (if any).
    
    Returns:
    
    the parent of the Node (in the sense of hierarchically grouped graphs)
  - getPosition
```
int getPosition()
```
    Gets the current position of the Node of this INodeData instance within its layer.
    
    This may not always be up-to-date depending on which phase the layout algorithm is currently executed.
    
    Returns:
    
    the zero-based position index of the Node within its current layer
  - getSwimLaneDescriptor
```
SwimlaneDescriptor getSwimLaneDescriptor()
```
    Gets the SwimlaneDescriptor instance initially bound to the Node of this INodeData instance or null if no SwimlaneDescriptor has been registered.
    
    Returns:
    
    a SwimlaneDescriptor instance or null if no SwimlaneDescriptor has been registered
  - getType
```
NodeDataType getType()
```
    Gets the type constant for the Node of this INodeData instance.
    
    Returns:
    
    one of the predefined type constants
  - sameLayerEdgeCount
```
int sameLayerEdgeCount()
```
    Returns the number of same-layer edges associated with the Node of this INodeData instance.
    
    Returns:
    
    the number of same-layer edges associated with the node

Interface INodeData

Method Summary

Method Detail

createBorderLine

getAssociatedEdge

getAssociatedNode

getFirstSameLayerEdgeCell

getGroupId

getGroupLayers

getGroupNode

getIncrementalHint

getLayer

getNodeLayoutDescriptor

getNormalizedBorderLine

getParentGroupNode

getPosition

getSwimLaneDescriptor

getType

sameLayerEdgeCount