aoqi@0: /* aoqi@0: * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: * aoqi@0: * This code is free software; you can redistribute it and/or modify it aoqi@0: * under the terms of the GNU General Public License version 2 only, as aoqi@0: * published by the Free Software Foundation. Oracle designates this aoqi@0: * particular file as subject to the "Classpath" exception as provided aoqi@0: * by Oracle in the LICENSE file that accompanied this code. aoqi@0: * aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that aoqi@0: * accompanied this code). aoqi@0: * aoqi@0: * You should have received a copy of the GNU General Public License version aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: * aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: * or visit www.oracle.com if you need additional information or have any aoqi@0: * questions. aoqi@0: */ aoqi@0: aoqi@0: package com.sun.tools.doclets.formats.html; aoqi@0: aoqi@0: import java.io.*; aoqi@0: import java.util.*; aoqi@0: aoqi@0: import com.sun.javadoc.*; aoqi@0: import com.sun.tools.doclets.formats.html.markup.*; aoqi@0: import com.sun.tools.doclets.internal.toolkit.*; aoqi@0: import com.sun.tools.doclets.internal.toolkit.util.*; aoqi@0: aoqi@0: /** aoqi@0: * Abstract class to print the class hierarchy page for all the Classes. This aoqi@0: * is sub-classed by {@link PackageTreeWriter} and {@link TreeWriter} to aoqi@0: * generate the Package Tree and global Tree(for all the classes and packages) aoqi@0: * pages. aoqi@0: * aoqi@0: *
This is NOT part of any supported API.
aoqi@0: * If you write code that depends on this, you do so at your own risk.
aoqi@0: * This code and its internal interfaces are subject to change or
aoqi@0: * deletion without notice.
aoqi@0: *
aoqi@0: * @author Atul M Dambalkar
aoqi@0: */
aoqi@0: public abstract class AbstractTreeWriter extends HtmlDocletWriter {
aoqi@0:
aoqi@0: /**
aoqi@0: * The class and interface tree built by using {@link ClassTree}
aoqi@0: */
aoqi@0: protected final ClassTree classtree;
aoqi@0:
aoqi@0: private static final String LI_CIRCLE = "circle";
aoqi@0:
aoqi@0: /**
aoqi@0: * Constructor initializes classtree variable. This constructor will be used
aoqi@0: * while generating global tree file "overview-tree.html".
aoqi@0: *
aoqi@0: * @param configuration The current configuration
aoqi@0: * @param filename File to be generated.
aoqi@0: * @param classtree Tree built by {@link ClassTree}.
aoqi@0: * @throws IOException
aoqi@0: * @throws DocletAbortException
aoqi@0: */
aoqi@0: protected AbstractTreeWriter(ConfigurationImpl configuration,
aoqi@0: DocPath filename, ClassTree classtree)
aoqi@0: throws IOException {
aoqi@0: super(configuration, filename);
aoqi@0: this.classtree = classtree;
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Add each level of the class tree. For each sub-class or
aoqi@0: * sub-interface indents the next level information.
aoqi@0: * Recurses itself to add subclasses info.
aoqi@0: *
aoqi@0: * @param parent the superclass or superinterface of the list
aoqi@0: * @param list list of the sub-classes at this level
aoqi@0: * @param isEnum true if we are generating a tree for enums
aoqi@0: * @param contentTree the content tree to which the level information will be added
aoqi@0: */
aoqi@0: protected void addLevelInfo(ClassDoc parent, List