src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/BodyContents.java
changeset 59294 48b88b9c11eb
equal deleted inserted replaced
59293:5af9fa90cd7b 59294:48b88b9c11eb
       
     1 /*
       
     2  * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
       
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
       
     4  *
       
     5  * This code is free software; you can redistribute it and/or modify it
       
     6  * under the terms of the GNU General Public License version 2 only, as
       
     7  * published by the Free Software Foundation.  Oracle designates this
       
     8  * particular file as subject to the "Classpath" exception as provided
       
     9  * by Oracle in the LICENSE file that accompanied this code.
       
    10  *
       
    11  * This code is distributed in the hope that it will be useful, but WITHOUT
       
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
       
    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
       
    14  * version 2 for more details (a copy is included in the LICENSE file that
       
    15  * accompanied this code).
       
    16  *
       
    17  * You should have received a copy of the GNU General Public License version
       
    18  * 2 along with this work; if not, write to the Free Software Foundation,
       
    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
       
    20  *
       
    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
       
    22  * or visit www.oracle.com if you need additional information or have any
       
    23  * questions.
       
    24  */
       
    25 
       
    26 package jdk.javadoc.internal.doclets.formats.html.markup;
       
    27 
       
    28 import jdk.javadoc.internal.doclets.toolkit.Content;
       
    29 
       
    30 import java.util.ArrayList;
       
    31 import java.util.List;
       
    32 
       
    33 /**
       
    34  * A builder for the contents of the BODY element.
       
    35  *
       
    36  *  <p><b>This is NOT part of any supported API.
       
    37  *  If you write code that depends on this, you do so at your own risk.
       
    38  *  This code and its internal interfaces are subject to change or
       
    39  *  deletion without notice.</b>
       
    40  */
       
    41 public class BodyContents {
       
    42 
       
    43     private List<Content> mainContents = new ArrayList<>();
       
    44     private Content header = HtmlTree.EMPTY;
       
    45     private Content footer = HtmlTree.EMPTY;
       
    46 
       
    47     public BodyContents addMainContent(Content content) {
       
    48         mainContents.add(content);
       
    49         return this;
       
    50     }
       
    51 
       
    52     public BodyContents setHeader(Content header) {
       
    53         this.header = header;
       
    54         return this;
       
    55     }
       
    56 
       
    57     public BodyContents setFooter(Content footer) {
       
    58         this.footer = footer;
       
    59         return this;
       
    60     }
       
    61 
       
    62     /**
       
    63      * Returns the HTML for the contents of the BODY element.
       
    64      *
       
    65      * @return the HTML
       
    66      */
       
    67     public Content toContent() {
       
    68         HtmlTree mainTree = HtmlTree.MAIN();
       
    69         mainContents.forEach(mainTree::add);
       
    70         HtmlTree flexHeader = HtmlTree.HEADER().setStyle(HtmlStyle.flexHeader);
       
    71         flexHeader.add(header);
       
    72         HtmlTree flexBox = HtmlTree.DIV(HtmlStyle.flexBox, flexHeader);
       
    73         HtmlTree flexContent = HtmlTree.DIV(HtmlStyle.flexContent, mainTree);
       
    74         flexContent.add(footer);
       
    75         flexBox.add(flexContent);
       
    76         return flexBox;
       
    77     }
       
    78 }