com.vaadin.flow.component.combobox.ComboBoxRenderManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-combo-box-flow Show documentation
Vaadin Combo Box
There is a newer version: 24.5.4
Show newest version
/*
 * Copyright 2000-2024 Vaadin Ltd.
 *
 * 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.vaadin.flow.component.combobox;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

import com.vaadin.flow.data.renderer.Renderer;
import com.vaadin.flow.shared.Registration;

/**
 * Internal class for managing rendering related logic for combo box components
 *
 * @param 
 *            Type of individual items that are selectable in the combo box
 */
class ComboBoxRenderManager implements Serializable {

    private final ComboBoxBase comboBox;
    private Renderer renderer;

    private boolean renderScheduled;
    private final List renderingRegistrations = new ArrayList<>();

    ComboBoxRenderManager(ComboBoxBase comboBox) {
        this.comboBox = comboBox;
    }

    void setRenderer(Renderer renderer) {
        Objects.requireNonNull(renderer, "The renderer must not be null");
        this.renderer = renderer;

        scheduleRender();
    }

    void scheduleRender() {
        if (renderScheduled || comboBox.getDataCommunicator() == null
                || renderer == null) {
            return;
        }
        renderScheduled = true;
        comboBox.runBeforeClientResponse(ui -> {
            render();
            renderScheduled = false;
        });
    }

    private void render() {
        renderingRegistrations.forEach(Registration::remove);
        renderingRegistrations.clear();

        var dataCommunicator = comboBox.getDataCommunicator();

        var rendering = renderer.render(comboBox.getElement(),
                dataCommunicator != null ? dataCommunicator.getKeyMapper()
                        : null);

        rendering.getDataGenerator().ifPresent(renderingDataGenerator -> {
            Registration renderingDataGeneratorRegistration = comboBox
                    .getDataGenerator()
                    .addDataGenerator(renderingDataGenerator);
            renderingRegistrations.add(renderingDataGeneratorRegistration);
        });

        renderingRegistrations.add(rendering.getRegistration());

        comboBox.getDataController().reset();
        if (comboBox.getValue() != null) {
            // renderer might added new dataGenerator -> refresh getValue() JSON
            // data so it also contains the new dataGenerator data
            comboBox.refreshValue();
        }
    }
}