Package org.jdrupes.mdoclet.internal.doclets.toolkit.util

Klasse DocPaths

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.toolkit.util.DocPaths
public class DocPaths extends Object
Standard DocPath objects.

  • Felddetails

    • DOT_DOT

      public static final DocPath DOT_DOT

    • ALLCLASSES_INDEX

      public static final DocPath ALLCLASSES_INDEX
      The name of the file for all classes index.

    • ALLPACKAGES_INDEX

      public static final DocPath ALLPACKAGES_INDEX
      The name of the file for all packages index.

    • CLASS_USE

      public static final DocPath CLASS_USE
      The name of the sub-directory for storing class usage info.

    • CONSTANT_VALUES

      public static final DocPath CONSTANT_VALUES
      The name of the file for constant values.

    • DEPRECATED_LIST

      public static final DocPath DEPRECATED_LIST
      The name of the file for deprecated elements.

    • DOC_FILES

      public static final DocPath DOC_FILES
      The name of the subdirectory for user-provided additional documentation files.

    • ELEMENT_LIST

      public static final DocPath ELEMENT_LIST
      The name of the file for the element list.

    • EXTERNAL_SPECS

      public static final DocPath EXTERNAL_SPECS
      The name of the file for all references to external specifications.

    • GLASS_IMG

      public static final DocPath GLASS_IMG
      The name of the image file showing a magnifying glass on the search box.

    • HELP_DOC

      public static final DocPath HELP_DOC
      The name of the file for help info.

    • INDEX

      public static final DocPath INDEX
      The name of the main index file.

    • INDEX_ALL

      public static final DocPath INDEX_ALL
      The name of the single index file for all classes.

    • INDEX_FILES

      public static final DocPath INDEX_FILES
      The name of the directory for the split index files.

    • JAVASCRIPT

      public static final DocPath JAVASCRIPT
      The name of the default javascript file.

    • CLIPBOARD_SVG

      public static final DocPath CLIPBOARD_SVG
      The name of the copy-to-clipboard icon file.

    • JQUERY_JS

      public static final DocPath JQUERY_JS
      The name of the default jQuery javascript file.

    • JQUERY_UI_CSS

      public static final DocPath JQUERY_UI_CSS
      The name of the default jQuery UI stylesheet file.

    • JQUERY_UI_JS

      public static final DocPath JQUERY_UI_JS
      The name of the default jQuery UI javascript file.

    • MEMBER_SEARCH_INDEX_JS

      public static final DocPath MEMBER_SEARCH_INDEX_JS
      The name of the member search index js file.

    • MODULE_SEARCH_INDEX_JS

      public static final DocPath MODULE_SEARCH_INDEX_JS
      The name of the module search index js file.

    • NEW_LIST

      public static final DocPath NEW_LIST
      The name of the file for new elements.

    • OVERVIEW_SUMMARY

      public static final DocPath OVERVIEW_SUMMARY
      The name of the file for the overview summary.

    • OVERVIEW_TREE

      public static final DocPath OVERVIEW_TREE
      The name of the file for the overview tree.

    • PACKAGE_LIST

      public static final DocPath PACKAGE_LIST
      The name of the file for the package list.

      This is to support the legacy mode.

    • PACKAGE_SEARCH_INDEX_JS

      public static final DocPath PACKAGE_SEARCH_INDEX_JS
      The name of the package search index js file.

    • PACKAGE_SUMMARY

      public static final DocPath PACKAGE_SUMMARY
      The name of the file for the package summary.

    • PACKAGE_TREE

      public static final DocPath PACKAGE_TREE
      The name of the file for the package tree.

    • PACKAGE_USE

      public static final DocPath PACKAGE_USE
      The name of the file for the package usage info.

    • PREVIEW_LIST

      public static final DocPath PREVIEW_LIST
      The name of the file for preview elements.

    • SCRIPT_DIR

      public static final DocPath SCRIPT_DIR
      The name of the directory for the script files.

    • SEARCH_PAGE

      public static final DocPath SEARCH_PAGE
      The name of the file for search page.

    • SYSTEM_PROPERTIES

      public static final DocPath SYSTEM_PROPERTIES
      The name of the file for all system properties.

    • RESOURCES

      public static final DocPath RESOURCES
      The name of the sub-package from which resources are read.

    • SEARCH_JS

      public static final DocPath SEARCH_JS
      The name of the search javascript file.

    • SEARCH_JS_TEMPLATE

      public static final DocPath SEARCH_JS_TEMPLATE
      The name of the template for the search javascript file.

    • SEARCH_PAGE_JS

      public static final DocPath SEARCH_PAGE_JS
      The name of the search javascript file.

    • SERIALIZED_FORM

      public static final DocPath SERIALIZED_FORM
      The name of the file for the serialized form info.

    • SOURCE_OUTPUT

      public static final DocPath SOURCE_OUTPUT
      The name of the directory in which HTML versions of the source code are generated.

    • STYLESHEET

      public static final DocPath STYLESHEET
      The name of the default stylesheet.

    • TAG_SEARCH_INDEX_JS

      public static final DocPath TAG_SEARCH_INDEX_JS
      The name of the tag search index js file.

    • TYPE_SEARCH_INDEX_JS

      public static final DocPath TYPE_SEARCH_INDEX_JS
      The name of the type search index js file.

    • X_IMG

      public static final DocPath X_IMG
      The name of the image file for undo button on the search box.

  • Konstruktordetails

  • Methodendetails

    • indexN

      public static DocPath indexN(int n)
      Generate the name of one of the files in the split index.
      Parameter:
      n - the position in the index
      Gibt zurück:
      the path

    • forClass

      public DocPath forClass(TypeElement typeElement)
      Returns the path for a type element.

      For example, if the type element is java.lang.Object, the path is java/lang/Object.html.

      Parameter:
      typeElement - the type element
      Gibt zurück:
      the path

    • forName

      public DocPath forName(TypeElement typeElement)
      Returns the path for the simple name of a type element.

      For example, if the type element is java.lang.Object, the path is Object.html.

      Parameter:
      typeElement - the type element
      Gibt zurück:
      the path

    • forModule

      public static DocPath forModule(ModuleElement mdle)

    • forPackage

      public DocPath forPackage(TypeElement typeElement)
      Returns the path for the package of a type element.

      For example, if the type element is java.lang.Object, the path is java/lang.

      Parameter:
      typeElement - the type element
      Gibt zurück:
      the path

    • forPackage

      public DocPath forPackage(PackageElement pkgElement)
      Returns the path for a package.

      For example, if the package is java.lang, the path is java/lang.

      Parameter:
      pkgElement - the package element
      Gibt zurück:
      the path

    • forRoot

      public static DocPath forRoot(PackageElement pkgElement)
      Returns the inverse path for a package.

      For example, if the package is java.lang, the inverse path is ../…

      Parameter:
      pkgElement - the package element
      Gibt zurück:
      the path

    • relativePath

      public DocPath relativePath(PackageElement from, PackageElement to)
      Returns a relative path from one package to another.
      Parameter:
      from - the origin of the relative path
      to - the destination of the relative path
      Gibt zurück:
      the path

    • modulePath

      public DocPath modulePath(ModuleElement mdle, String path)
      Returns the path for a file within a module documentation output directory.
      Parameter:
      mdle - the module
      path - the path to append to the module path
      Gibt zurück:
      the module documentation path

    • moduleSummary

      public DocPath moduleSummary(ModuleElement mdle)
      The path for the file for a module’s summary page.
      Parameter:
      mdle - the module
      Gibt zurück:
      the path

    • moduleSummary

      public DocPath moduleSummary(String mdleName)
      The path for the file for a module’s summary page.
      Parameter:
      mdleName - the module
      Gibt zurück:
      the path