DocConvertSettings (文档转换工具包 0.0.3-SNAPSHOT API)

java.lang.Object
- com.kdgcsoft.power.doc.convert.DocConvertSettings

public class DocConvertSettings
extends Object

字段概要

字段
限定符和类型	字段和说明
`static int`	`CONVERT_TASK_TIMEOUT_MINUTES` 转换任务的超时时间，单位：分钟
`static String`	`PAGED_FILE_DIR_SUFFIX` 储存分页文件的子目录后缀。
`static String`	`SUFFIX_LOCK` 标志一个任务正在进行的锁文件扩展名
`static String`	`TASK_FILE_EXT` 记录转换任务信息的临时文件的扩展名。

构造器概要

构造器
构造器和说明

DocConvertSettings()

构造器
构造器和说明
`DocConvertSettings()`

方法概要

方法
限定符和类型	方法和说明
`ConvertEngineType`	`getConvertEngine()` 获取当前的基础转换引擎。
`String`	`getExcel2HtmlJQueryPath()` 设置Excel2Html之后在Html中使用的JQuery。
`com.kdgcsoft.power.excel2html.HtmlTemplate`	`getExcel2HtmlTemplate()` 当前Excel2Html输出的Html模板对象。
`String`	`getExcel2HtmlTemplateStr()` 当前Excel2Html输出的Html模板字符串。
`File`	`getIncomingDir()` 获取工作目录下用于存储临时文件的目录。
`int`	`getMaxConvertThread()` 获取最大并发转换数
`String`	`getOpenOfficePath()` 获得当前设置的LibreOffice/OpenOffice的安装目录。
`int[]`	`getOpenOfficePorts()` 获取所设置的OpenOffice/LibreOffice监听端口。
`String`	`getPdf2HtmlExePath()` 获取PDF2HtmlEx可执行程序的全路径，包含文件名。
`File`	`getStorageDir()` 获取工作目录下用于存储转换后文件的根目录
`StorageType`	`getStorageType()` 获取存储目录结构组织方式
`File`	`getWorkdir()` 获取文档转换工作目录
`boolean`	`isAlsoStorageOriginalFile()` 返回当前是否在转换后的文档存储库中保存源文件的开关状态。
`boolean`	`isExcel2HtmlHideTabIfOnlyOne()` Excel2Html转换时，如果只有一个Sheet，则是否隐藏该Sheet的Tab标签。
`boolean`	`isExcel2HtmlShowHeaders()` Excel2Html转换时是否显示行列坐标。
`boolean`	`isExcel2htmlShowHiddenContent()` Excel2Html转换时是否在HTML中隐藏Excel中隐藏的行列。
`boolean`	`isTestMode()` 设置为测试模式。
`void`	`setAlsoStorageOriginalFile(boolean alsoStorageOriginalFile)` 设置是否在转换后的文档存储库中保存源文件。
`void`	`setConvertEngine(ConvertEngineType convertEngine)` 设置基础转换引擎。
`void`	`setExcel2HtmlHideTabIfOnlyOne(boolean excel2html_hideTabIfOnlyOne)` Excel2Html转换时，如果只有一个Sheet，则是否隐藏该Sheet的Tab标签。
`void`	`setExcel2HtmlJQueryPath(String excel2html_jqueryPath)` 设置Excel2Html之后在Html中使用的JQuery。
`void`	`setExcel2HtmlShowHeaders(boolean excel2html_showHeaders)` Excel2Html转换时是否显示行列坐标。
`void`	`setExcel2HtmlShowHiddenContent(boolean excel2html_showHiddenContent)` Excel2Html转换时是否在HTML中隐藏Excel中的隐藏内容。
`void`	`setExcel2HtmlTemplateStr(String excel2html_htmlTemplate)` 定制Excel2Html输出的Html模板字符串。
`void`	`setMaxConvertThread(int threadNumber)` 设置最大并发转换数。
`void`	`setOpenOfficePath(String path)` 当使用OpenOffice/LibreOffice作为缺省转换引擎时，如果没有安装在默认路径下，则需要指定安装路径。
`void`	`setOpenOfficePorts(int[] listenPorts)` 当使用OpenOffice/LibreOffice作为缺省转换引擎时，可以指定其默认的监听端口（用于支持并发）。
`void`	`setPdf2HtmlExePath(String path)` 当希望使用PDF2HtmlEx作为PDF转HTML引擎时，需要指定PDF2HtmlEx可执行文件的位置，例如："C:\\pdf2htmlEx\\pdf2htmlEX.exe"。
`void`	`setStorageType(StorageType storType)` 设置存储目录结构组织方式。
`void`	`setTestMode(boolean isTestMode)` 设置为测试模式。
`void`	`setWorkdir(File dir)` 设置文档转换的工作目录

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - SUFFIX_LOCK
```
public static final String SUFFIX_LOCK
```
    标志一个任务正在进行的锁文件扩展名
    
    另请参阅:
    常量字段值
  - TASK_FILE_EXT
```
public static final String TASK_FILE_EXT
```
    记录转换任务信息的临时文件的扩展名。
    例：当存在一个doc转pdf的任务时，会生成一个空的临时文件：[key].doc.pdf.task，文件名包含了任务的信息。任务成功完成后，该文件会被自动删除。
    
    另请参阅:
    常量字段值
  - PAGED_FILE_DIR_SUFFIX
```
public static final String PAGED_FILE_DIR_SUFFIX
```
    储存分页文件的子目录后缀。最终为：[key].[OutputType].dir。例: 201804101949360001.png.dir
    
    另请参阅:
    常量字段值
  - CONVERT_TASK_TIMEOUT_MINUTES
```
public static final int CONVERT_TASK_TIMEOUT_MINUTES
```
    转换任务的超时时间，单位：分钟
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - DocConvertSettings
```
public DocConvertSettings()
```
- 方法详细资料
  - getWorkdir
```
public File getWorkdir()
```
    获取文档转换工作目录
    
    返回:
    工作目录
  - setWorkdir
```
public void setWorkdir(File dir)
                throws IOException
```
    设置文档转换的工作目录
    
    参数:
    dir - 工作目录
    
    抛出:
    
    IOException
  - getIncomingDir
```
public File getIncomingDir()
```
    获取工作目录下用于存储临时文件的目录。该目录用于暂时存放转换源文件、转换任务记录、任务锁
    
    返回:
    临时目录
  - getStorageDir
```
public File getStorageDir()
```
    获取工作目录下用于存储转换后文件的根目录
    
    返回:
    存储转换后文件的根目录
  - getMaxConvertThread
```
public int getMaxConvertThread()
```
    获取最大并发转换数
    
    返回:
    最大并发转换数
  - setMaxConvertThread
```
public void setMaxConvertThread(int threadNumber)
```
    设置最大并发转换数。默认为5。
    
    参数:
    threadNumber - 最大并发数
  - getConvertEngine
```
public ConvertEngineType getConvertEngine()
```
    获取当前的基础转换引擎。
    
    返回:
    当前转换引擎
  - setConvertEngine
```
public void setConvertEngine(ConvertEngineType convertEngine)
```
    设置基础转换引擎。默认为jacob
    
    参数:
    convertEngine -
  - getStorageType
```
public StorageType getStorageType()
```
    获取存储目录结构组织方式
    
    返回:
    录结构组织方式
  - setStorageType
```
public void setStorageType(StorageType storType)
```
    设置存储目录结构组织方式。默认为按时间戳组织目录结构
    
    参数:
    storType -
  - getOpenOfficePath
```
public String getOpenOfficePath()
```
    获得当前设置的LibreOffice/OpenOffice的安装目录。如果未设置，则返回null，转换器将使用默认路径查找LibreOffice/OpenOffice。
    
    返回:
    LibreOffice/OpenOffice安装路径
  - setOpenOfficePath
```
public void setOpenOfficePath(String path)
```
    当使用OpenOffice/LibreOffice作为缺省转换引擎时，如果没有安装在默认路径下，则需要指定安装路径。如果安装在默认路径下，不需要调用本函数。
    
    参数:
    path - OpenOffice/LibreOffice的安装目录
  - getOpenOfficePorts
```
public int[] getOpenOfficePorts()
```
    获取所设置的OpenOffice/LibreOffice监听端口。默认为45111和45112。
    
    返回:
    监听端口数组
  - setOpenOfficePorts
```
public void setOpenOfficePorts(int[] listenPorts)
```
    当使用OpenOffice/LibreOffice作为缺省转换引擎时，可以指定其默认的监听端口（用于支持并发）。不设置的话，默认端口只有2个，端口号为45111和45112。并发时可能会因为等待端口连接超时而导致转换任务失败。根据测试，在Windows中每启用一个端口大约占据50M操作系统内存（不是JVM内存！）注意：请确保端口没有被其他程序占用。如果被占用，会引起运行错误。
    
    参数:
    listenPorts - 监听的端口号数组
  - getPdf2HtmlExePath
```
public String getPdf2HtmlExePath()
```
    获取PDF2HtmlEx可执行程序的全路径，包含文件名。
    
    返回:
    可执行文件的路径
  - setPdf2HtmlExePath
```
public void setPdf2HtmlExePath(String path)
```
    当希望使用PDF2HtmlEx作为PDF转HTML引擎时，需要指定PDF2HtmlEx可执行文件的位置，例如："C:\\pdf2htmlEx\\pdf2htmlEX.exe"。
    如果没有设置这个路径，转换器将使用缺省转换引擎尝试转换PDF为HTML（有可能不支持从而报错）。默认路径为：D:\\pdf2htmlEX\\pdf2htmlEX.exe
    
    参数:
    path - PDF2HtmlEx可执行文件的路径
  - isExcel2HtmlShowHeaders
```
public boolean isExcel2HtmlShowHeaders()
```
    Excel2Html转换时是否显示行列坐标。默认为不显示。
    
    返回:
    是否显示行列坐标
  - setExcel2HtmlShowHeaders
```
public void setExcel2HtmlShowHeaders(boolean excel2html_showHeaders)
```
    Excel2Html转换时是否显示行列坐标。默认为不显示
    
    参数:
    excel2html_showHeaders - 是否显示行列坐标
  - isExcel2htmlShowHiddenContent
```
public boolean isExcel2htmlShowHiddenContent()
```
    Excel2Html转换时是否在HTML中隐藏Excel中隐藏的行列。默认为隐藏
    
    返回:
    是否在HTML中隐藏Excel中隐藏的行列
  - setExcel2HtmlShowHiddenContent
```
public void setExcel2HtmlShowHiddenContent(boolean excel2html_showHiddenContent)
```
    Excel2Html转换时是否在HTML中隐藏Excel中的隐藏内容。默认为隐藏。
    
    参数:
    excel2html_showHiddenContent -
    另请参阅:
    Excel2Html.setShowHiddenContent(boolean)
  - isExcel2HtmlHideTabIfOnlyOne
```
public boolean isExcel2HtmlHideTabIfOnlyOne()
```
    Excel2Html转换时，如果只有一个Sheet，则是否隐藏该Sheet的Tab标签。默认为不隐藏，即总是显示Tab。
    
    返回:
    是否隐藏唯一Sheet的Tab标签
  - setExcel2HtmlHideTabIfOnlyOne
```
public void setExcel2HtmlHideTabIfOnlyOne(boolean excel2html_hideTabIfOnlyOne)
```
    Excel2Html转换时，如果只有一个Sheet，则是否隐藏该Sheet的Tab标签。默认为不隐藏，即总是显示Tab。
    
    参数:
    excel2html_hideTabIfOnlyOne - 是否隐藏唯一Sheet的Tab标签
    另请参阅:
    Excel2Html.setHideSheetTabIfOnlyOne(boolean)
  - getExcel2HtmlJQueryPath
```
public String getExcel2HtmlJQueryPath()
```
    设置Excel2Html之后在Html中使用的JQuery。默认为百度镜像路径：http://apps.bdimg.com/libs/jquery/1.9.1/jquery.min.js。
    路径将出现在HTML中的<script src="../jquery.min.js"></script>中，可以使用相对路径。
    
    返回:
    当前使用的JQuery路径
  - setExcel2HtmlJQueryPath
```
public void setExcel2HtmlJQueryPath(String excel2html_jqueryPath)
```
    设置Excel2Html之后在Html中使用的JQuery。不设置或设置为null都将使用百度镜像路径：http://apps.bdimg.com/libs/jquery/1.9.1/jquery.min.js。
    路径会出现在HTML中的<script src="../jquery.min.js"></script>中，可以使用相对路径。
    
    参数:
    excel2html_jqueryPath - JQuery路径
    另请参阅:
    Excel2Html.setJqueryPath(String)
  - getExcel2HtmlTemplateStr
```
public String getExcel2HtmlTemplateStr()
```
    当前Excel2Html输出的Html模板字符串。如果没有设置，则返回null。此时Excel2Html会使用自带模板。
    
    返回:
    当前设置的Html模板字符串
  - setExcel2HtmlTemplateStr
```
public void setExcel2HtmlTemplateStr(String excel2html_htmlTemplate)
```
    定制Excel2Html输出的Html模板字符串。一般情况下Excel2Html自带模板就可以了。
    
    参数:
    excel2html_htmlTemplate - 自定义Html模板。
    另请参阅:
    Excel2Html.setHtmlTemplateString(String)
  - getExcel2HtmlTemplate
```
public com.kdgcsoft.power.excel2html.HtmlTemplate getExcel2HtmlTemplate()
```
    当前Excel2Html输出的Html模板对象。如果没有设置，则返回null。此时Excel2Html会使用自带模板。
    
    返回:
    Html模板对象
  - isAlsoStorageOriginalFile
```
public boolean isAlsoStorageOriginalFile()
```
    返回当前是否在转换后的文档存储库中保存源文件的开关状态。缺省为true。
    
    返回:
    true：保存源文件, false：不保存
  - setAlsoStorageOriginalFile
```
public void setAlsoStorageOriginalFile(boolean alsoStorageOriginalFile)
```
    设置是否在转换后的文档存储库中保存源文件。缺省为true。
    
    参数:
    alsoStorageOriginalFile - 是否保存源文件，true：保存，false：不保存
  - isTestMode
```
public boolean isTestMode()
```
    设置为测试模式。此模式下将无视设置的转换引擎，总是使用虚拟转换器DummyConverter 进行转换。
    
    返回:
    是否为测试模式。true:测试模式, false:非测试模式。默认是非测试模式。
  - setTestMode
```
public void setTestMode(boolean isTestMode)
```
    设置为测试模式。此模式下将无视设置的转换引擎，总是使用虚拟转换器DummyConverter 进行转换。
    默认为非测试模式。

类 DocConvertSettings

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

SUFFIX_LOCK

TASK_FILE_EXT

PAGED_FILE_DIR_SUFFIX

CONVERT_TASK_TIMEOUT_MINUTES

构造器详细资料

DocConvertSettings

方法详细资料

getWorkdir

setWorkdir

getIncomingDir

getStorageDir

getMaxConvertThread

setMaxConvertThread

getConvertEngine

setConvertEngine

getStorageType

setStorageType

getOpenOfficePath

setOpenOfficePath

getOpenOfficePorts

setOpenOfficePorts

getPdf2HtmlExePath

setPdf2HtmlExePath

isExcel2HtmlShowHeaders

setExcel2HtmlShowHeaders

isExcel2htmlShowHiddenContent

setExcel2HtmlShowHiddenContent

isExcel2HtmlHideTabIfOnlyOne

setExcel2HtmlHideTabIfOnlyOne

getExcel2HtmlJQueryPath

setExcel2HtmlJQueryPath

getExcel2HtmlTemplateStr

setExcel2HtmlTemplateStr

getExcel2HtmlTemplate

isAlsoStorageOriginalFile

setAlsoStorageOriginalFile

isTestMode

setTestMode