Class SubWriterHolderWriter
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.SubWriterHolderWriter
- Direct Known Subclasses:
AnnotationTypeWriterImpl
,ClassUseWriter
,ClassWriterImpl
,DeprecatedListWriter
,PackageUseWriter
,SerializedFormWriterImpl
Deprecated.
This abstract class exists to provide functionality needed in the
the formatting of member information. Since AbstractSubWriter and its
subclasses control this, they would be the logical place to put this.
However, because each member type has its own subclass, subclassing
can not be used effectively to change formatting. The concrete
class subclass of this class can be subclassed to change formatting.
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:
-
Field Summary
FieldsFields 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
ConstructorsConstructorDescriptionSubWriterHolderWriter
(ConfigurationImpl configuration, DocPath filename) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAnnotationContentTree
(Content contentTree, Content annotationContentTree) Deprecated.Add the annotation content tree.void
addClassContentTree
(Content contentTree, Content classContentTree) Deprecated.Add the class content tree.protected void
addIndexComment
(Doc member, Tag[] firstSentenceTags, Content tdSummary) Deprecated.Add the index comment.protected void
addIndexComment
(Doc member, Content contentTree) Deprecated.Add the index comment.void
addInheritedMemberSummary
(AbstractMemberWriter mw, ClassDoc cd, ProgramElementDoc member, boolean isFirst, Content linksTree) Deprecated.Add the inherited member summary.void
addInheritedSummaryHeader
(AbstractMemberWriter mw, ClassDoc cd, Content inheritedTree) Deprecated.Add the inherited summary header.void
addMemberTree
(Content memberSummaryTree, Content memberTree) Deprecated.Add the member tree.void
addSummaryHeader
(AbstractMemberWriter mw, ClassDoc cd, Content memberTree) Deprecated.Add the summary header.void
addSummaryLinkComment
(AbstractMemberWriter mw, ProgramElementDoc member, Tag[] firstSentenceTags, Content tdSummary) Deprecated.Add the summary link comment.void
addSummaryLinkComment
(AbstractMemberWriter mw, ProgramElementDoc member, Content contentTree) Deprecated.Add the summary link for the member.void
addSummaryType
(AbstractMemberWriter mw, ProgramElementDoc member, Content tdSummaryType) Deprecated.Add the summary type for the member.Deprecated.Get the document content header treegetMemberDetailsTree
(Content contentTree) Deprecated.Get the member details treegetMemberSummaryTree
(Content contentTree) Deprecated.Get the member summary treegetMemberTree
(HtmlStyle style, Content contentTree) Deprecated.Get the member treegetMemberTree
(Content contentTree) Deprecated.Get the member treeDeprecated.Get the member header treegetMethodTypeLinks
(MethodTypes methodType) Deprecated.Get the method type links for the table caption.getSummaryTableTree
(AbstractMemberWriter mw, ClassDoc cd, List<Content> tableContents, boolean showTabs) Deprecated.Get the summary table.getTableCaption
(Set<MethodTypes> methodTypes) Deprecated.Get the summary table caption.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, getNavLinkIndex, 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
-
Field Details
-
mainTree
Deprecated.The HTML tree for main tag.
-
-
Constructor Details
-
SubWriterHolderWriter
Deprecated.- Throws:
IOException
-
-
Method Details
-
addSummaryHeader
Deprecated.Add the summary header.- Parameters:
mw
- the writer for the member being documentedcd
- the classdoc to be documentedmemberTree
- the content tree to which the summary header will be added
-
getSummaryTableTree
public Content getSummaryTableTree(AbstractMemberWriter mw, ClassDoc cd, List<Content> tableContents, boolean showTabs) Deprecated.Get the summary table.- Parameters:
mw
- the writer for the member being documentedcd
- the classdoc to be documentedtableContents
- list of summary table contentsshowTabs
- true if the table needs to show tabs- Returns:
- the content tree for the summary table
-
getTableCaption
Deprecated.Get the summary table caption.- Parameters:
methodTypes
- set comprising of method types to show as table caption- Returns:
- the caption for the summary table
-
getMethodTypeLinks
Deprecated.Get the method type links for the table caption.- Parameters:
methodType
- the method type to be displayed as link- Returns:
- the content tree for the method type link
-
addInheritedSummaryHeader
Deprecated.Add the inherited summary header.- Parameters:
mw
- the writer for the member being documentedcd
- the classdoc to be documentedinheritedTree
- the content tree to which the inherited summary header will be added
-
addIndexComment
Deprecated.Add the index comment.- Parameters:
member
- the member being documentedcontentTree
- the content tree to which the comment will be added
-
addIndexComment
Deprecated.Add the index comment.- Parameters:
member
- the member being documentedfirstSentenceTags
- the first sentence tags for the member to be documentedtdSummary
- the content tree to which the comment will be added
-
addSummaryType
public void addSummaryType(AbstractMemberWriter mw, ProgramElementDoc member, Content tdSummaryType) Deprecated.Add the summary type for the member.- Parameters:
mw
- the writer for the member being documentedmember
- the member to be documentedtdSummaryType
- the content tree to which the type will be added
-
addSummaryLinkComment
public void addSummaryLinkComment(AbstractMemberWriter mw, ProgramElementDoc member, Content contentTree) Deprecated.Add the summary link for the member.- Parameters:
mw
- the writer for the member being documentedmember
- the member to be documentedcontentTree
- the content tree to which the link will be added
-
addSummaryLinkComment
public void addSummaryLinkComment(AbstractMemberWriter mw, ProgramElementDoc member, Tag[] firstSentenceTags, Content tdSummary) Deprecated.Add the summary link comment.- Parameters:
mw
- the writer for the member being documentedmember
- the member being documentedfirstSentenceTags
- the first sentence tags for the member to be documentedtdSummary
- the content tree to which the comment will be added
-
addInheritedMemberSummary
public void addInheritedMemberSummary(AbstractMemberWriter mw, ClassDoc cd, ProgramElementDoc member, boolean isFirst, Content linksTree) Deprecated.Add the inherited member summary.- Parameters:
mw
- the writer for the member being documentedcd
- the class being documentedmember
- the member being documentedisFirst
- true if its the first link being documentedlinksTree
- the content tree to which the summary will be added
-
getContentHeader
Deprecated.Get the document content header tree- Returns:
- a content tree the document content header
-
addClassContentTree
Deprecated.Add the class content tree.- Parameters:
contentTree
- content tree to which the class content will be addedclassContentTree
- class content tree which will be added to the content tree
-
addAnnotationContentTree
Deprecated.Add the annotation content tree.- Parameters:
contentTree
- content tree to which the annotation content will be addedannotationContentTree
- annotation content tree which will be added to the content tree
-
getMemberTreeHeader
Deprecated.Get the member header tree- Returns:
- a content tree the member header
-
addMemberTree
Deprecated.Add the member tree.- Parameters:
memberSummaryTree
- the content tree representing the member summarymemberTree
- the content tree representing the member
-
getMemberTree
Deprecated.Get the member tree- Parameters:
contentTree
- the tree used to generate the complete member tree- Returns:
- a content tree for the member
-
getMemberSummaryTree
Deprecated.Get the member summary tree- Parameters:
contentTree
- the tree used to generate the member summary tree- Returns:
- a content tree for the member summary
-
getMemberDetailsTree
Deprecated.Get the member details tree- Parameters:
contentTree
- the tree used to generate the member details tree- Returns:
- a content tree for the member details
-
getMemberTree
Deprecated.Get the member tree- Parameters:
style
- the style class to be added to the content treecontentTree
- the tree used to generate the complete member tree
-