langtools/src/jdk.javadoc/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocPaths.java
changeset 33920 bd731341c405
parent 25874 83c19f00452c
child 36526 3b41f1c69604
equal deleted inserted replaced
33919:e9fccc09cfc6 33920:bd731341c405
     1 /*
     1 /*
     2  * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
     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.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     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
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.  Oracle designates this
     7  * published by the Free Software Foundation.  Oracle designates this
    53     public static final DocPath DEPRECATED_LIST = DocPath.create("deprecated-list.html");
    53     public static final DocPath DEPRECATED_LIST = DocPath.create("deprecated-list.html");
    54 
    54 
    55     /** The name of the subdirectory for user-provided additional documentation files. */
    55     /** The name of the subdirectory for user-provided additional documentation files. */
    56     public static final DocPath DOC_FILES = DocPath.create("doc-files");
    56     public static final DocPath DOC_FILES = DocPath.create("doc-files");
    57 
    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 
    58     /** The name of the file for help info. */
    61     /** The name of the file for help info. */
    59     public static final DocPath HELP_DOC = DocPath.create("help-doc.html");
    62     public static final DocPath HELP_DOC = DocPath.create("help-doc.html");
    60 
    63 
    61     /** The name of the main index file. */
    64     /** The name of the main index file. */
    62     public static final DocPath INDEX = DocPath.create("index.html");
    65     public static final DocPath INDEX = DocPath.create("index.html");
    73     }
    76     }
    74 
    77 
    75     /** The name of the default javascript file. */
    78     /** The name of the default javascript file. */
    76     public static final DocPath JAVASCRIPT = DocPath.create("script.js");
    79     public static final DocPath JAVASCRIPT = DocPath.create("script.js");
    77 
    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 
    78     /** The name of the file for the overview frame. */
   117     /** The name of the file for the overview frame. */
    79     public static final DocPath OVERVIEW_FRAME = DocPath.create("overview-frame.html");
   118     public static final DocPath OVERVIEW_FRAME = DocPath.create("overview-frame.html");
    80 
   119 
    81     /** The name of the file for the overview summary. */
   120     /** The name of the file for the overview summary. */
    82     public static final DocPath OVERVIEW_SUMMARY = DocPath.create("overview-summary.html");
   121     public static final DocPath OVERVIEW_SUMMARY = DocPath.create("overview-summary.html");
    84     /** The name of the file for the overview tree. */
   123     /** The name of the file for the overview tree. */
    85     public static final DocPath OVERVIEW_TREE = DocPath.create("overview-tree.html");
   124     public static final DocPath OVERVIEW_TREE = DocPath.create("overview-tree.html");
    86 
   125 
    87     /** The name of the file for the package frame. */
   126     /** The name of the file for the package frame. */
    88     public static final DocPath PACKAGE_FRAME = DocPath.create("package-frame.html");
   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");
    89 
   149 
    90     /** The name of the file for the profile frame. */
   150     /** The name of the file for the profile frame. */
    91      public static DocPath profileFrame(String profileName) {
   151      public static DocPath profileFrame(String profileName) {
    92         return DocPath.create(profileName + "-frame.html");
   152         return DocPath.create(profileName + "-frame.html");
    93     }
   153     }
   105     /** The name of the file for the profile summary. */
   165     /** The name of the file for the profile summary. */
   106      public static DocPath profileSummary(String profileName) {
   166      public static DocPath profileSummary(String profileName) {
   107         return DocPath.create(profileName + "-summary.html");
   167         return DocPath.create(profileName + "-summary.html");
   108     }
   168     }
   109 
   169 
   110     /** The name of the file for the package list. */
       
   111     public static final DocPath PACKAGE_LIST = DocPath.create("package-list");
       
   112 
       
   113     /** The name of the file for the package summary. */
       
   114     public static final DocPath PACKAGE_SUMMARY = DocPath.create("package-summary.html");
       
   115 
       
   116     /** The name of the file for the package tree. */
       
   117     public static final DocPath PACKAGE_TREE = DocPath.create("package-tree.html");
       
   118 
       
   119     /** The name of the file for the package usage info. */
       
   120     public static final DocPath PACKAGE_USE = DocPath.create("package-use.html");
       
   121 
       
   122     /** The name of the file for the overview frame. */
       
   123     public static final DocPath PROFILE_OVERVIEW_FRAME = DocPath.create("profile-overview-frame.html");
       
   124 
       
   125     /** The name of the sub-package from which resources are read. */
   170     /** The name of the sub-package from which resources are read. */
   126     public static final DocPath RESOURCES = DocPath.create("resources");
   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");
   127 
   175 
   128     /** The name of the file for the serialized form info. */
   176     /** The name of the file for the serialized form info. */
   129     public static final DocPath SERIALIZED_FORM = DocPath.create("serialized-form.html");
   177     public static final DocPath SERIALIZED_FORM = DocPath.create("serialized-form.html");
   130 
   178 
   131     /** The name of the directory in which HTML versions of the source code
   179     /** The name of the directory in which HTML versions of the source code
   134     public static final DocPath SOURCE_OUTPUT = DocPath.create("src-html");
   182     public static final DocPath SOURCE_OUTPUT = DocPath.create("src-html");
   135 
   183 
   136     /** The name of the default stylesheet. */
   184     /** The name of the default stylesheet. */
   137     public static final DocPath STYLESHEET = DocPath.create("stylesheet.css");
   185     public static final DocPath STYLESHEET = DocPath.create("stylesheet.css");
   138 
   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 
   139 }
   202 }