Package org.jdrupes.mdoclet.internal.doclets.formats.html

Klasse SubWriterHolderWriter

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

org.jdrupes.mdoclet.internal.doclets.formats.html.SubWriterHolderWriter

Bekannte direkte Unterklassen:

ClassUseWriter, ClassWriterImpl, PackageUseWriter, SerializedFormWriterImpl, SummaryListWriter

public abstract class SubWriterHolderWriter
extends HtmlDocletWriter

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.

Siehe auch:

• AbstractMemberWriter
• ClassWriterImpl

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected BodyContents	bodyContents	The HTML builder for the body contents.

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

comparators, configuration, contents, docPaths, filename, htmlIds, links, mainBodyScript, messages, options, path, pathToRoot, resources, utils, winTitle

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
SubWriterHolderWriter(HtmlConfiguration configuration, DocPath filename)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addAnnotationContent(Content source)	Add the annotation content.
void	addClassContent(Content source)	Add the class content.
protected void	addIndexComment(Element member, List<? extends DocTree> firstSentenceTags, Content tdSummaryContent)	Add the index comment.
protected void	addIndexComment(Element member, Content content)	Add the index comment.
void	addInheritedMemberSummary(AbstractMemberWriter mw, TypeElement typeElement, Element member, boolean isFirst, Content linksContent)	Add the inherited member summary.
void	addInheritedSummaryHeader(AbstractMemberWriter mw, TypeElement typeElement, Content inheritedContent)	Add the inherited summary header.
void	addSummary(HtmlStyle style, HtmlId htmlId, Content target, Content source)	Adds a section for a summary with the given CSS class and id attribute.
void	addSummaryHeader(AbstractMemberWriter mw, Content memberContent)	Add the summary header.
void	addSummaryLinkComment(Element member, List<? extends DocTree> firstSentenceTags, Content tdSummaryContent)	Add the summary link comment.
void	addSummaryLinkComment(Element member, Content content)	Add the summary link for the member.
Content	getContentHeader()	Gibt the document content header zurück.
Content	getDetailsList()	Returns a list to be used for the list of details for members of a given kind.
Content	getDetailsListItem(Content content)	Returns an item for the list of details for members of a given kind.
Content	getMember(HtmlId id, HtmlStyle style, Content source)	Get the member content
Content	getMember(Content content)	Gibt the member content zurück.
Content	getMemberDetailsContent(Content content)	Gibt the member details zurück.
Content	getMemberHeader()	Gibt the member header zurück.
Content	getMemberInherited()
Content	getMemberList()	Gibt a list to add member items to zurück.
Content	getMemberListItem(Content member)	Gibt a member item zurück.
Content	getMemberSummary(Content memberContent)	Gibt the member summary content zurück.
Content	getSummariesList()	Returns a list to be used for the list of summaries for members of a given kind.
Content	getSummariesListItem(Content content)	Returns an item for the list of summaries for members of a given kind.

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

addInlineComment, addInlineComment, addInlineDeprecatedComment, addPreQualifiedClassLink, addPreQualifiedClassLink, addPreQualifiedStrongClassLink, addPreviewComment, addPreviewInfo, addPreviewSummary, addSrcLink, addSummaryComment, addSummaryComment, addSummaryDeprecatedComment, addTagsInfo, commentTagsToContent, commentTagsToContent, commentTagsToContent, getAnnotations, getBlockTagOutput, getBlockTagOutput, getBody, getBodyStyle, getCrossClassLink, getCrossModuleLink, getCrossPackageLink, getCurrentPageElement, getDeprecatedPhrase, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getEnclosingPackageName, getFooter, getHeader, getHeader, getLink, getLocalizedPackageName, getModuleLink, getModuleLink, getNavBar, getNavLinkToOverviewTree, getPackageLabel, getPackageLink, getPackageLink, getPackageTableHeader, getPreQualifiedClassLink, getQualifiedClassLink, getTagletWriterInstance, getTagletWriterInstance, getTypeParameterLinks, getWindowTitle, hasSerializationOverviewTags, invalidTagOutput, pathString, pathString, printHtmlDocument, printHtmlDocument, printHtmlDocument, replaceDocRootDir, resolveExternalSpecURI

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

bodyContents

protected BodyContents bodyContents

The HTML builder for the body contents.

Konstruktordetails

SubWriterHolderWriter

public SubWriterHolderWriter(HtmlConfiguration configuration,
 DocPath filename)

Methodendetails

addSummaryHeader

public void addSummaryHeader(AbstractMemberWriter mw,
 Content memberContent)

Add the summary header.

Parameter:

mw - the writer for the member being documented

memberContent - the content to which the summary header will be added

addInheritedSummaryHeader

public void addInheritedSummaryHeader(AbstractMemberWriter mw,
 TypeElement typeElement,
 Content inheritedContent)

Add the inherited summary header.

Parameter:

mw - the writer for the member being documented

typeElement - the te to be documented

inheritedContent - the content to which the inherited summary header will be added

addIndexComment

protected void addIndexComment(Element member,
 Content content)

Add the index comment.

Parameter:

member - the member being documented

content - the content to which the comment will be added

addIndexComment

protected void addIndexComment(Element member,
 List<? extends DocTree> firstSentenceTags,
 Content tdSummaryContent)

Add the index comment.

Parameter:

member - the member being documented

firstSentenceTags - the first sentence tags for the member to be documented

tdSummaryContent - the content to which the comment will be added

addSummaryLinkComment

public void addSummaryLinkComment(Element member,
 Content content)

Add the summary link for the member.

Parameter:

member - the member to be documented

content - the content to which the link will be added

addSummaryLinkComment

public void addSummaryLinkComment(Element member,
 List<? extends DocTree> firstSentenceTags,
 Content tdSummaryContent)

Add the summary link comment.

Parameter:

member - the member being documented

firstSentenceTags - the first sentence tags for the member to be documented

tdSummaryContent - the content to which the comment will be added

addInheritedMemberSummary

public void addInheritedMemberSummary(AbstractMemberWriter mw,
 TypeElement typeElement,
 Element member,
 boolean isFirst,
 Content linksContent)

Add the inherited member summary.

Parameter:

mw - the writer for the member being documented

typeElement - the class being documented

member - the member being documented

isFirst - true if it is the first link being documented

linksContent - the content to which the summary will be added

getContentHeader

public Content getContentHeader()

Gibt the document content header zurück.

Gibt zurück:

the document content header

addClassContent

public void addClassContent(Content source)

Add the class content.

Parameter:

source - class content which will be added to the documentation

addAnnotationContent

public void addAnnotationContent(Content source)

Add the annotation content.

Parameter:

source - annotation content which will be added to the documentation

getMemberHeader

public Content getMemberHeader()

Gibt the member header zurück.

Gibt zurück:

the member header

getSummariesList

public Content getSummariesList()

Returns a list to be used for the list of summaries for members of a given kind.

Gibt zurück:

a list to be used for the list of summaries for members of a given kind

getSummariesListItem

public Content getSummariesListItem(Content content)

Returns an item for the list of summaries for members of a given kind.

Parameter:

content - content for the item

Gibt zurück:

an item for the list of summaries for members of a given kind

getDetailsList

public Content getDetailsList()

Returns a list to be used for the list of details for members of a given kind.

Gibt zurück:

a list to be used for the list of details for members of a given kind

getDetailsListItem

public Content getDetailsListItem(Content content)

Returns an item for the list of details for members of a given kind.

Parameter:

content - content for the item

Gibt zurück:

an item for the list of details for members of a given kind

getMemberList

public Content getMemberList()

Gibt a list to add member items to zurück.

Gibt zurück:

a list to add member items to

getMemberListItem

public Content getMemberListItem(Content member)

Gibt a member item zurück.

Parameter:

member - the member to represent as an item

Gibt zurück:

a member item

getMemberInherited

public Content getMemberInherited()

addSummary

public void addSummary(HtmlStyle style,
 HtmlId htmlId,
 Content target,
 Content source)

Adds a section for a summary with the given CSS class and id attribute.

Parameter:

style - the CSS class for the section

htmlId - the id for the section

target - the list of summary sections to which the summary will be added

source - the content representing the summary

getMember

public Content getMember(Content content)

Gibt the member content zurück.

Parameter:

content - the content used to generate the complete member

Gibt zurück:

the member content

getMemberSummary

public Content getMemberSummary(Content memberContent)

Gibt the member summary content zurück.

Parameter:

memberContent - the content used to generate the member summary

Gibt zurück:

the member summary content

getMemberDetailsContent

public Content getMemberDetailsContent(Content content)

Gibt the member details zurück.

Parameter:

content - the content used to generate the member details

Gibt zurück:

the member details

getMember

public Content getMember(HtmlId id,
 HtmlStyle style,
 Content source)

Get the member content

Parameter:

id - the id to be used for the content

style - the style class to be added to the content

source - the content used to generate the complete member content

Gibt zurück:

the member content