构造函数和描述 |
---|
RenderingContext(File basedir,
String document,
String generator)
当文档不是从 Doxia 标记源呈现时的 RenderingContext 构造函数。
|
RenderingContext(File basedir,
String basedirRelativePath,
String document,
String parserId,
String extension,
boolean editable) |
RenderingContext(File basedir,
String basedirRelativePath,
String document,
String parserId,
String extension,
boolean editable,
String generator)
文档 RenderingContext 的构造函数。
|
修饰符和类型 | 方法及说明 |
---|---|
String |
getAttribute(String key)
获取属性。
|
File |
getBasedir()
吸气剂为领域
basedir 。 |
String |
getBasedirRelativePath()
获取basedir的相对路径(Doxia源时)
|
String |
getDoxiaSourcePath()
从 build root 获取 Doxia 源的相对路径。
|
String |
getDoxiaSourcePath(String base)
从给定的基本 url 获取 Doxia 源计算的 url。
|
String |
getExtension()
获取源文档文件扩展名(当 Doxia 源时)
|
String |
getGenerator()
什么是生成器(如果有)?
|
String |
getInputName()
吸气剂为领域
inputName 。 |
String |
getOutputName()
获取相对于站点根目录的 html 输出名称。
|
String |
getParserId()
当文档来自 Doxia 源时获取 parserId。
|
String |
getRelativePath()
获取站点根目录的相对路径。
|
boolean |
isDoxiaSource()
文档是从 Doxia 源渲染的吗?
|
boolean |
isEditable()
源文档是否可编辑?
|
void |
setAttribute(String key,
String value)
设置属性。
|
public RenderingContext(File basedir, String document, String generator)
当文档不是从 Doxia 标记源呈现时的 RenderingContext 构造函数。
basedir
- 伪源基本目录。document
- 伪源文档名称:将用于计算输出名称(名称相同,扩展名替换为.html
)。generator
- 生成器(通常是报告目标groupId:artifactId:version:goal
:)public RenderingContext(File basedir, String basedirRelativePath, String document, String parserId, String extension, boolean editable)
public RenderingContext(File basedir, String basedirRelativePath, String document, String parserId, String extension, boolean editable, String generator)
文档 RenderingContext 的构造函数。
basedir
- 源基目录(非空,非 Doxia 源时的伪值)。basedirRelativePath
- 来自根目录的相对路径(如果不是 Doxia 源,则为空)document
- 源文档名称。parserId
- 与此文档关联的 Doxia 模块解析器 ID,如果文档不是从 Doxia 源呈现的,则可能为空。extension
- 源文档文件扩展名,如果文档不是从 Doxia 源呈现的,则可能为空。editable
- 文档是否可作为源编辑,即未生成?generator
- 生成器(通常是报告目标groupId:artifactId:version:goal
:)public String getOutputName()
PathTool.getRelativePath(String)
public String getParserId()
null
如果不是来自 DOxia 源。public String getRelativePath()
public String getExtension()
null
如果不是 Doxia 源public boolean isEditable()
true
if 来自可编辑的 Doxia 源(未生成)。public boolean isDoxiaSource()
true
如果来自 Doxia 来源。public String getGenerator()
null
如果没有已知的生成器public String getBasedirRelativePath()
null
当 Doxia 源或者不是 Doxia 源时 basedir 的相对路径public String getDoxiaSourcePath()
null
如果不是 Doxia 源版权所有 © 2005–2022 Apache 软件基金会。版权所有。