Package docsite

Class SectionEmitter

java.lang.Object

docsite.SectionEmitter

Direct Known Subclasses:

CopySectionEmitter, EmbeddedSiteSectionEmitter, GeneratedSectionEmitter, GroupSectionEmitter, LinkSectionEmitter

public abstract class SectionEmitter
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<SectionEmitter>	ancestorEmitters
protected final List<SiteLanguage>	availableLanguages
protected final Path	baseDir
protected final List<SectionEmitter>	childEmitters
protected final ImageResolver	globalImages
protected static final String	INDEX_FILE
protected final Map<String,String>	localization
protected static final Logger	logger
protected final Map<String,String>	metadata
protected final Path	outputFolder
protected final SectionEmitter	rootEmitter
protected final List<Script>	scripts
protected final Section	section
protected final ImageResolver	sectionImages
protected final Docsite	site
protected final SiteLanguage	siteLanguage
protected final ThemeColors	themeColors
protected static final int	TOC_MAX_LEVEL
protected static final int	TOC_MIN_LEVEL
protected final boolean	useCDN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SectionEmitter(EmitterBuildParams params)

Method Summary

Modifier and Type	Method	Description
j2html.tags.specialized.NavTag	createBreadcrumbs()
abstract j2html.tags.specialized.ATag	createLinkToSection(boolean withIcon)
protected abstract j2html.tags.specialized.SectionTag	createSectionContent()
protected abstract j2html.tags.specialized.AsideTag	createTableOfContents(j2html.tags.specialized.SectionTag section)
void	emitHTML()
void	emitHTML(boolean includeFooter)
String	href()
protected String	origin()
protected Path	outputPath()
protected String	translate(String value)
protected abstract String	url()
protected abstract String	url(SiteLanguage language)

Methods inherited from class java.lang.Object

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

Field Details

TOC_MIN_LEVEL

protected static final int TOC_MIN_LEVEL

See Also:

• Constant Field Values

TOC_MAX_LEVEL

protected static final int TOC_MAX_LEVEL

See Also:

• Constant Field Values

INDEX_FILE

protected static final String INDEX_FILE

See Also:

• Constant Field Values

logger

protected static final Logger logger

site

protected final Docsite site

section

protected final Section section

sectionImages

protected final ImageResolver sectionImages

globalImages

protected final ImageResolver globalImages

useCDN

protected final boolean useCDN

rootEmitter

protected final SectionEmitter rootEmitter

ancestorEmitters

protected final List<SectionEmitter> ancestorEmitters

childEmitters

protected final List<SectionEmitter> childEmitters

themeColors

protected final ThemeColors themeColors

outputFolder

protected final Path outputFolder

baseDir

protected final Path baseDir

metadata

protected final Map<String,String> metadata

scripts

protected final List<Script> scripts

availableLanguages

protected final List<SiteLanguage> availableLanguages

siteLanguage

protected final SiteLanguage siteLanguage

localization

protected final Map<String,String> localization

Constructor Details

SectionEmitter

protected SectionEmitter(EmitterBuildParams params)

Method Details

url

protected abstract String url()

url

protected abstract String url(SiteLanguage language)

createLinkToSection

public abstract j2html.tags.specialized.ATag createLinkToSection(boolean withIcon)

createSectionContent

protected abstract j2html.tags.specialized.SectionTag createSectionContent()

createTableOfContents

protected abstract j2html.tags.specialized.AsideTag createTableOfContents(j2html.tags.specialized.SectionTag section)

href

public String href()

outputPath

protected Path outputPath()

origin

protected String origin()

emitHTML

public void emitHTML()
              throws IOException

Throws:

IOException

emitHTML

public void emitHTML(boolean includeFooter)
              throws IOException

Throws:

IOException

createBreadcrumbs

public j2html.tags.specialized.NavTag createBreadcrumbs()

translate

protected String translate(String value)