Package ghidra.graph.support

Class TestLayoutProvider

java.lang.Object

ghidra.graph.support.TestLayoutProvider

All Implemented Interfaces:

LayoutProvider<AbstractTestVertex,TestEdge,TestVisualGraph>, ExtensionPoint

public class TestLayoutProvider
extends java.lang.Object
implements LayoutProvider<AbstractTestVertex,TestEdge,TestVisualGraph>

A layout provider used for testing.

Nested Class Summary

Nested classes/interfaces inherited from interface ghidra.util.classfinder.ExtensionPoint

ExtensionPoint.Exclude, ExtensionPoint.Util

Constructor Summary

Constructors

Constructor	Description
TestLayoutProvider()

Method Summary

Modifier and Type	Method	Description
protected edu.uci.ics.jung.algorithms.layout.Layout<AbstractTestVertex,TestEdge>	createJungLayout(TestVisualGraph g)
javax.swing.Icon	getActionIcon()	Returns an icon that can be used to show the provider a menu or toolbar.
TestGraphLayout	getLayout(TestVisualGraph g, TaskMonitor monitor)	Returns a new instance of the layout that this class provides
java.lang.String	getLayoutName()	Returns the name of this layout
int	getPriorityLevel()	Returns an arbitrary value that is relative to other LayoutProviders.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestLayoutProvider

public TestLayoutProvider()

Method Detail

getLayout

public TestGraphLayout getLayout(TestVisualGraph g,
                                 TaskMonitor monitor)
                          throws CancelledException

Description copied from interface: LayoutProvider

Returns a new instance of the layout that this class provides

Specified by:

getLayout in interface LayoutProvider<AbstractTestVertex,TestEdge,TestVisualGraph>

Parameters:

g - the graph

monitor - a task monitor

Returns:

the new layout

Throws:

CancelledException - if the monitor was cancelled

createJungLayout

protected edu.uci.ics.jung.algorithms.layout.Layout<AbstractTestVertex,TestEdge> createJungLayout(TestVisualGraph g)

getLayoutName

public java.lang.String getLayoutName()

Description copied from interface: LayoutProvider

Returns the name of this layout

Specified by:

getLayoutName in interface LayoutProvider<AbstractTestVertex,TestEdge,TestVisualGraph>

Returns:

the name of this layout

getActionIcon

public javax.swing.Icon getActionIcon()

Description copied from interface: LayoutProvider

Returns an icon that can be used to show the provider a menu or toolbar. This may return null, as an icon is not a requirement.

Specified by:

getActionIcon in interface LayoutProvider<AbstractTestVertex,TestEdge,TestVisualGraph>

Returns:

an icon that can be used to show the provider a menu or toolbar

getPriorityLevel

public int getPriorityLevel()

Description copied from interface: LayoutProvider

Returns an arbitrary value that is relative to other LayoutProviders. The higher the value the more preferred the provider will be over other providers.

Specified by:

getPriorityLevel in interface LayoutProvider<AbstractTestVertex,TestEdge,TestVisualGraph>

Returns:

the priority