org.vaadin.viritin.label.Header Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 mattitahvonenitmill.
 *
 * 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 org.vaadin.viritin.label;

import org.jsoup.Jsoup;
import org.jsoup.safety.Whitelist;

import com.vaadin.shared.ui.label.ContentMode;
import com.vaadin.ui.Label;

/**
 * Label whose content is wrapped in an H1,H2,H3.. element.
 *
 * Uses Jsoup for sanitation. Only text by default.
 */
public class Header extends Label {

    private static final long serialVersionUID = -2879612973232108854L;

    private String text;
    private int headerLevel = 1;

    protected Whitelist getWhitelist() {
        return Whitelist.none();
    }

    /**
     *
     * @param whitelist the whitelist used for sanitizing the header text
     * @return the object itself for further configuration
     * @deprecated Whitelist is not serializable. If using e.g. clustering,
     * override the getter method for whitelist instead.
     */
    @Deprecated
    public Header setWhitelist(Whitelist whitelist) {
        markAsDirty();
        return this;
    }

    public String getText() {
        return text;
    }

    public Header setText(String text) {
        this.text = text;
        markAsDirty();
        return this;
    }

    public int getHeaderLevel() {
        return headerLevel;
    }

    public Header setHeaderLevel(int headerLevel) {
        if (headerLevel < 1 || headerLevel > 6) {
            throw new IllegalArgumentException("Header levels 1-6 supported");
        }
        this.headerLevel = headerLevel;
        markAsDirty();
        return this;
    }

    public Header(String headerText) {
        text = headerText;
    }

    @Override
    public void setValue(String newStringValue) {
        setText(newStringValue);
    }

    @Override
    public void beforeClientResponse(boolean initial) {
        render();
        super.beforeClientResponse(initial);
    }

    private void render() {
        if (text != null) {
            setContentMode(ContentMode.HTML);
            StringBuilder sb = new StringBuilder("");
            sb.append(Jsoup.clean(text, getWhitelist()));
            sb.append("");
            super.setValue(sb.toString());
            text = null;
        }
    }

    public Header withStyleName(String... styleNames) {
        for (String styleName : styleNames) {
            addStyleName(styleName);
        }
        return this;
    }

}