View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.devacfr.maven.skins.reflow.context;
20  
21  import javax.annotation.Nonnull;
22  
23  import org.devacfr.maven.skins.reflow.ISkinConfig;
24  import org.devacfr.maven.skins.reflow.model.Header;
25  import org.devacfr.maven.skins.reflow.model.Toc;
26  
27  import static org.devacfr.maven.skins.reflow.model.Toc.createToc;
28  
29  /**
30   * @author Christophe Friederich
31   * @since 2.0
32   */
33  public class PageContext extends Context<PageContext> {
34  
35      /** */
36      private final Toc<?> toc;
37  
38      /** */
39      private final Header header;
40  
41      /**
42       * Default constructor.
43       *
44       * @param config
45       *            a config (can not be {@code null}).
46       */
47      public PageContext(final @Nonnull ISkinConfig config) {
48          super(config, ContextType.page);
49          this.toc = createToc(config, null);
50          this.header = new Header(config);
51          this.addChildren(this.header, this.toc);
52      }
53  
54      /**
55       * Gets the header of page.
56       *
57       * @return Returns a {@code Header} representing the configuration of header.
58       */
59      public Header getHeader() {
60          return header;
61      }
62  
63      /**
64       * @return Returns the {@link Toc}.
65       */
66      public Toc<?> getToc() {
67          return toc;
68      }
69  }