Represents a view node that can be used to group other view nodes. More...

Inheritance diagram for BinNavi.API.disassembly.GroupNode:

Public Member Functions
void	addListener (final IGroupNodeListener listener)
	Adds a group node listener.
void	addListener (final IViewNodeListener listener)
	Adds a view node listener.
void	addNode (final ViewNode node)
	Adds a node to the group node.
void	addTag (final Tag tag) throws CouldntSaveDataException
	Tags the node.
Color	getBorderColor ()
	The border color of the node.
List< ViewNode >	getChildren ()
	The child nodes of the node.
Color	getColor ()
	The color of the node.
List< ViewNode >	getElements ()
	Nodes inside the group.
List< ViewEdge >	getIncomingEdges ()
	Returns the incoming edges of the view node.
List< ViewEdge >	getOutgoingEdges ()
	Returns the outgoing edges of the view node.
GroupNode	getParentGroup ()
	Parent group of the node.
List< ViewNode >	getParents ()
	The parent nodes of the node.
List< Tag >	getTags ()
	Returns tags of the node.
String	getText ()
	Text shown in collapsed state.
double	getX ()
	X-position of the node.
double	getY ()
	Y-position of the node.
boolean	isCollapsed ()
	Checks if the group node is collapsed.
boolean	isSelected ()
	Selection state of the node.
boolean	isTagged (final Tag tag)
	Checks if the node is tagged with a given tag.
boolean	isVisible ()
	Visibility state of the node.
void	removeListener (final IGroupNodeListener listener)
	Removes a group node listener.
void	removeListener (final IViewNodeListener listener)
	Removes a view node listener.
void	removeNode (final ViewNode element)
	Removes an element from the group node.
void	removeTag (final Tag tag) throws CouldntSaveDataException
	Removes a tag from the node.
void	setBorderColor (final Color color)
	Changes the border color of the node.
void	setCollapsed (final boolean collapsed)
	Collapses or uncollapses the group node.
void	setColor (final Color color)
	Changes the background color of the node.
void	setSelected (final boolean selection)
	Changes the selection state of the node.
void	setText (final String text)
	Changes the collapsed-state node.
void	setX (final double newX)
	Changes the X-position of the node.
void	setY (final double newY)
	Changes the Y-position of the node.
String	toString ()
	Printable representation of the group node.

Detailed Description

A group node can be used to group a subset of the nodes of a view. Using group nodes it is possible to put all nodes of a graph that share a common feature into a special kind of subgraph inside the view.

Member Function Documentation

void BinNavi.API.disassembly.ViewNode.addListener ( final IViewNodeListener listener ) [inherited]

Adds a listener object that is notified about changes in the view node.

Parameters:

listener

The listener that is added to the view node.

void BinNavi.API.disassembly.GroupNode.addListener ( final IGroupNodeListener listener )

Adds an object that is notified about changes in the group node.

Parameters:

listener

The listener object that is notified about changes in the group node.

Exceptions:

	IllegalArgumentException	Thrown if the listener argument is null.
	IllegalStateException	Thrown if the listener object is already listening on the group node.

void BinNavi.API.disassembly.GroupNode.addNode ( final ViewNode node )

Adds a node to the group node.

Parameters:

node

The node to add to the group node.

void BinNavi.API.disassembly.ViewNode.addTag ( final Tag tag ) throws CouldntSaveDataException [inherited]

Tags a node with a given tag.

Parameters:

tag

The tag that is added to the node.

Exceptions:

CouldntSaveDataException

Thrown if the node could not be tagged.

Color BinNavi.API.disassembly.ViewNode.getBorderColor ( ) [inherited]

Returns the current border color of the node.

Returns:: The current border color of the node.

List<ViewNode> BinNavi.API.disassembly.ViewNode.getChildren ( ) [inherited]

Returns the nodes of the view that are reachable by following the outgoing edges of the view node.

Returns:: The reachable children of the view node.

Color BinNavi.API.disassembly.ViewNode.getColor ( ) [inherited]

Returns the current background color of the node.

Returns:: The current background color of the node.

List<ViewNode> BinNavi.API.disassembly.GroupNode.getElements ( )

Returns all elements inside the group node.

Returns:: A list of group node members.

List<ViewEdge> BinNavi.API.disassembly.ViewNode.getIncomingEdges ( ) [inherited]

Returns the incoming edges of the view node.

Returns:: The incoming edges of the view node.

List<ViewEdge> BinNavi.API.disassembly.ViewNode.getOutgoingEdges ( ) [inherited]

Returns the ougoing edges of the view node.

Returns:: The outgoing edges of the view node.

GroupNode BinNavi.API.disassembly.ViewNode.getParentGroup ( ) [inherited]

Returns the group node in which the node is contained. If the node does not belong to any group, the return value of this method is null.

Returns:: Parent group node of the node or null.

List<ViewNode> BinNavi.API.disassembly.ViewNode.getParents ( ) [inherited]

Returns the nodes of the view that are reachable by following the incoming edges of the view node.

Returns:: The reachable parents of the view node.

List<Tag> BinNavi.API.disassembly.ViewNode.getTags ( ) [inherited]

Returns the tags that are currently associated with the node.

Returns:: A list of tags.

String BinNavi.API.disassembly.GroupNode.getText ( )

Returns the text that is displayed when the group node is collapsed.

Returns:: The text that is displayed when the group node is collapsed.

double BinNavi.API.disassembly.ViewNode.getX ( ) [inherited]

Returns the current X position of the node in the view.

Returns:: The current X position of the node in the view.

double BinNavi.API.disassembly.ViewNode.getY ( ) [inherited]

Returns the current Y position of the node in the view.

Returns:: The current Y position of the node in the view.

boolean BinNavi.API.disassembly.GroupNode.isCollapsed ( )

Returns a flag that indicates whether the group node is collapsed or open.

Returns:: True, to signal that the group node is collapsed. False, to signal that it is open.

boolean BinNavi.API.disassembly.ViewNode.isSelected ( ) [inherited]

Determines whether the node is selected or not.

Returns:: True, if the node is selected. False, otherwise.

boolean BinNavi.API.disassembly.ViewNode.isTagged ( final Tag tag ) [inherited]

Determines whether the node is tagged with a given tag.

Parameters:

tag

The tag that is checked.

Returns:: True, if the node is tagged with the tag. False, otherwise.

Exceptions:

IllegalArgumentException

Thrown if the tag argument is null.

boolean BinNavi.API.disassembly.ViewNode.isVisible ( ) [inherited]

Determines whether the node is visible or not.

Returns:: True, if the node is visible. False, otherwise.

void BinNavi.API.disassembly.GroupNode.removeListener ( final IGroupNodeListener listener )

Removes a listener object from the group node.

Parameters:

listener

The listener object to remove from the group node.

Exceptions:

	IllegalArgumentException	Thrown if the listener argument is null.
	IllegalStateException	Thrown if the listener object was not listening on the group node.

void BinNavi.API.disassembly.ViewNode.removeListener ( final IViewNodeListener listener ) [inherited]

Removes a listener object from the view node.

Parameters:

listener

The listener object to remove from the node.

void BinNavi.API.disassembly.GroupNode.removeNode ( final ViewNode element )

Removes an element from the group node.

Parameters:

element

The element to be removed from the group node.

void BinNavi.API.disassembly.ViewNode.removeTag ( final Tag tag ) throws CouldntSaveDataException [inherited]

Removes a tag from the node.

Parameters:

tag

The tag to remove from the node.

Exceptions:

CouldntSaveDataException

Thrown if the tag could not be removed from the node.

void BinNavi.API.disassembly.ViewNode.setBorderColor ( final Color color ) [inherited]

Changes the border color of the node.

Parameters:

color

The new border color of the node.

void BinNavi.API.disassembly.GroupNode.setCollapsed ( final boolean collapsed )

Collapses or uncollapses the group node.

Parameters:

collapsed

True, to collapse the group node. False, to uncollapse it.

void BinNavi.API.disassembly.ViewNode.setColor ( final Color color ) [inherited]

Changes the background color of the node.

Parameters:

color

The new background color of the node.

void BinNavi.API.disassembly.ViewNode.setSelected ( final boolean selection ) [inherited]

Selects or deselects the node.

Parameters:

selection

True to select the node, false to deselect it.

void BinNavi.API.disassembly.GroupNode.setText ( final String text )

Changes the text that is shown when the group node is collapsed.

Parameters:

text

The text that is shown when the group node is collapsed.

void BinNavi.API.disassembly.ViewNode.setX ( final double newX ) [inherited]

Changes the X position of the node.

Parameters:

newX

The new X position of the node.

void BinNavi.API.disassembly.ViewNode.setY ( final double newY ) [inherited]

Changes the Y position of the node.

Parameters:

newY

The new Y position of the node.

String BinNavi.API.disassembly.GroupNode.toString ( )

Returns a string representation of the group node.

Returns:: A string representation of the group node.

Reimplemented from BinNavi.API.disassembly.ViewNode.

BinNavi.API.disassembly.GroupNode Class Reference

Public Member Functions

Detailed Description

Member Function Documentation