org.squashtest.tm.web.internal.helper.InternationalizableLabelFormatter.java Source code

Introduction

Here is the source code for org.squashtest.tm.web.internal.helper.InternationalizableLabelFormatter.java

Source

/**
 *     This file is part of the Squashtest platform.
 *     Copyright (C) 2010 - 2016 Henix, henix.fr
 *
 *     See the NOTICE file distributed with this work for additional
 *     information regarding copyright ownership.
 *
 *     This is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     this software is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with this software.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.squashtest.tm.web.internal.helper;

import java.util.Locale;

import javax.inject.Inject;
import javax.validation.constraints.NotNull;

import org.apache.commons.lang3.StringEscapeUtils;
import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;
import org.squashtest.tm.core.foundation.i18n.Internationalizable;

/**
 * Formats {@link Internationalizable} items so that they are displayed in a combobox as
 * <code>"<item level> - <localized item message>"</code>
 * 
 * Objects of this class are not thread-safe
 * 
 * @author Gregory Fouquet
 * 
 */
@Component
@Scope("prototype")
public class InternationalizableLabelFormatter implements LabelFormatter<Internationalizable> {
    private final MessageSource messageSource;
    private Locale locale = Locale.getDefault();
    private boolean escapeHtml = true;

    /**
     * @param messageSource
     */
    @Inject
    public InternationalizableLabelFormatter(@NotNull MessageSource messageSource) {
        super();
        this.messageSource = messageSource;
    }

    /**
     * 
     * @see org.squashtest.tm.web.internal.helper.LabelFormatter#useLocale(java.util.Locale)
     */
    @Override
    public LabelFormatter<Internationalizable> useLocale(Locale locale) {
        this.locale = locale;
        return this;
    }

    /**
     * 
     * @see org.squashtest.tm.web.internal.helper.LabelFormatter#formatLabel(java.lang.Object)
     */
    @Override
    public String formatLabel(Internationalizable toFormat) {
        String label = messageSource.getMessage(toFormat.getI18nKey(), null, locale);
        return escapeHtml ? StringEscapeUtils.escapeHtml4(label) : label;
    }

    /**
     * @see org.squashtest.tm.web.internal.helper.LabelFormatter#escapeHtml()
     */
    @Override
    public LabelFormatter<Internationalizable> escapeHtml() {
        escapeHtml = true;
        return this;
    }

    /**
     * @see org.squashtest.tm.web.internal.helper.LabelFormatter#plainText()
     */
    @Override
    public LabelFormatter<Internationalizable> plainText() {
        escapeHtml = false;
        return this;
    }

}