Package org.uberfire.ext.preferences.client.admin.page

Interface AdminPage

  • All Known Implementing Classes:
    AdminPageImpl
    public interface AdminPage
    Used to customize the admin page perspective.

    • Method Detail

      • addScreen

        void addScreen​(String identifier,
               String title)
        Adds a new admin screen context to be configured and opened.
        Parameters:
        identifier - Admin screen identifier.
        title - Admin screen title.

      • addTool

        void addTool​(String screen,
             String title,
             Set<String> iconCss,
             String category,
             org.uberfire.mvp.Command command,
             org.uberfire.mvp.ParameterizedCommand<org.uberfire.mvp.ParameterizedCommand<Integer>> counterCommand)
        Adds a new admin tool to the admin page (with a counter).
        Parameters:
        screen - Identifier for the admin screen where the tool will be inserted.
        title - Title that will be displayed on the tool accessor.
        iconCss - CSS class(es) responsible to stylize the icon.
        category - Defines the group inside which the shortcut will be.
        command - Command to be executed when the shortcut is accessed.
        counterCommand - ParameterizedCommand that calls its ParameterizedCommand parameter passing the counter.

      • addTool

        void addTool​(String screen,
             String title,
             Set<String> iconCss,
             String category,
             org.uberfire.mvp.Command command)
        Adds a new admin tool to the admin page.
        Parameters:
        screen - Identifier for the admin screen where the tool will be inserted.
        title - Title that will be displayed on the tool accessor.
        iconCss - CSS class(es) responsible to stylize the icon.
        category - Defines the group inside which the shortcut will be.
        command - Command to be executed when the shortcut is accessed.

      • addPreference

        void addPreference​(String screen,
                   String identifier,
                   String title,
                   Set<String> iconCss,
                   String category,
                   AdminPageOptions... options)
        Adds a new admin tool that links to a preference to the admin page.
        Parameters:
        screen - Identifier for the admin screen where the preference will be inserted.
        identifier - Preference identifier.
        title - Preference title that will be displayed on the tool accessor.
        iconCss - CSS class related to the shortcut icon.
        category - Defines the group inside which the shortcut will be.
        options - Defines options to customize the preference accessor.

      • addPreference

        void addPreference​(String screen,
                   String identifier,
                   String title,
                   Set<String> iconCss,
                   String category,
                   Supplier<org.uberfire.preferences.shared.impl.PreferenceScopeResolutionStrategyInfo> customScopeResolutionStrategySupplier,
                   AdminPageOptions... options)
        Adds a new admin tool that links to a preference to the admin page.
        Parameters:
        screen - Identifier for the admin screen where the preference will be inserted.
        identifier - Preference identifier.
        title - Preference title that will be displayed on the tool accessor.
        iconCss - CSS class related to the shortcut icon.
        category - Defines the group inside which the shortcut will be.
        customScopeResolutionStrategySupplier - Supplier for a custom preference scope resolution strategy. It will be used when the tool is selected.
        options - Defines options to customize the preference accessor.

      • addPreference

        void addPreference​(String screen,
                   String identifier,
                   String title,
                   Set<String> iconCss,
                   String category,
                   org.uberfire.preferences.shared.PreferenceScope preferenceScope,
                   AdminPageOptions... options)
        Adds a new admin tool that links to a preference to the admin page.
        Parameters:
        screen - Identifier for the admin screen where the preference will be inserted.
        identifier - Preference identifier.
        title - Preference title that will be displayed on the tool accessor.
        iconCss - CSS class related to the shortcut icon.
        category - Defines the group inside which the shortcut will be.
        preferenceScope - Scope where the preferences will be saved when edited. It will be used when the tool is selected.
        options - Defines options to customize the preference accessor.

      • addPreference

        void addPreference​(String screen,
                   String identifier,
                   String title,
                   Set<String> iconCss,
                   String category,
                   Supplier<org.uberfire.preferences.shared.impl.PreferenceScopeResolutionStrategyInfo> customScopeResolutionStrategySupplier,
                   org.uberfire.preferences.shared.PreferenceScope preferenceScope,
                   AdminPageOptions... options)
        Adds a new admin tool that links to a preference to the admin page.
        Parameters:
        screen - Identifier for the admin screen where the preference will be inserted.
        identifier - Preference identifier.
        title - Preference title that will be displayed on the tool accessor.
        iconCss - CSS class related to the shortcut icon.
        category - Defines the group inside which the shortcut will be.
        customScopeResolutionStrategySupplier - Supplier for a custom preference scope resolution strategy.
        preferenceScope - Scope where the preferences will be saved when edited. It will be used when the tool is selected.
        options - Defines options to customize the preference accessor.

      • getToolsByCategory

        Map<String,​List<AdminTool>> getToolsByCategory​(String screen)
        Returns all added admin tools, grouped by their category.
        Parameters:
        screen - Identifier for the admin screen from where the tools will be returned.
        Returns:
        A map containing a list of admin tools by each category of that screen.

      • getScreenTitle

        String getScreenTitle​(String screen)
        Returns the screen title to be exhibit in the admin page.
        Parameters:
        screen - Screen identifier.
        Returns:
        Screen title, as passed when the screen was added.

      • getDefaultScreen

        String getDefaultScreen()
        Returns the default screen to be opened when navigating to the Admin Page perspective.
        Returns:
        Default screen identifier.

      • setDefaultScreen

        void setDefaultScreen​(String defaultScreen)
        Defines the default screen to be opened when navigating to the Admin Page perspective.
        Parameters:
        defaultScreen - Default screen identifier. Must not be null or empty.