org.apache.wicket.markup.html.basic.MultiLineLabel.java Source code

Introduction

Here is the source code for org.apache.wicket.markup.html.basic.MultiLineLabel.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.wicket.markup.html.basic;

import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.markup.MarkupStream;
import org.apache.wicket.markup.html.WebComponent;
import org.apache.wicket.markup.parser.XmlTag.TagType;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.apache.wicket.util.string.Strings;

/**
 * A MultiLineLabel component replaces its body with the model object.
 * <p>
 * Unlike {@link Label}, {@link MultiLineLabel} shows text that spans multiple lines by inserting
 * line breaks (<code>BR</code> tags) for newlines and paragraph markers (<code>P</code> tags) for
 * sequences of more than one newline.
 * 
 * @author Jonathan Locke
 */
public class MultiLineLabel extends WebComponent {
    private static final long serialVersionUID = 1L;

    /**
     * Constructor. Same as Label(String).
     * 
     * @param id
     *            See Component
     * @see Label#Label(String)
     */
    public MultiLineLabel(final String id) {
        super(id);
    }

    /**
     * Convenience constructor. Same as MultiLineLabel(String, new Modell&lt;String&gt;(String))
     * 
     * @param id
     *            See Component
     * @param label
     *            The label text
     * 
     * @see org.apache.wicket.Component#Component(String, IModel)
     */
    public MultiLineLabel(final String id, String label) {
        this(id, new Model<>(label));
    }

    /**
     * @see org.apache.wicket.Component#Component(String, IModel)
     */
    public MultiLineLabel(final String id, IModel<?> model) {
        super(id, model);
    }

    @Override
    public void onComponentTagBody(final MarkupStream markupStream, final ComponentTag openTag) {
        CharSequence body = Strings.toMultilineMarkup(getDefaultModelObjectAsString());
        replaceComponentTagBody(markupStream, openTag, body);
    }

    @Override
    protected void onComponentTag(ComponentTag tag) {
        super.onComponentTag(tag);

        // always transform the tag to <span></span> so even labels defined as <span/> render
        tag.setType(TagType.OPEN);
    }
}