com.googlecode.wicketelements.components.locale.LanguagesPanel Maven / Gradle / Ivy

Go to download
/*
 *  Copyright 2011 Yannick LOTH.
 *
 *  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.
 *  under the License.
 */
package com.googlecode.wicketelements.components.locale;

import com.googlecode.wicketelements.library.behavior.AttributeModifierFactory;
import org.apache.wicket.Session;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.link.Link;
import org.apache.wicket.markup.html.list.ListItem;
import org.apache.wicket.markup.html.list.ListView;
import org.apache.wicket.markup.html.panel.Panel;
import org.apache.wicket.model.StringResourceModel;

import java.util.Locale;

import static com.googlecode.jbp.common.requirements.Reqs.PARAM_REQ;

/**
 * Panel that renders a list of locale links which, once clicked, change the
 * current locale of the user.
 *
 * @author Yannick LOTH
 */
public class LanguagesPanel extends Panel {

    public LanguagesPanel(final String id, final LocalesListModel locales) {
        super(id);
        init(locales);
    }

    private void init(final LocalesListModel locales) {
        populateRepeatingView(locales);
    }

    /**
     * This method is executed when the link to a locale is added to the page.
     *
     * @param localeLink The link for the specific locale.
     */
    protected void onLocaleLink(final Link localeLink) {
    }

    /**
     * This method is executed when the link to the current locale is added to
     * the page. It may be useful, for example, to disable the link, as the
     * locale is already selected, or to add some attribute to the tag.
     *
     * @param localeLink The link for the current locale.
     */
    protected void onSelectedLocaleLink(final Link localeLink) {
    }

    private void populateRepeatingView(final LocalesListModel locales) {
        PARAM_REQ.Object.requireNotNull(locales, "The locales list parameter must not be null.");
        PARAM_REQ.Object.requireNotNull(locales.getObject(), "The locales model object must not be null.");
        final ListView lv = new ListView("languages",
                locales.getObject()) {

            @Override
            protected void populateItem(final ListItem item) {
                final Locale locale = item.getModelObject();
                {
                    final Link link = new Link("languageLink",
                            new LocaleModel(locale)) {

                        /**
                         * serialVersionUID.
                         */
                        private static final long serialVersionUID = 1L;

                        @Override
                        public void onClick() {
                            final Locale locale = getModelObject();
                            Session.get().setLocale(locale);
                        }
                    };
                    final String upperCaseLocale = locale.getLanguage()
                            .toUpperCase(locale);
                    {
                        final Label languageLabel = new Label("languageLabel",
                                upperCaseLocale);
                        languageLabel.setRenderBodyOnly(true);
                        link.add(languageLabel);
                    }
                    if (locale.equals(Session.get().getLocale())) {
                        onLocaleLink(link);
                        onSelectedLocaleLink(link);
                    } else {
                        onLocaleLink(link);
                    }
                    link.add(AttributeModifierFactory
                            .newAttributeAppenderForTitle(new StringResourceModel(
                                    upperCaseLocale, this, null).getString()));
                    item.add(link);
                }
                item.setOutputMarkupId(true);
            }
        };
        lv.setRenderBodyOnly(true);
        add(lv);
    }
}