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

Inherits com::google::security::zynamics::zylib::types::graphs::DefaultEdge< ViewNode >, and com::google::security::zynamics::binnavi::APIHelpers::ApiObject< INaviEdge >.

List of all members.

Public Member Functions
void	addListener (final IViewEdgeListener listener)
List< IComment >	appendGlobalComment (final String comment) throws com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException, com.google.security.zynamics.binnavi.API.disassembly.CouldntLoadDataException
List< IComment >	appendLocalComment (final String comment) throws com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException, com.google.security.zynamics.binnavi.API.disassembly.CouldntLoadDataException
void	deleteGlobalComment (final IComment comment) throws com.google.security.zynamics.binnavi.API.disassembly.CouldntDeleteException
void	deleteLocalComment (final IComment comment) throws com.google.security.zynamics.binnavi.API.disassembly.CouldntDeleteException
IComment	editGlobalComment (final IComment comment, final String newComment) throws com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException
IComment	editLocalComment (final IComment comment, final String newComment) throws com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException
Color	getColor ()
ViewNode	getSource ()
ViewNode	getTarget ()
EdgeType	getType ()
void	initializeGlobalComment (final List< IComment > comments)
void	initializeLocalComment (final List< IComment > comments)
boolean	isVisible ()
void	removeListener (final IViewEdgeListener listener)
void	setColor (final Color color)
void	setVisible (final boolean value)
String	toString ()

---

Detailed Description

Class used to represent edges in graph views.

---

Member Function Documentation

void com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.addListener

(

final IViewEdgeListener

listener

)

Adds an object that is notified about changes in the view edge.

Parameters:

listener

The listener object that is notified about changes in the view edge.

Exceptions:

	IllegalArgumentException	Thrown if the listener argument is null.
	IllegalStateException	Thrown if the listener object is already listening on the view edge.

List<IComment> com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.appendGlobalComment

(

final String

comment

)

throws com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException, com.google.security.zynamics.binnavi.API.disassembly.CouldntLoadDataException

Append a local edge comment.

Parameters:

comment

The string for the comment to append.

Returns:

The List of local comments currently associated to the edge after the append has been successful.

Exceptions:

	com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException
	com.google.security.zynamics.binnavi.API.disassembly.CouldntLoadDataException

List<IComment> com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.appendLocalComment

(

final String

comment

)

throws com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException, com.google.security.zynamics.binnavi.API.disassembly.CouldntLoadDataException

Append a local edge comment.

Parameters:

comment

The string for the comment to append.

Returns:

The List of local comments currently associated to the edge after the append has been successful.

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.ViewEdge.deleteGlobalComment

(

final IComment

comment

)

throws com.google.security.zynamics.binnavi.API.disassembly.CouldntDeleteException

Delete a local edge comment.

Parameters:

comment

The local comment to delete.

Exceptions:

com.google.security.zynamics.binnavi.API.disassembly.CouldntDeleteException

void com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.deleteLocalComment

(

final IComment

comment

)

throws com.google.security.zynamics.binnavi.API.disassembly.CouldntDeleteException

Delete a local edge comment.

Parameters:

comment

The local comment to delete.

Exceptions:

com.google.security.zynamics.binnavi.API.disassembly.CouldntDeleteException

IComment com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.editGlobalComment	(	final IComment	comment,
		final String	newComment
	)			throws com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException

Edit a local edge comment.

Parameters:

	comment	The comment to edit
	newComment	The new comment text.

Returns:

The edited comment.

Exceptions:

com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException

IComment com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.editLocalComment	(	final IComment	comment,
		final String	newComment
	)			throws com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException

Edit a local edge comment.

Parameters:

	comment	The comment to edit
	newComment	The new comment text.

Returns:

The edited comment.

Exceptions:

com.google.security.zynamics.binnavi.API.disassembly.CouldntSaveDataException

Color com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.getColor

(

)

Returns the color of the edge.

Returns:

The color of the edge.

ViewNode com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.getSource

(

)

Returns the source block of the edge.

Returns:

The source block of the edge.

ViewNode com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.getTarget

(

)

Returns the target block of the edge.

Returns:

The target block of the edge.

EdgeType com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.getType

(

)

Returns the type of the edge.

Returns:

The type of the edge.

void com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.initializeGlobalComment

(

final List< IComment >

comments

)

Initialize the local edge comments.

Parameters:

comments

The list of local comments to associate to the edge.

void com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.initializeLocalComment

(

final List< IComment >

comments

)

Initialize the local edge comments.

Parameters:

comments

The list of local comments to associate to the edge.

boolean com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.isVisible

(

)

Determines whether the edge is visible or not.

Returns:

True, if the edge is visible. False, if not.

void com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.removeListener

(

final IViewEdgeListener

listener

)

Removes a listener object from the view edge.

Parameters:

listener

The listener object to remove from the view edge.

Exceptions:

	IllegalArgumentException	Thrown if the listener argument is null.
	IllegalStateException	Thrown if the listener object was not listening on the view edge.

void com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.setColor

(

final Color

color

)

Changes the color of the edge.

Parameters:

color

The new color of the edge.

void com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.setVisible

(

final boolean

value

)

Used to show or hide the edge.

Parameters:

value

True to show the edge; false to hide it.

String com.google.security.zynamics.binnavi.API.disassembly.ViewEdge.toString

(

)

Returns the string representation of the edge.

Returns:

The string representation of the edge.