Package com.hybris.backoffice.widgets.processes.settings

Class ProcessesSettingsManager

  • public class ProcessesSettingsManager
extends java.lang.Object
    Processes settings manager - manages specified setting so they can be modified session not affecting widget's settings.

    • Constructor Summary

      Constructors 
      Constructor Description
      ProcessesSettingsManager​(com.hybris.cockpitng.engine.WidgetInstanceManager wim)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addBooleanSetting​(java.lang.String settingName, org.zkoss.zul.Checkbox checkbox, org.zkoss.zul.Label stateLabel)
      Adds boolean setting to manager.
      void addSettingChangedListener​(java.util.function.BiConsumer<java.lang.String,​java.lang.Object> listener)
      Adds lister to managed settings.
      void addTimeRangeSetting​(java.lang.String settingName, org.zkoss.zul.Listbox rangeList, org.zkoss.zul.Label statusLabel)
      Adds time range setting.
      protected java.util.List<TimeRange> createTimeRanges​(java.lang.String settingName)  
      protected java.lang.String getSettingPath​(java.lang.String settingName)  
      <T> T getSettingValue​(java.lang.String settingName, java.lang.Class<T> tClass)
      Returns value of managed setting.
      TimeRangeFactory getTimeRangeFactory()  
      com.hybris.cockpitng.engine.WidgetInstanceManager getWim()  
      protected void initBooleanSettingValue​(java.lang.String settingName, org.zkoss.zul.Checkbox checkbox, org.zkoss.zul.Label stateLabel)  
      protected void initRangeSettingValue​(java.lang.String settingName, org.zkoss.zul.Label statusLabel, org.zkoss.zul.ListModelList<TimeRange> model)  
      protected void notifySettingChanged​(java.lang.String settingName, java.lang.Object updatedValue)  
      protected void updateBooleanLabel​(org.zkoss.zul.Label stateLabel, boolean isChecked)  
      protected void updateChosenRange​(java.lang.String settingName, org.zkoss.zul.Label rangeStateLabel, TimeRange timeRange)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • SETTINGS_PATH_PREFIX

        public static final java.lang.String SETTINGS_PATH_PREFIX
        See Also:
        Constant Field Values

      • DEFAULT_TIME_RANGE

        protected static final java.lang.String DEFAULT_TIME_RANGE
        See Also:
        Constant Field Values

      • LABEL_STATE_ENABLED

        protected static final java.lang.String LABEL_STATE_ENABLED
        See Also:
        Constant Field Values

      • LABEL_STATE_DISABLED

        protected static final java.lang.String LABEL_STATE_DISABLED
        See Also:
        Constant Field Values

    • Constructor Detail

      • ProcessesSettingsManager

        public ProcessesSettingsManager​(com.hybris.cockpitng.engine.WidgetInstanceManager wim)

    • Method Detail

      • getSettingValue

        public <T> T getSettingValue​(java.lang.String settingName,
                             java.lang.Class<T> tClass)
        Returns value of managed setting.
        Type Parameters:
        T - expected type of setting value
        Parameters:
        settingName - setting name
        tClass - class of the setting
        Returns:
        setting value

      • addSettingChangedListener

        public void addSettingChangedListener​(java.util.function.BiConsumer<java.lang.String,​java.lang.Object> listener)
        Adds lister to managed settings.
        Parameters:
        listener - consumer which consumes setting name and update setting value.

      • addBooleanSetting

        public void addBooleanSetting​(java.lang.String settingName,
                              org.zkoss.zul.Checkbox checkbox,
                              org.zkoss.zul.Label stateLabel)
        Adds boolean setting to manager.
        Parameters:
        settingName - setting name
        checkbox - boolean checkbox
        stateLabel - label which is placeholder for checkbox state e.g. enabled/disbaled

      • initBooleanSettingValue

        protected void initBooleanSettingValue​(java.lang.String settingName,
                                       org.zkoss.zul.Checkbox checkbox,
                                       org.zkoss.zul.Label stateLabel)

      • updateBooleanLabel

        protected void updateBooleanLabel​(org.zkoss.zul.Label stateLabel,
                                  boolean isChecked)

      • addTimeRangeSetting

        public void addTimeRangeSetting​(java.lang.String settingName,
                                org.zkoss.zul.Listbox rangeList,
                                org.zkoss.zul.Label statusLabel)
        Adds time range setting. It populates list of available time ranges with given widget setting using TimeRangeFactory
        Parameters:
        settingName - name of a setting with time ranges
        rangeList - list where time ranges should be displayed
        statusLabel - placeholder which represent chosen range

      • initRangeSettingValue

        protected void initRangeSettingValue​(java.lang.String settingName,
                                     org.zkoss.zul.Label statusLabel,
                                     org.zkoss.zul.ListModelList<TimeRange> model)

      • updateChosenRange

        protected void updateChosenRange​(java.lang.String settingName,
                                 org.zkoss.zul.Label rangeStateLabel,
                                 TimeRange timeRange)

      • createTimeRanges

        protected java.util.List<TimeRange> createTimeRanges​(java.lang.String settingName)

      • notifySettingChanged

        protected void notifySettingChanged​(java.lang.String settingName,
                                    java.lang.Object updatedValue)

      • getSettingPath

        protected java.lang.String getSettingPath​(java.lang.String settingName)

      • getWim

        public com.hybris.cockpitng.engine.WidgetInstanceManager getWim()