com.vaadin.flow.component.html.DescriptionList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flow-html-components
There is a newer version: 1.2.4
/*
 * Copyright 2000-2018 Vaadin Ltd.
 *
 * 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 com.vaadin.flow.component.html;

import java.util.Map;
import java.util.stream.Stream;

import com.vaadin.flow.component.ClickNotifier;
import com.vaadin.flow.component.Component;
import com.vaadin.flow.component.HtmlContainer;
import com.vaadin.flow.component.Tag;

/**
 * Component representing a <dl> element.
 *
 * @author Vaadin Ltd
 * @since 1.0
 */
@Tag(Tag.DL)
public class DescriptionList extends HtmlContainer implements ClickNotifier {

    /**
     * Component representing a <dt> element.
     *
     * @author Vaadin Ltd
 * @since 1.0
     */
    @Tag(Tag.DT)
    public static class Term extends HtmlContainer implements ClickNotifier {

        /**
         * Creates a new empty term.
         */
        public Term() {
            super();
        }

        /**
         * Creates a new term with the given child components.
         *
         * @param components
         *            the child components
         */
        public Term(Component... components) {
            super(components);
        }

        /**
         * Creates a new term with the given text.
         *
         * @param text
         *            the text
         */
        public Term(String text) {
            super();
            setText(text);
        }
    }

    /**
     * Component representing a <dd> element.
     *
     * @author Vaadin Ltd
 * @since 1.0
     */
    @Tag(Tag.DD)
    public static class Description extends HtmlContainer
            implements ClickNotifier {

        /**
         * Creates a new empty description.
         */
        public Description() {
            super();
        }

        /**
         * Creates a new description with the given child components.
         *
         * @param components
         *            the child components
         */
        public Description(Component... components) {
            super(components);
        }

        /**
         * Creates a new description with the given text.
         *
         * @param text
         *            the text
         */
        public Description(String text) {
            super();
            setText(text);
        }
    }

    /**
     * Creates a new empty description list.
     */
    public DescriptionList() {
        super();
    }

    /**
     * Creates a new description list with the given map of terms and
     * descriptions.
     *
     * @param terms
     *            the map of terms and descriptions
     */
    public DescriptionList(Map terms) {
        super(terms.entrySet().stream()
                .flatMap(entry -> Stream.of(entry.getKey(), entry.getValue()))
                .toArray(Component[]::new));
    }
}