124 * @param description the content for the description META tag
125 * @throws DocFileIOException if there is a problem building the package index file
126 */
127 protected void buildOverviewIndexFile(String title, String description)
128 throws DocFileIOException {
129 String windowOverview = resources.getText(title);
130 Content body = getBody(getWindowTitle(windowOverview));
131 Content header = new ContentBuilder();
132 addNavigationBarHeader(header);
133 Content main = new ContentBuilder();
134 addOverviewHeader(main);
135 addIndex(main);
136 Content footer = HtmlTree.FOOTER();
137 addNavigationBarFooter(footer);
138 body.add(new BodyContents()
139 .setHeader(header)
140 .addMainContent(main)
141 .setFooter(footer)
142 .toContent());
143 printHtmlDocument(
144 configuration.metakeywords.getOverviewMetaKeywords(title, configuration.doctitle),
145 description, body);
146 }
147
148 /**
149 * Adds the index to the documentation tree.
150 *
151 * @param main the document tree to which the packages/modules list will be added
152 */
153 protected abstract void addIndex(Content main);
154
155 /**
156 * Adds the doctitle to the documentation tree, if it is specified on the command line.
157 *
158 * @param body the document tree to which the title will be added
159 */
160 protected void addConfigurationTitle(Content body) {
161 if (configuration.doctitle.length() > 0) {
162 Content title = new RawHtml(configuration.doctitle);
163 Content heading = HtmlTree.HEADING(Headings.PAGE_TITLE_HEADING,
164 HtmlStyle.title, title);
165 Content div = HtmlTree.DIV(HtmlStyle.header, heading);
166 body.add(div);
167 }
168 }
169 }
|
124 * @param description the content for the description META tag
125 * @throws DocFileIOException if there is a problem building the package index file
126 */
127 protected void buildOverviewIndexFile(String title, String description)
128 throws DocFileIOException {
129 String windowOverview = resources.getText(title);
130 Content body = getBody(getWindowTitle(windowOverview));
131 Content header = new ContentBuilder();
132 addNavigationBarHeader(header);
133 Content main = new ContentBuilder();
134 addOverviewHeader(main);
135 addIndex(main);
136 Content footer = HtmlTree.FOOTER();
137 addNavigationBarFooter(footer);
138 body.add(new BodyContents()
139 .setHeader(header)
140 .addMainContent(main)
141 .setFooter(footer)
142 .toContent());
143 printHtmlDocument(
144 configuration.metakeywords.getOverviewMetaKeywords(title, configuration.getOptions().docTitle),
145 description, body);
146 }
147
148 /**
149 * Adds the index to the documentation tree.
150 *
151 * @param main the document tree to which the packages/modules list will be added
152 */
153 protected abstract void addIndex(Content main);
154
155 /**
156 * Adds the doctitle to the documentation tree, if it is specified on the command line.
157 *
158 * @param body the document tree to which the title will be added
159 */
160 protected void addConfigurationTitle(Content body) {
161 String doctitle = configuration.getOptions().docTitle;
162 if (doctitle.length() > 0) {
163 Content title = new RawHtml(doctitle);
164 Content heading = HtmlTree.HEADING(Headings.PAGE_TITLE_HEADING,
165 HtmlStyle.title, title);
166 Content div = HtmlTree.DIV(HtmlStyle.header, heading);
167 body.add(div);
168 }
169 }
170 }
|