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 Summary

Modifier and Type	Method and Description
void	addPreference(String screen, String identifier, String title, String iconCss, String category) Adds a new admin tool that links to a preference to the admin page.
void	addPreference(String screen, String identifier, String title, String iconCss, String category, Map<String,String> customScopeResolutionStrategyParams)
void	addScreen(String identifier, String title)
void	addTool(String screen, String title, String iconCss, String category, Command command) Adds a new admin tool to the admin page.
void	addTool(String screen, String title, String iconCss, String category, Command command, ParameterizedCommand<ParameterizedCommand<Integer>> counterCommand) Adds a new admin tool to the admin page (with a counter).
String	getScreenTitle(String screen)
Map<String,List<AdminTool>>	getToolsByCategory(String screen) Returns all added admin tools, grouped by their category.

Method Detail

addScreen

void addScreen(String identifier,
               String title)

addTool

void addTool(String screen,
             String title,
             String iconCss,
             String category,
             Command command,
             ParameterizedCommand<ParameterizedCommand<Integer>> counterCommand)

Adds a new admin tool to the admin page (with a counter).

Parameters:

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,
             String iconCss,
             String category,
             Command command)

Adds a new admin tool to the admin page.

Parameters:

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,
                   String iconCss,
                   String category)

Adds a new admin tool that links to a preference to the admin page.

Parameters:

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.

addPreference

void addPreference(String screen,
                   String identifier,
                   String title,
                   String iconCss,
                   String category,
                   Map<String,String> customScopeResolutionStrategyParams)

getToolsByCategory

Map<String,List<AdminTool>> getToolsByCategory(String screen)

Returns all added admin tools, grouped by their category.

Returns:

A map containing a list of admin tools by each category.

getScreenTitle

String getScreenTitle(String screen)