001/*
002    Licensed to the Apache Software Foundation (ASF) under one
003    or more contributor license agreements.  See the NOTICE file
004    distributed with this work for additional information
005    regarding copyright ownership.  The ASF licenses this file
006    to you under the Apache License, Version 2.0 (the
007    "License"); you may not use this file except in compliance
008    with the License.  You may obtain a copy of the License at
009
010       http://www.apache.org/licenses/LICENSE-2.0
011
012    Unless required by applicable law or agreed to in writing,
013    software distributed under the License is distributed on an
014    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015    KIND, either express or implied.  See the License for the
016    specific language governing permissions and limitations
017    under the License.  
018*/
019package org.apache.wiki.parser;
020
021/**
022 *  This class is used to store the headings in a manner which
023 *  allow the building of a Table Of Contents.
024 *
025 *  @since 2.4
026 */
027public class Heading
028{
029    /**
030     *  Defines a small heading.
031     */
032    public static final int HEADING_SMALL  = 1;
033    
034    /**
035     *  Defines a medium-size heading.
036     */
037    public static final int HEADING_MEDIUM = 2;
038    
039    /**
040     *  Defines a large heading.
041     */
042    public static final int HEADING_LARGE  = 3;
043
044    /**
045     *  Denotes the level of the heading. Either HEADING_SMALL, HEADING_MEDIUM, or HEADING_LARGE.
046     */
047    public int    m_level;
048    
049    /**
050     *  Contains the text of the heading.
051     */
052    public String m_titleText;
053    
054    /**
055     *  Contains the anchor to the heading
056     */
057    public String m_titleAnchor;
058    
059    /**
060     *  Contains a section link.
061     */
062    public String m_titleSection;
063}