FilthyBuildedPanel.java

package org.jtheque.ui.utils.builded;

import org.jtheque.i18n.Internationalizable;
import org.jtheque.i18n.InternationalizableContainer;
import org.jtheque.i18n.LanguageService;
import org.jtheque.ui.FilthyUtils;
import org.jtheque.ui.Model;
import org.jtheque.ui.View;
import org.jtheque.ui.components.filthy.FilthyBackgroundPanel;
import org.jtheque.ui.utils.builders.FilthyPanelBuilder;
import org.jtheque.ui.utils.builders.I18nPanelBuilder;
import org.jtheque.utils.collections.CollectionUtils;

import javax.annotation.PostConstruct;
import javax.swing.JComponent;

import java.util.Collection;

/*
 * Copyright JTheque (Baptiste Wicht)
 *
 * 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.
 */

/**
 * A filthy builded panel.
 *
 * @author Baptiste Wicht
 */
public abstract class FilthyBuildedPanel extends FilthyBackgroundPanel implements InternationalizableContainer, View {
    private final Collection<Internationalizable> internationalizables = CollectionUtils.newList(15);

    private LanguageService languageService;

    private Model model;

    /**
     * Construct a FilthyBuildedPanel.
     */
    protected FilthyBuildedPanel() {
        super();
    }

    /**
     * Construct a new FilthyBuildedPanel.
     *
     * @param filthyUtils     The filthyUtils.
     * @param languageService The language service.
     */
    public FilthyBuildedPanel(FilthyUtils filthyUtils, LanguageService languageService) {
        super(filthyUtils);

        this.languageService = languageService;
    }

    /**
     * Build the panel.
     */
    @PostConstruct
    protected final void build() {
        getLanguageService().addInternationalizable(this);

        I18nPanelBuilder panelBuilder = new FilthyPanelBuilder(this);
        panelBuilder.setInternationalizableContainer(this);

        buildView(panelBuilder);

        refreshText(getLanguageService());
    }

    /**
     * Init the view.
     *
     * @param builder The builder.
     */
    protected abstract void buildView(I18nPanelBuilder builder);

    /**
     * Return the language service to use to internationalize the panel.
     *
     * @return The language service.
     */
    protected LanguageService getLanguageService() {
        return languageService;
    }

    @Override
    public void addInternationalizable(Internationalizable internationalizable) {
        internationalizables.add(internationalizable);
    }

    @Override
    public void refreshText(LanguageService languageService) {
        for (Internationalizable internationalizable : internationalizables) {
            internationalizable.refreshText(languageService);
        }
    }

    @Override
    public void display() {
        //Nothing by default
    }

    @Override
    public void closeDown() {
        //Nothing by default
    }

    @Override
    public void toFirstPlan() {
        //Nothing by default
    }

    @Override
    public void sendMessage(String message, Object value) {
        //Nothing by default
    }

    @Override
    public void refresh() {
        //Nothing by default
    }

    @Override
    public JComponent getImpl() {
        return this;
    }

    @Override
    public Model getModel() {
        return model;
    }

    @Override
    public boolean validateContent() {
        return true;
    }

    /**
     * Set the model.
     *
     * @param model The model of the view.
     */
    protected void setModel(Model model) {
        this.model = model;
    }
}