com.intellij.openapi.options.CompositeSettingsEditor.java Source code

Introduction

Here is the source code for com.intellij.openapi.options.CompositeSettingsEditor.java

Source

/*
 * Copyright 2000-2016 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.openapi.options;

import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.util.Disposer;
import com.intellij.openapi.util.Factory;
import com.intellij.util.Alarm;
import org.jetbrains.annotations.NotNull;

import javax.swing.*;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;

public abstract class CompositeSettingsEditor<Settings> extends SettingsEditor<Settings> {
    public static final Logger LOG = Logger.getInstance(CompositeSettingsEditor.class);

    private Collection<SettingsEditor<Settings>> myEditors;
    private SettingsEditorListener<Settings> myChildSettingsListener;
    private SynchronizationController mySyncController;
    private boolean myIsDisposed = false;

    public CompositeSettingsEditor() {
    }

    public CompositeSettingsEditor(Factory<Settings> factory) {
        super(factory);
        if (factory != null) {
            mySyncController = new SynchronizationController();
        }
    }

    public abstract CompositeSettingsBuilder<Settings> getBuilder();

    @Override
    public void resetEditorFrom(@NotNull Settings settings) {
        for (final SettingsEditor<Settings> myEditor : myEditors) {
            try {
                myEditor.resetEditorFrom(settings);
            } catch (Exception e) {
                LOG.error(e);
            }
        }
    }

    @Override
    public void applyEditorTo(@NotNull Settings settings) throws ConfigurationException {
        for (final SettingsEditor<Settings> myEditor : myEditors) {
            try {
                myEditor.applyTo(settings);
            } catch (ConfigurationException e) {
                throw e;
            } catch (Exception e) {
                LOG.error(e);
            }
        }
    }

    @Override
    public void uninstallWatcher() {
        for (SettingsEditor<Settings> editor : myEditors) {
            editor.removeSettingsEditorListener(myChildSettingsListener);
        }
    }

    @Override
    public void installWatcher(JComponent c) {
        myChildSettingsListener = new SettingsEditorListener<Settings>() {
            @Override
            public void stateChanged(@NotNull SettingsEditor<Settings> editor) {
                fireEditorStateChanged();
                if (mySyncController != null)
                    mySyncController.handleStateChange(editor);
            }
        };

        for (SettingsEditor<Settings> editor : myEditors) {
            editor.addSettingsEditorListener(myChildSettingsListener);
        }
    }

    @Override
    @NotNull
    protected final JComponent createEditor() {
        CompositeSettingsBuilder<Settings> builder = getBuilder();
        myEditors = builder.getEditors();
        for (final SettingsEditor<Settings> editor : myEditors) {
            Disposer.register(this, editor);
            editor.setOwner(this);
        }
        return builder.createCompoundEditor();
    }

    @Override
    public void disposeEditor() {
        myIsDisposed = true;
    }

    private class SynchronizationController {
        private final Set<SettingsEditor> myChangedEditors = new HashSet<>();
        private final Alarm mySyncAlarm = new Alarm(Alarm.ThreadToUse.SWING_THREAD);
        private boolean myIsInSync = false;

        public void handleStateChange(SettingsEditor editor) {
            if (myIsInSync || myIsDisposed)
                return;
            myChangedEditors.add(editor);
            mySyncAlarm.cancelAllRequests();
            mySyncAlarm.addRequest(() -> {
                if (!myIsDisposed) {
                    sync();
                }
            }, 300);
        }

        public void sync() {
            myIsInSync = true;
            try {
                Settings snapshot = getSnapshot();
                for (SettingsEditor<Settings> editor : myEditors) {
                    if (!myChangedEditors.contains(editor)) {
                        editor.resetFrom(snapshot);
                    }
                }
            } catch (ConfigurationException ignored) {
            } finally {
                myChangedEditors.clear();
                myIsInSync = false;
            }
        }
    }
}