Package org.kie.workbench.common.widgets.client.handlers.workbench.configuration

Class WorkbenchConfigurationHandler

  • Direct Known Subclasses:
    LanguageConfigurationHandler
    public abstract class WorkbenchConfigurationHandler
extends Object
    Definition of Handler to support add new menu of workbench configuration

    • Constructor Detail

      • WorkbenchConfigurationHandler

        public WorkbenchConfigurationHandler()

    • Method Detail

      • initHandler

        protected abstract void initHandler()

      • getDescription

        public abstract String getDescription()
        A description of the new workbench configuration menu
        Returns:

      • configurationSetting

        public abstract void configurationSetting​(boolean isInit)
        An entry-point for workbench configuration
        Parameters:
        isInit - , is initialization

      • getExtensions

        public List<org.uberfire.commons.data.Pair<String,​? extends com.google.gwt.user.client.ui.Composite>> getExtensions()
        Return a List of Widgets that the NewWorkbenchConfigurationHandler can use to gather additional parameters for the new workbench configuration. The List is of Pairs, where each Pair consists of a String caption and IsWidget editor.
        Returns:
        null if no extension is provided

      • loadUserWorkbenchPreferences

        public void loadUserWorkbenchPreferences()
        Provide NewWorkbenchConfigurationHandler with the ability to load UserWorkbenchPreferences from git repository

      • saveUserWorkbenchPreferences

        public void saveUserWorkbenchPreferences()
        Provide NewWorkbenchConfigurationHandler with the ability to store UserWorkbenchPreferences into GIT repository

      • setDefaultConfigurationValues

        protected abstract void setDefaultConfigurationValues​(org.uberfire.ext.services.shared.preferences.UserWorkbenchPreferences response)
        Set default configuration value
        Parameters:
        response - : user preferences from GIT repository

      • getSelectedUserWorkbenchPreferences

        protected abstract org.uberfire.ext.services.shared.preferences.UserWorkbenchPreferences getSelectedUserWorkbenchPreferences()
        get currently user preferences from selected item widget
        Returns:

      • getWidgetByName

        public com.google.gwt.user.client.ui.Composite getWidgetByName​(String name)
        get specific widget by using widget name
        Parameters:
        name - : specific widget name
        Returns:

      • getPreference

        public org.uberfire.ext.services.shared.preferences.UserWorkbenchPreferences getPreference()

      • setPreference

        public void setPreference​(org.uberfire.ext.services.shared.preferences.UserWorkbenchPreferences response)