Public Member Functions

com.google.security.zynamics.binnavi.API.disassembly.GroupNode Class Reference

Inheritance diagram for com.google.security.zynamics.binnavi.API.disassembly.GroupNode:
com.google.security.zynamics.binnavi.API.disassembly.ViewNode

List of all members.

Public Member Functions

void addListener (final IViewNodeListener listener)
void addListener (final IGroupNodeListener listener)
void addNode (final ViewNode node)
void addTag (final Tag tag) throws CouldntSaveDataException
List< IComment > appendComment (final String comment) throws com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException, com.google.security.zynamics.binnavi.API.disassembly.CouldntLoadDataException
void deleteComment (final IComment comment) throws com.google.security.zynamics.binnavi.API.disassembly.CouldntDeleteException
IComment editComment (final IComment comment, final String newComment) throws com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException
Color getBorderColor ()
List< ViewNode > getChildren ()
Color getColor ()
List< IComment > getComment ()
List< ViewNode > getElements ()
List< ViewEdge > getIncomingEdges ()
List< ViewEdge > getOutgoingEdges ()
GroupNode getParentGroup ()
List< ViewNode > getParents ()
List< Tag > getTags ()
double getX ()
double getY ()
boolean isCollapsed ()
boolean isSelected ()
boolean isTagged (final Tag tag)
boolean isVisible ()
void removeListener (final IGroupNodeListener listener)
void removeListener (final IViewNodeListener listener)
void removeNode (final ViewNode element)
void removeTag (final Tag tag) throws CouldntSaveDataException
void setBorderColor (final Color color)
void setCollapsed (final boolean collapsed)
void setColor (final Color color)
void setSelected (final boolean selection)
void setX (final double newX)
void setY (final double newY)
String toString ()

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 com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.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.
List<IComment> com.google.security.zynamics.binnavi.API.disassembly.GroupNode.appendComment ( final String  comment  )  throws com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException, com.google.security.zynamics.binnavi.API.disassembly.CouldntLoadDataException

Append a group node comment.

Parameters:
comment the comment to be appended.
Exceptions:
com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException 
com.google.security.zynamics.binnavi.API.disassembly.CouldntLoadDataException 
void com.google.security.zynamics.binnavi.API.disassembly.GroupNode.deleteComment ( final IComment  comment  )  throws com.google.security.zynamics.binnavi.API.disassembly.CouldntDeleteException

Delete a group node comment.

Parameters:
comment the IComment comment to be deleted.
Exceptions:
com.google.security.zynamics.binnavi.API.disassembly.CouldntDeleteException 
IComment com.google.security.zynamics.binnavi.API.disassembly.GroupNode.editComment ( final IComment  comment,
final String  newComment 
) throws com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException

Edit a group node comment.

Parameters:
comment The IComment which is edited.
newComment The new text for the comment.
Returns:
The edited comment if successful null otherwise.
Exceptions:
com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException 
Color com.google.security.zynamics.binnavi.API.disassembly.ViewNode.getBorderColor (  )  [inherited]

Returns the current border color of the node.

Returns:
The current border color of the node.
List<ViewNode> com.google.security.zynamics.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 com.google.security.zynamics.binnavi.API.disassembly.ViewNode.getColor (  )  [inherited]

Returns the current background color of the node.

Returns:
The current background color of the node.
List<IComment> com.google.security.zynamics.binnavi.API.disassembly.GroupNode.getComment (  ) 

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

Returns:
The text that is displayed when the group node is collapsed.
List<ViewNode> com.google.security.zynamics.binnavi.API.disassembly.GroupNode.getElements (  ) 

Returns all elements inside the group node.

Returns:
A list of group node members.
List<ViewEdge> com.google.security.zynamics.binnavi.API.disassembly.ViewNode.getIncomingEdges (  )  [inherited]

Returns the incoming edges of the view node.

Returns:
The incoming edges of the view node.
List<ViewEdge> com.google.security.zynamics.binnavi.API.disassembly.ViewNode.getOutgoingEdges (  )  [inherited]

Returns the ougoing edges of the view node.

Returns:
The outgoing edges of the view node.
GroupNode com.google.security.zynamics.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> com.google.security.zynamics.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> com.google.security.zynamics.binnavi.API.disassembly.ViewNode.getTags (  )  [inherited]

Returns the tags that are currently associated with the node.

Returns:
A list of tags.
double com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.binnavi.API.disassembly.ViewNode.isSelected (  )  [inherited]

Determines whether the node is selected or not.

Returns:
True, if the node is selected. False, otherwise.
boolean com.google.security.zynamics.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 com.google.security.zynamics.binnavi.API.disassembly.ViewNode.isVisible (  )  [inherited]

Determines whether the node is visible or not.

Returns:
True, if the node is visible. False, otherwise.
void com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.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 com.google.security.zynamics.binnavi.API.disassembly.GroupNode.toString (  ) 

Returns a string representation of the group node.

Returns:
A string representation of the group node.

Reimplemented from com.google.security.zynamics.binnavi.API.disassembly.ViewNode.

Generated on Thu Oct 4 2012 11:26:26 for zynamics BinNavi by  doxygen 1.7.1