Package ghidra.service.graph

Interface GraphDisplay

public interface GraphDisplay

Interface for objects that display (or consume) graphs. Normally, a graph display represents a visual component for displaying and interacting with a graph. Some implementation may not be a visual component, but instead consumes/processes the graph (i.e. graph exporter). In this case, there is no interactive element and once the graph has been set on the display, it is closed.

Field Summary

Fields

Change	Modifier and Type	Field	Description
	static int	ALIGN_CENTER
	static int	ALIGN_LEFT
	static int	ALIGN_RIGHT
NEW	static java.lang.String	DISPLAY_VERTICES_AS_ICONS	true or false may have no meaning for a different graph visualization library
NEW	static java.lang.String	EDGE_TYPE_PRIORITY_LIST	a comma-separated list of edge type names in priority order
NEW	static java.lang.String	ENABLE_EDGE_SELECTION	true or false, whether edge selection via a mouse click is enabled.
NEW	static java.lang.String	FAVORED_EDGES	a comma-separated list of edge type names.
NEW	static java.lang.String	INITIAL_LAYOUT_ALGORITHM	values are defined as String symbols in LayoutFunction class KAMADA_KAWAI,FRUCTERMAN_REINGOLD,CIRCLE_MINCROSS,TIDIER_TREE,TIDIER_RADIAL_TREE, MIN_CROSS_TOP_DOWN,MIN_CROSS_LONGEST_PATH,MIN_CROSS_NETWORK_SIMPLEX,MIN_CROSS_COFFMAN_GRAHAM, EXP_MIN_CROSS_TOP_DOWN,EXP_MIN_CROSS_LONGEST_PATH,EXP_MIN_CROSS_NETWORK_SIMPLEX, EXP_MIN_CROSS_COFFMAN_GRAHAM,TREE,RADIAL,BALLOON,GEM may have no meaning for a different graph visualization library
NEW	static java.lang.String	SELECTED_EDGE_COLOR	values are color names or rgb in hex '0xFF0000' is red
NEW	static java.lang.String	SELECTED_VERTEX_COLOR	values are color names or rgb in hex '0xFF0000' is red
NEW	static java.lang.String	VERTEX_LABEL_POSITION	values are the strings N,NE,E,SE,S,SW,W,NW,AUTO,CNTR may have no meaning for a different graph visualization library

Method Summary

Change	Modifier and Type	Method	Description
NEW	void	addAction(DockingActionIf action)	Adds the action to the graph display.
	void	clear()	Clears all graph vertices and edges from this graph display
	void	close()	Closes this graph display window.
	void	defineEdgeAttribute(java.lang.String name)	Defines an edge attribute type for this graph window
	void	defineVertexAttribute(java.lang.String name)	Defines a vertex attribute type for this graph window
	AttributedVertex	getFocusedVertex()	Returns the currently focused vertex or null if no vertex is focused
	AttributedGraph	getGraph()	Returns the graph for this display
	java.lang.String	getGraphTitle()	Returns the title of the current graph
	java.util.Set<AttributedVertex>	getSelectedVertices()	Returns a set of vertex ids for all the currently selected vertices
	void	selectVertices(java.util.Set<AttributedVertex> vertexSet, EventTrigger eventTrigger)	Tells the graph display window to select the vertices with the given ids
	void	setFocusedVertex(AttributedVertex vertex, EventTrigger eventTrigger)	Tells the graph display window to focus the vertex with the given id
	void	setGraph(AttributedGraph graph, java.lang.String title, boolean append, TaskMonitor monitor)	Sets the graph to be displayed or consumed by this graph display
	void	setGraphDisplayListener(GraphDisplayListener listener)	Sets a GraphDisplayListener to be notified when the user changes the vertex focus or selects one or more nodes in a graph window
NEW	void	setVertexLabelAttribute(java.lang.String attributeName, int alignment, int size, boolean monospace, int maxLines)	Sets the name of the attribute which should be used as the primary vertex label
	void	updateVertexName(AttributedVertex vertex, java.lang.String newName)	Updates a vertex to a new name
REMOVED	void	setVertexLabel(String attributeName, int alignment, int size, boolean monospace, int maxLines)	(Removed)
REMOVED	void	addAction(DockingAction action)	(Removed)

Field Detail

ALIGN_LEFT

static final int ALIGN_LEFT

See Also:

Constant Field Values

ALIGN_CENTER

static final int ALIGN_CENTER

See Also:

Constant Field Values

ALIGN_RIGHT

static final int ALIGN_RIGHT

See Also:

Constant Field Values

SELECTED_VERTEX_COLOR NEW

static final java.lang.String SELECTED_VERTEX_COLOR

values are color names or rgb in hex '0xFF0000' is red

See Also:

Constant Field Values

SELECTED_EDGE_COLOR NEW

static final java.lang.String SELECTED_EDGE_COLOR

values are color names or rgb in hex '0xFF0000' is red

See Also:

Constant Field Values

INITIAL_LAYOUT_ALGORITHM NEW

static final java.lang.String INITIAL_LAYOUT_ALGORITHM

values are defined as String symbols in LayoutFunction class KAMADA_KAWAI,FRUCTERMAN_REINGOLD,CIRCLE_MINCROSS,TIDIER_TREE,TIDIER_RADIAL_TREE, MIN_CROSS_TOP_DOWN,MIN_CROSS_LONGEST_PATH,MIN_CROSS_NETWORK_SIMPLEX,MIN_CROSS_COFFMAN_GRAHAM, EXP_MIN_CROSS_TOP_DOWN,EXP_MIN_CROSS_LONGEST_PATH,EXP_MIN_CROSS_NETWORK_SIMPLEX, EXP_MIN_CROSS_COFFMAN_GRAHAM,TREE,RADIAL,BALLOON,GEM may have no meaning for a different graph visualization library

See Also:

Constant Field Values

DISPLAY_VERTICES_AS_ICONS NEW

static final java.lang.String DISPLAY_VERTICES_AS_ICONS

true or false may have no meaning for a different graph visualization library

See Also:

Constant Field Values

VERTEX_LABEL_POSITION NEW

static final java.lang.String VERTEX_LABEL_POSITION

values are the strings N,NE,E,SE,S,SW,W,NW,AUTO,CNTR may have no meaning for a different graph visualization library

See Also:

Constant Field Values

ENABLE_EDGE_SELECTION NEW

static final java.lang.String ENABLE_EDGE_SELECTION

true or false, whether edge selection via a mouse click is enabled. May not be supported by another graph visualization library

See Also:

Constant Field Values

EDGE_TYPE_PRIORITY_LIST NEW

static final java.lang.String EDGE_TYPE_PRIORITY_LIST

a comma-separated list of edge type names in priority order

See Also:

Constant Field Values

FAVORED_EDGES NEW

static final java.lang.String FAVORED_EDGES

a comma-separated list of edge type names. any will be considered a favored edge for the min-cross layout algorithms. May have no meaning with a different graph visualization library

See Also:

Constant Field Values

Method Detail

setGraphDisplayListener

void setGraphDisplayListener(GraphDisplayListener listener)

Sets a GraphDisplayListener to be notified when the user changes the vertex focus or selects one or more nodes in a graph window

Parameters:

listener - the listener to be notified

setFocusedVertex

void setFocusedVertex(AttributedVertex vertex,
                      EventTrigger eventTrigger)

Tells the graph display window to focus the vertex with the given id

Parameters:

vertex - the vertex to focus

eventTrigger - Provides a hint to the GraphDisplay as to why we are updating the graph location so that the GraphDisplay can decide if it should send out a notification via the GraphDisplayListener.locationFocusChanged(AttributedVertex). For example, if we are updating the the location due to an event from the main application, we don't want to notify the application the graph changed to avoid event cycles. See EventTrigger for more information.

getGraph

AttributedGraph getGraph()

Returns the graph for this display

Returns:

the graph for this display

getFocusedVertex

AttributedVertex getFocusedVertex()

Returns the currently focused vertex or null if no vertex is focused

Returns:

the currently focused vertex or null if no vertex is focused

selectVertices

void selectVertices(java.util.Set<AttributedVertex> vertexSet,
                    EventTrigger eventTrigger)

Tells the graph display window to select the vertices with the given ids

Parameters:

vertexSet - the set of vertices to select

eventTrigger - Provides a hint to the GraphDisplay as to why we are updating the graph location so that the GraphDisplay can decide if it should send out a notification via the GraphDisplayListener.selectionChanged(Set). For example, if we are updating the the location due to an event from the main application, we don't want to notify the application the graph changed to avoid event cycles. See EventTrigger for more information.

getSelectedVertices

java.util.Set<AttributedVertex> getSelectedVertices()

Returns a set of vertex ids for all the currently selected vertices

Returns:

a set of vertex ids for all the currently selected vertices

close

void close()

Closes this graph display window.

defineVertexAttribute

void defineVertexAttribute(java.lang.String name)

Defines a vertex attribute type for this graph window

Parameters:

name - the name of the attribute which may be attached to vertices

defineEdgeAttribute

void defineEdgeAttribute(java.lang.String name)

Defines an edge attribute type for this graph window

Parameters:

name - the name of the attribute which may be attached to edges.

setVertexLabelAttribute NEW

void setVertexLabelAttribute(java.lang.String attributeName,
                             int alignment,
                             int size,
                             boolean monospace,
                             int maxLines)

Sets the name of the attribute which should be used as the primary vertex label

Parameters:

attributeName - the name of the attribute to use as the display label for vertices

alignment - (ALIGN_LEFT, ALIGN_RIGHT, or ALIGN_CENTER)

size - the font size to use for the display label

monospace - true if the font should be monospaced

maxLines - the maximum number lines to display in the vertex labels

setGraph

void setGraph(AttributedGraph graph,
              java.lang.String title,
              boolean append,
              TaskMonitor monitor)
       throws CancelledException

Sets the graph to be displayed or consumed by this graph display

Parameters:

graph - the graph to display or consume

title - a title for the graph

monitor - a TaskMonitor which can be used to cancel the graphing operation

append - if true, append the new graph to any existing graph

Throws:

CancelledException - thrown if the graphing operation was cancelled

clear

void clear()

Clears all graph vertices and edges from this graph display

updateVertexName

void updateVertexName(AttributedVertex vertex,
                      java.lang.String newName)

Updates a vertex to a new name

Parameters:

vertex - the vertex to rename

newName - the new name for the vertex

getGraphTitle

java.lang.String getGraphTitle()

Returns the title of the current graph

Returns:

the title of the current graph

addAction NEW

void addAction(DockingActionIf action)

Adds the action to the graph display. Not all GraphDisplays support adding custom actions, so this may have no effect.

Parameters:

action - the action to add