Package org.onosproject.ui

Interface UiExtensionService

  • public interface UiExtensionService
    Service for registering user interface extensions.

    • Method Detail

      • register

        void register​(UiExtension extension)
        Registers the specified user interface extension.
        Parameters:
        extension - UI extension to register

      • unregister

        void unregister​(UiExtension extension)
        Unregisters the specified user interface extension.
        Parameters:
        extension - UI extension to unregister

      • register

        default void register​(UiGlyphFactory factory)
        Registers the specified user interface glyph factory.
        Parameters:
        factory - UI glyph factory to register

      • unregister

        default void unregister​(UiGlyphFactory factory)
        Unregisters the specified user interface glyph factory.
        Parameters:
        factory - UI glyph factory to unregister

      • register

        default void register​(UiTopoHighlighterFactory factory)
        Registers the specified topo hilighter factory.
        Parameters:
        factory - UI topo higlighter factory to register

      • unregister

        default void unregister​(UiTopoHighlighterFactory factory)
        Unregisters the specified user interface extension.
        Parameters:
        factory - UI topo higlighter factory to unregister

      • getExtensions

        List<UiExtension> getExtensions()
        Returns the list of registered user interface extensions.
        Returns:
        list of extensions

      • getViewExtension

        UiExtension getViewExtension​(String viewId)
        Returns the user interface extension that contributed the specified view.
        Parameters:
        viewId - view identifier
        Returns:
        contributing user interface extension

      • getGlyphs

        default List<UiGlyph> getGlyphs()
        Returns the list of registered user interface glyphs.
        Returns:
        list of glyphs

      • getTopoHighlighterFactories

        default List<UiTopoHighlighterFactory> getTopoHighlighterFactories()
        Returns the list of registered topo highlighter factories.
        Returns:
        list of highlighter factories

      • getNavLionBundle

        LionBundle getNavLionBundle()
        Returns the navigation pane localization bundle.
        Returns:
        the navigation localization bundle

      • refreshModel

        void refreshModel()
        Refreshes the backing model.