Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class SingleIndexWriter

java.lang.Object

gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter

gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter

gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter

gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractIndexWriter

gw.gosudoc.com.sun.tools.doclets.formats.html.SingleIndexWriter

@Deprecated
public class SingleIndexWriter
extends AbstractIndexWriter

Deprecated.

Generate only one index file for all the Member Names with Indexing in Unicode Order. The name of the generated file is "index-all.html" and it is generated in current or the destination directory.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

See Also:

Character

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<java.lang.Object>	elements	Deprecated.

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractIndexWriter

indexbuilder

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter

blockTags, configuration, filename, fixedNavDiv, path, pathToRoot, printedAnnotationFieldHeading, printedAnnotationHeading, utils

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter

CONTENT_TYPE

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter

allclassesLabel, allpackagesLabel, annotationTypeDetailsLabel, classLabel, constructorDetailsLabel, defaultPackageLabel, deprecatedLabel, deprecatedPhrase, descfrmClassLabel, descfrmInterfaceLabel, descriptionLabel, detailLabel, enumConstantsDetailsLabel, fieldDetailsLabel, framesLabel, helpLabel, indexLabel, memberDetailsListPrinted, methodDetailsLabel, modifierTypeHeader, nextclassLabel, nextLabel, nextpackageLabel, noframesLabel, overridesLabel, overviewLabel, packageLabel, packagesLabel, packageTableHeader, prevclassLabel, prevLabel, prevpackageLabel, propertyDetailsLabel, script, seeLabel, specifiedByLabel, summaryLabel, treeLabel, useLabel, useTableSummary, winTitle

Constructor Summary

Constructors

Constructor	Description
SingleIndexWriter(ConfigurationImpl configuration, DocPath filename, IndexBuilder indexbuilder)	Deprecated. Construct the SingleIndexWriter with filename "index-all.html" and the IndexBuilder

Method Summary

Modifier and Type	Method	Description
protected void	addLinksForIndexes(Content contentTree)	Deprecated. Add links for all the Index Files per unicode character.
static void	generate(ConfigurationImpl configuration, IndexBuilder indexbuilder)	Deprecated. Generate single index file, for all Unicode characters.
protected void	generateIndexFile()	Deprecated. Generate the contents of each index file, with Header, Footer, Member Field, Method and Constructor Description.

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractIndexWriter

addClassInfo, addComment, addContents, addContents, addDescription, addDescription, addDescription, addDescription, addDescription, addHeading, addMemberDesc, addSearchContents, createSearchIndexFile, createSearchIndexFiles, getMarkerAnchorForIndex, getNameForIndex, getNavLinkIndex, zipFile

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter

addAnnotationInfo, addAnnotationInfo, addAnnotationInfo, addBottom, addInlineComment, addInlineComment, addInlineDeprecatedComment, addNavLinks, addPackageDeprecatedAPI, addPreQualifiedClassLink, addPreQualifiedClassLink, addPreQualifiedStrongClassLink, addReceiverAnnotationInfo, addScriptProperties, addSrcLink, addStyleSheetProperties, addSummaryComment, addSummaryComment, addSummaryDeprecatedComment, addSummaryDetailLinks, addTagsInfo, addTop, check, commentTagsToContent, configuration, getAllClassesLinkScript, getAnchor, getAnchor, getAnnotations, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getLink, getMarkerAnchor, getMarkerAnchor, getMarkerAnchor, getMarkerAnchor, getNavHideLists, getNavLinkClass, getNavLinkClassIndex, getNavLinkClassUse, getNavLinkContents, getNavLinkDeprecated, getNavLinkHelp, getNavLinkMainTree, getNavLinkNext, getNavLinkNext, getNavLinkPackage, getNavLinkPackage, getNavLinkPrevious, getNavLinkPrevious, getNavLinkTree, getNavShowLists, getNavShowLists, getPackageAnchorName, getPackageLabel, getPackageLink, getPackageLink, getPackageName, getPreQualifiedClassLink, getQualifiedClassLink, getSummaryTableHeader, getTableCaption, getTagletWriterInstance, getTargetPackageLink, getTypeParameterLinks, getUserHeaderFooter, getWindowTitle, hasSerializationOverviewTags, isClassLinkable, isCoreClass, italicsClassName, pathString, pathString, printHtmlDocument, removeNonInlineHtmlTags, replaceDocRootDir, seeTagToContent

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter

getDocLink, getDocLink, getDocLink, getGeneratedBy, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getMemberDetailsListPrinted, getName, getPkgName, getStyleSheetProperties, printFramesDocument

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter

addStyles, close, codeText, generateMethodTypesScript, getBody, getFramesJavaScript, getModifierTypeHeader, getNonBreakResource, getResource, getResource, getResource, getSpace, getTitle, getWinTitleScript, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

elements

private java.util.List<java.lang.Object> elements

Deprecated.

Constructor Detail

SingleIndexWriter

public SingleIndexWriter(ConfigurationImpl configuration,
                         DocPath filename,
                         IndexBuilder indexbuilder)
                  throws java.io.IOException

Deprecated.

Construct the SingleIndexWriter with filename "index-all.html" and the IndexBuilder

Parameters:

filename - Name of the index file to be generated.

indexbuilder - Unicode based Index from IndexBuilder

Throws:

java.io.IOException

Method Detail

generate

public static void generate(ConfigurationImpl configuration,
                            IndexBuilder indexbuilder)

Deprecated.

Generate single index file, for all Unicode characters.

Parameters:

indexbuilder - IndexBuilder built by IndexBuilder

Throws:

DocletAbortException

generateIndexFile

protected void generateIndexFile()
                          throws java.io.IOException

Deprecated.

Generate the contents of each index file, with Header, Footer, Member Field, Method and Constructor Description.

Throws:

java.io.IOException

addLinksForIndexes

protected void addLinksForIndexes(Content contentTree)

Deprecated.

Add links for all the Index Files per unicode character.

Parameters:

contentTree - the content tree to which the links for indexes will be added