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

Class AdminPageImpl

java.lang.Object

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

All Implemented Interfaces:

AdminPage

@ApplicationScoped
public class AdminPageImpl
extends Object
implements AdminPage

Constructor Summary

Constructors

Constructor and Description
AdminPageImpl()
AdminPageImpl(PlaceManager placeManager, javax.enterprise.event.Event<PreferencesCentralInitializationEvent> preferencesCentralInitializationEvent, PreferenceScopeResolutionStrategy resolutionStrategy, UberfireBreadcrumbs breadcrumbs, org.jboss.errai.ui.client.local.spi.TranslationService translationService)

Method Summary

Modifier and Type	Method and Description
void	addPreference(String screen, String identifier, String title, 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, 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, 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, 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, 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	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdminPageImpl

public AdminPageImpl()

AdminPageImpl

@Inject
public AdminPageImpl(PlaceManager placeManager,
                             javax.enterprise.event.Event<PreferencesCentralInitializationEvent> preferencesCentralInitializationEvent,
                             PreferenceScopeResolutionStrategy resolutionStrategy,
                             UberfireBreadcrumbs breadcrumbs,
                             org.jboss.errai.ui.client.local.spi.TranslationService translationService)

Method Detail

addScreen

public void addScreen(String identifier,
                      String title)

Description copied from interface: AdminPage

Adds a new admin screen context to be configured and opened.

Specified by:

addScreen in interface AdminPage

Parameters:

identifier - Admin screen identifier.

title - Admin screen title.

addTool

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

Description copied from interface: AdminPage

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

Specified by:

addTool in interface AdminPage

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

public void addTool(String screen,
                    String title,
                    String iconCss,
                    String category,
                    Command command)

Description copied from interface: AdminPage

Adds a new admin tool to the admin page.

Specified by:

addTool in interface AdminPage

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

public void addPreference(String screen,
                          String identifier,
                          String title,
                          String iconCss,
                          String category,
                          AdminPageOptions... options)

Description copied from interface: AdminPage

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

Specified by:

addPreference in interface AdminPage

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

public void addPreference(String screen,
                          String identifier,
                          String title,
                          String iconCss,
                          String category,
                          Supplier<PreferenceScopeResolutionStrategyInfo> customScopeResolutionStrategySupplier,
                          AdminPageOptions... options)

Description copied from interface: AdminPage

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

Specified by:

addPreference in interface AdminPage

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

public void addPreference(String screen,
                          String identifier,
                          String title,
                          String iconCss,
                          String category,
                          PreferenceScope preferenceScope,
                          AdminPageOptions... options)

Description copied from interface: AdminPage

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

Specified by:

addPreference in interface AdminPage

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

public void addPreference(String screen,
                          String identifier,
                          String title,
                          String iconCss,
                          String category,
                          Supplier<PreferenceScopeResolutionStrategyInfo> customScopeResolutionStrategySupplier,
                          PreferenceScope preferenceScope,
                          AdminPageOptions... options)

Description copied from interface: AdminPage

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

Specified by:

addPreference in interface AdminPage

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

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

Description copied from interface: AdminPage

Returns all added admin tools, grouped by their category.

Specified by:

getToolsByCategory in interface AdminPage

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

public String getScreenTitle(String screen)

Description copied from interface: AdminPage

Returns the screen title to be exhibit in the admin page.

Specified by:

getScreenTitle in interface AdminPage

Parameters:

screen - Screen identifier.

Returns:

Screen title, as passed when the screen was added.

getDefaultScreen

public String getDefaultScreen()

Description copied from interface: AdminPage

Returns the default screen to be opened when navigating to the Admin Page perspective.

Specified by:

getDefaultScreen in interface AdminPage

Returns:

Default screen identifier.

setDefaultScreen

public void setDefaultScreen(String defaultScreen)

Description copied from interface: AdminPage

Defines the default screen to be opened when navigating to the Admin Page perspective.

Specified by:

setDefaultScreen in interface AdminPage

Parameters:

defaultScreen - Default screen identifier. Must not be null or empty.