public interface AdminPage
Modifier and Type | Method and Description |
---|---|
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.
|
void |
addPreference(String screen,
String identifier,
String title,
Set<String> iconCss,
String category,
PreferenceScope preferenceScope,
AdminPageOptions... options)
Adds a new admin tool that links to a preference to the admin page.
|
void |
addPreference(String screen,
String identifier,
String title,
Set<String> iconCss,
String category,
Supplier<PreferenceScopeResolutionStrategyInfo> customScopeResolutionStrategySupplier,
AdminPageOptions... options)
Adds a new admin tool that links to a preference to the admin page.
|
void |
addPreference(String screen,
String identifier,
String title,
Set<String> iconCss,
String category,
Supplier<PreferenceScopeResolutionStrategyInfo> customScopeResolutionStrategySupplier,
PreferenceScope preferenceScope,
AdminPageOptions... options)
Adds a new admin tool that links to a preference to the admin page.
|
void |
addScreen(String identifier,
String title)
Adds a new admin screen context to be configured and opened.
|
void |
addTool(String screen,
String title,
Set<String> iconCss,
String category,
Command command)
Adds a new admin tool to the admin page.
|
void |
addTool(String screen,
String title,
Set<String> iconCss,
String category,
Command command,
ParameterizedCommand<ParameterizedCommand<Integer>> counterCommand)
Adds a new admin tool to the admin page (with a counter).
|
String |
getDefaultScreen()
Returns the default screen to be opened when navigating to the Admin Page perspective.
|
String |
getScreenTitle(String screen)
Returns the screen title to be exhibit in the admin page.
|
Map<String,List<AdminTool>> |
getToolsByCategory(String screen)
Returns all added admin tools, grouped by their category.
|
void |
setDefaultScreen(String defaultScreen)
Defines the default screen to be opened when navigating to the Admin Page perspective.
|
void addScreen(String identifier, String title)
identifier
- Admin screen identifier.title
- Admin screen title.void addTool(String screen, String title, Set<String> iconCss, String category, Command command, ParameterizedCommand<ParameterizedCommand<Integer>> counterCommand)
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.void addTool(String screen, String title, Set<String> iconCss, String category, Command command)
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.void addPreference(String screen, String identifier, String title, Set<String> iconCss, String category, AdminPageOptions... options)
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.void addPreference(String screen, String identifier, String title, Set<String> iconCss, String category, Supplier<PreferenceScopeResolutionStrategyInfo> customScopeResolutionStrategySupplier, AdminPageOptions... options)
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.void addPreference(String screen, String identifier, String title, Set<String> iconCss, String category, PreferenceScope preferenceScope, AdminPageOptions... options)
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.void addPreference(String screen, String identifier, String title, Set<String> iconCss, String category, Supplier<PreferenceScopeResolutionStrategyInfo> customScopeResolutionStrategySupplier, PreferenceScope preferenceScope, AdminPageOptions... options)
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.Map<String,List<AdminTool>> getToolsByCategory(String screen)
screen
- Identifier for the admin screen from where the tools will be returned.String getScreenTitle(String screen)
screen
- Screen identifier.String getDefaultScreen()
void setDefaultScreen(String defaultScreen)
defaultScreen
- Default screen identifier. Must not be null or empty.Copyright © 2012–2020 JBoss by Red Hat. All rights reserved.