Interface LayoutProvider<V extends VisualVertex,​E extends VisualEdge<V>,​G extends VisualGraph<V,​E>>

  • Type Parameters:
    V - the vertex type
    E - the edge type
    G - the graph type
    All Superinterfaces:
    ExtensionPoint
    All Known Implementing Classes:
    AbstractLayoutProvider, JungLayoutProvider

    public interface LayoutProvider<V extends VisualVertex,​E extends VisualEdge<V>,​G extends VisualGraph<V,​E>>
    extends ExtensionPoint
    A layout provider creates VisualGraphLayout instances. This class provides a name and icon for use in a UI. These features can be used to create a menu of layouts that may be applied.

    The pattern of usage for this class is for it to create the layout that it represents and then to apply the locations of that layout to the vertices (and edges, in the case of articulating edges) of the graph before returning the new layout.

    • Method Detail

      • getLayoutName

        java.lang.String getLayoutName()
        Returns the name of this layout
        Returns:
        the name of this layout
      • getActionIcon

        javax.swing.Icon getActionIcon()
        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.
        Returns:
        an icon that can be used to show the provider a menu or toolbar
      • getPriorityLevel

        int getPriorityLevel()
        Returns an arbitrary value that is relative to other LayoutProviders. The higher the value the more preferred the provider will be over other providers.
        Returns:
        the priority