1 /*
2 * Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package com.sun.tools.doclets.internal.toolkit.util;
27
28 /**
29 * Standard DocPath objects.
30 *
31 * <p><b>This is NOT part of any supported API.
32 * If you write code that depends on this, you do so at your own risk.
33 * This code and its internal interfaces are subject to change or
34 * deletion without notice.</b>
35 *
36 * @since 8
37 */
38 public class DocPaths {
39
40 /** The name of the file for all classes, using frames. */
41 public static final DocPath ALLCLASSES_FRAME = DocPath.create("allclasses-frame.html");
42
43 /** The name of the file for all classes, without using frames. */
44 public static final DocPath ALLCLASSES_NOFRAME = DocPath.create("allclasses-noframe.html");
45
46 /** The name of the sub-directory for storing class usage info. */
47 public static final DocPath CLASS_USE = DocPath.create("class-use");
48
49 /** The name of the file for constant values. */
50 public static final DocPath CONSTANT_VALUES = DocPath.create("constant-values.html");
51
52 /** The name of the fie for deprecated elements. */
53 public static final DocPath DEPRECATED_LIST = DocPath.create("deprecated-list.html");
54
55 /** The name of the subdirectory for user-provided additional documentation files. */
56 public static final DocPath DOC_FILES = DocPath.create("doc-files");
57
58 /** The name of the image file showing a magnifying glass on the search box. */
59 public static final DocPath GLASS_IMG = DocPath.create("glass.png");
60
61 /** The name of the file for help info. */
62 public static final DocPath HELP_DOC = DocPath.create("help-doc.html");
63
64 /** The name of the main index file. */
65 public static final DocPath INDEX = DocPath.create("index.html");
66
67 /** The name of the single index file for all classes. */
68 public static final DocPath INDEX_ALL = DocPath.create("index-all.html");
69
70 /** The name of the directory for the split index files. */
71 public static final DocPath INDEX_FILES = DocPath.create("index-files");
72
73 /** Generate the name of one of the files in the split index. */
74 public static DocPath indexN(int n) {
75 return DocPath.create("index-" + n + ".html");
76 }
77
78 /** The name of the default javascript file. */
79 public static final DocPath JAVASCRIPT = DocPath.create("script.js");
80
81 /** The name of the directory for the jQuery. */
82 public static final DocPath JQUERY_FILES = DocPath.create("jquery");
83
84 /** The name of the default jQuery stylesheet file. */
85 public static final DocPath JQUERY_STYLESHEET_FILE = DocPath.create("jquery-ui.css");
86
87 /** The name of the default jQuery javascript file. */
88 public static final DocPath JQUERY_JS_1_10 = DocPath.create("jquery-1.10.2.js");
89
90 /** The name of the default jQuery javascript file. */
91 public static final DocPath JQUERY_JS = DocPath.create("jquery-ui.js");
92
93 /** The name of the default jszip javascript file. */
94 public static final DocPath JSZIP = DocPath.create("jszip/dist/jszip.js");
95
96 /** The name of the default jszip javascript file. */
97 public static final DocPath JSZIP_MIN = DocPath.create("jszip/dist/jszip.min.js");
98
99 /** The name of the default jszip-utils javascript file. */
100 public static final DocPath JSZIPUTILS = DocPath.create("jszip-utils/dist/jszip-utils.js");
101
102 /** The name of the default jszip-utils javascript file. */
103 public static final DocPath JSZIPUTILS_MIN = DocPath.create("jszip-utils/dist/jszip-utils.min.js");
104
105 /** The name of the default jszip-utils javascript file. */
106 public static final DocPath JSZIPUTILS_IE = DocPath.create("jszip-utils/dist/jszip-utils-ie.js");
107
108 /** The name of the default jszip-utils javascript file. */
109 public static final DocPath JSZIPUTILS_IE_MIN = DocPath.create("jszip-utils/dist/jszip-utils-ie.min.js");
110
111 /** The name of the member search index file. */
112 public static final DocPath MEMBER_SEARCH_INDEX_JSON = DocPath.create("member-search-index.json");
113
114 /** The name of the member search index zip file. */
115 public static final DocPath MEMBER_SEARCH_INDEX_ZIP = DocPath.create("member-search-index.zip");
116
117 /** The name of the file for the overview frame. */
118 public static final DocPath OVERVIEW_FRAME = DocPath.create("overview-frame.html");
119
120 /** The name of the file for the overview summary. */
121 public static final DocPath OVERVIEW_SUMMARY = DocPath.create("overview-summary.html");
122
123 /** The name of the file for the overview tree. */
124 public static final DocPath OVERVIEW_TREE = DocPath.create("overview-tree.html");
125
126 /** The name of the file for the package frame. */
127 public static final DocPath PACKAGE_FRAME = DocPath.create("package-frame.html");
128
129 /** The name of the file for the package list. */
130 public static final DocPath PACKAGE_LIST = DocPath.create("package-list");
131
132 /** The name of the package search index file. */
133 public static final DocPath PACKAGE_SEARCH_INDEX_JSON = DocPath.create("package-search-index.json");
134
135 /** The name of the package search index zipfile. */
136 public static final DocPath PACKAGE_SEARCH_INDEX_ZIP = DocPath.create("package-search-index.zip");
137
138 /** The name of the file for the package summary. */
139 public static final DocPath PACKAGE_SUMMARY = DocPath.create("package-summary.html");
140
141 /** The name of the file for the package tree. */
142 public static final DocPath PACKAGE_TREE = DocPath.create("package-tree.html");
143
144 /** The name of the file for the package usage info. */
145 public static final DocPath PACKAGE_USE = DocPath.create("package-use.html");
146
147 /** The name of the file for the overview frame. */
148 public static final DocPath PROFILE_OVERVIEW_FRAME = DocPath.create("profile-overview-frame.html");
149
150 /** The name of the file for the profile frame. */
151 public static DocPath profileFrame(String profileName) {
152 return DocPath.create(profileName + "-frame.html");
153 }
154
155 /** The name of the file for the profile package frame. */
156 public static DocPath profilePackageFrame(String profileName) {
157 return DocPath.create(profileName + "-package-frame.html");
158 }
159
160 /** The name of the file for the profile package summary. */
161 public static DocPath profilePackageSummary(String profileName) {
162 return DocPath.create(profileName + "-package-summary.html");
163 }
164
165 /** The name of the file for the profile summary. */
166 public static DocPath profileSummary(String profileName) {
167 return DocPath.create(profileName + "-summary.html");
168 }
169
170 /** The name of the sub-package from which resources are read. */
171 public static final DocPath RESOURCES = DocPath.create("resources");
172
173 /** The name of the search javascript file. */
174 public static final DocPath SEARCH_JS = DocPath.create("search.js");
175
176 /** The name of the file for the serialized form info. */
177 public static final DocPath SERIALIZED_FORM = DocPath.create("serialized-form.html");
178
179 /** The name of the directory in which HTML versions of the source code
180 * are generated.
181 */
182 public static final DocPath SOURCE_OUTPUT = DocPath.create("src-html");
183
184 /** The name of the default stylesheet. */
185 public static final DocPath STYLESHEET = DocPath.create("stylesheet.css");
186
187 /** The name of the tag search index file. */
188 public static final DocPath TAG_SEARCH_INDEX_JSON = DocPath.create("tag-search-index.json");
189
190 /** The name of the tag search index zip file. */
191 public static final DocPath TAG_SEARCH_INDEX_ZIP = DocPath.create("tag-search-index.zip");
192
193 /** The name of the type search index file. */
194 public static final DocPath TYPE_SEARCH_INDEX_JSON = DocPath.create("type-search-index.json");
195
196 /** The name of the type search index zip file. */
197 public static final DocPath TYPE_SEARCH_INDEX_ZIP = DocPath.create("type-search-index.zip");
198
199 /** The name of the image file for undo button on the search box. */
200 public static final DocPath X_IMG = DocPath.create("x.png");
201
202 }