Docx to HTML Converter of OSDC V10.0 - Javaインターフェイス

本インターフェイスは、Docx to HTML Converter of OSDC V10.0 をJavaから利用するインターフェイスを提供します。 Java 11以降で動作します。 Java VM についてを参照してください。

JavaインターフェイスはJNI（JavaNativeInterface）を使用して作られています。

ライブラリファイル

以下のライブラリファイルが [Install directory] または [Install directory]/lib に含まれています。

ライブラリファイル	内容	場所
SbhJavaCtl.jar	Javaアーカイブ	[Install directory]/lib
SbhJavaCtl100.dll	Windows用 Javaインターフェイス	[Install directory]
libSbhJavaCtl100.so	Linux 用 Javaインターフェイス	[Install directory]/lib

Javaインターフェイスを実行するには、Javaを実行するディレクトリと[Install directory]/lib/SbhJavaCtl.jar が環境変数 CLASSPATH に含まれていなければなりません。また、JNI（JavaNativeInterface）を使用していることからWindows版では [Install directory] が環境変数 PATH に含まれていなければなりません。非Windowsの環境では[Install directory]/libが Linux版では環境変数 LD_LIBRARY_PATH に含まれていなければなりません。必要な環境変数については、環境変数とシンボリックリンクを参照してください。

Windows版の場合。

> set CLASSPATH=[Install directory]/lib/SbhJavaCtl.jar;%CLASSPATH% > set PATH=[Install directory];%PATH%

Linux版の場合。

$ CLASSPATH=[Install directory]/lib/SbhJavaCtl.jar:${CLASSPATH} $ export CLASSPATH $ LD_LIBRARY_PATH=[Install directory]/lib:${LD_LIBRARY_PATH} $ export LD_LIBRARY_PATH

Java VM について

Docx to HTML Converter of OSDC V10.0 の Javaインターフェイスは、Eclipse Temurin JDK (旧AdoptOpenJDK) 11 を使ってビルドされています。Linux環境において古いバージョンのJava実行環境を使用する場合、互換性の問題が発生することがあります。Java 11未満のJava実行環境はサポートしておりません。

アプリケーションサーバにおける使用について

Tomcatなどのアプリケーションサーバにおいて本インターフェイスを使用する場合、SbhJavaCtl.jarをウェブアプリケーションのWEB-INF/libに置かないようにしてください。
JavaVMの仕様によりJNIのネイティブライブラリは複数のクラスローダから読み込めないようになっているため、各ウェブアプリケーションディレクトリにSbhJavaCtl.jarを置くと複数のウェブアプリケーションから使用することができなくなります。これを防ぐにはシステムクラスローダなどロードが一度だけ行われるクラスローダで読み込ませるように設定してください。

クラス

Java インターフェイスには以下のクラスが含まれます。

名前	機能
SbhObj	Docx to HTML Converter of OSDC V10.0 本体のクラスです。SbhObj import jp.co.antenna.SbhJavaCtl.*; SbhObj obj; try { obj = new SbhObj(); // 何かの処理 }catch(Exception e) { System.out.println(e.getMessage()); }

メソッド

SbhObjクラスの提供するメソッドは次のとおりです。

名前	戻り値	引数	機能
execute	なし	なし	変換を実行し、setDocumentURIで指定された出力先に出力します。
setDocumentURI	なし	newVal : java.lang.String	入力ファイル名を指定します。
setOutputFilePath	なし	newVal : java.lang.String	出力ファイル名を指定します。
clrSettings	なし	なし	オプション設定をクリアします。
lodeSettings	なし	newVal : java.lang.String	指定した変換オプション設定ファイルを読み込みます。
setEnableXHTML	なし	newVal : boolean	タグ出力の文法を指定します。 newValtrueの場合XML文法、falseの場合HTML文法を指定します。
setViewportContent	なし	content : java.lang.String	<head>に次の形式のメタタグを出力するように指定します。 <meta name="viewport" content="contentに指定した内容">
setEnableENDL	なし	newVal : boolean	ブロックタグの終わりに改行を出力するかどうかを指定します。 newValtrueの場合は出力します、falseの場合は出力しません。
setEnableEmptyParagraph	なし	newVal : boolean	Wordの空の行（改行のみの行）の扱いを指定します。 newValtrueの場合空行を無視します、falseの場合、空行の数だけ空の<p>タグを出力します。
setEnableNonRefId	なし	newVal : boolean	Wordでは編集を重ねると文書ファイル内に参照されていないIDがdocxファイル内に沢山できてしまいます。これらの内部的に参照されていないIDをHTML出力時に削除するかどうかを指定します。 newValtrueの場合は削除しません、falseの場合は削除します。
setEnableImgWidth	なし	newVal : boolean	イメージの幅を出力するかどうかを指定します。 newValtrueの場合は出力します、falseの場合は出力しません。
setEnableHeadingStrong	なし	newVal : boolean	見出しスタイルで指定された強調を無視するどうかを指定します。 newValtrueの場合は無視します、falseの場合は出力します。
setEnableEmbedimage	なし	newVal : boolean	画像をデータURLで本体HTMLに埋め込むかどうかを指定します。 newValtrueの場合埋め込みます、falseの場合は画像はimageフォルダーに出力されます。
setEnableMathML	なし	newVal : boolean	Wordの数式エディタで編集した数式を<img>タグにMathML形式ファイルで出力するかどうかを指定します。 newValtrueの場合は出力します、falseの場合は出力しません。
setXmlMathML	なし	newVal : boolean	Wordの数式エディタで編集した数式をMathML形式マークアップで出力するかどうかを指定します。 newValtrueの場合は出力します、falseの場合は出力しません。
setOMath	なし	newVal : boolean	Wordの数式エディタで編集した数式をWord独自のOffice Math形式で出力するかどうかを指定します。 newValtrueの場合は出力します、falseの場合は出力しません。
setThroughImage	なし	newVal : boolean	Wordに挿入した元の画像形式のまま出力するかどうかを指定します。 newValtrueの場合は出力します、falseの場合は出力しません。
setEnablePStyle	なし	newVal : boolean	段落のスタイル名をclass属性の値として出力するか指定します。 newValtrueの場合は出力します、falseの場合は出力しません。
setEnableCitation	なし	newVal : boolean	Citationフィールドのtagの値を<a>タグのhref属性の値に設定して出力するかを指定します。 newValtrueの場合は出力します、falseの場合は出力しません。
setTextColor	なし	newVal : boolean	文字に指定されている色を<span style="color:カラー値">として出力するかどうかを指定します。 newValtrueの場合は出力します、falseの場合は出力しません。
setItalic	なし	newVal : int	文字に斜体が指定されているときの出力方法を指定します。 newVal斜体の出力方法 0 : 出力しない（デフォルト） 1 : <i>タグとして出力 2 : <span style="font-style:italic">として出力
setUnderline	なし	newVal : int	文字に下線が指定されているときの出力方法を指定します。 newVal下線の出力方法 0 : 出力しない（デフォルト） 1 : <u>タグとして出力 2 : <span style=""text-decoration-line:underline;">として出力
setLinethrough	なし	newVal : int	文字に取り消し線が指定されているときの出力方法を指定します。 newVal取り消し線の出力方法 0 : 出力しない（デフォルト） 1 : <del>タグとして出力 2 : <span style=""text-decoration-line: line-through;">として出力
setEncoding	なし	newVal : java.lang.String	HTMLファイルの文字コード（符号化方式）を指定します。(デフォルト : "UTF-8")
setDefstyle	なし	newVal : boolean	<head>の<style>要素（デフォルトCSSスタイルを指定する要素）を出力するかどうかを指定します。 newValtrueの場合は出力しません、falseの場合は出力します。
setSpaceIndent	なし	newVal : boolean	段落先頭に1文字以上の字下げが指定されているとき、字下げを1文字の全角空白に変換するかどうかを指定します。 newValtrueの場合は変換します、falseの場合は変換しません。
setOutputBR	なし	newVal : boolean	段落を<p>タグで囲む代わりに、段落の終わりに<br>タグを出力するかどうかを指定します。タグ出力でXML文法指定時は無効です。 newValtrueの場合は<br>タグを出力します、falseの場合は<p>タグを出力します。
setFileimages	なし	newVal : boolean	画像ファイルを格納するフォルダー名の付け方を指定します。 newValtrueの場合は"変換先ファイル名.images"、falseの場合は"image"とします。
setCSS	なし	uri : java.lang.String media : java.lang.String	リンクするCSSファイルを指定します。 uriCSSファイルのパスを指定します。 mediaオプションでmediaを指定できます。
setJS	なし	newVal : java.lang.String	<head>にscript タグを置き、そのsrc属性にJavaScriptファイルのパス（URL）を指定します。 newValJavaScriptファイルのパスを指定します。
saveSettings	なし	newVal : java.lang.String	オプション設定ファイルのパスを指定します。
setTablestyle	なし	newVal : boolean	テーブルスタイルを出力するかどうかを指定します。 newValtrueの場合は出力します、falseの場合は出力しません。