以下は、各種プログラミング言語からCopper PDFにアクセスする際に設定出来るプロパティの一覧です。 プロパティの設定方法の詳細は開発マニュアルをご参照ください。
| 名前 | デフォルト | バージョン | 説明 |
|---|---|---|---|
| input.default-encoding | JISAutoDetect | 1.0.0 | HTMLのMETA要素でキャラクタ・エンコーディングを判断出来ない場合に使用するキャラクタ・エンコーディング名です。。 |
| input.default-stylesheet | - | 1.0.0 | デフォルトのCSSスタイルシートのURIです。 このプロパティが指定されている場合、最初にデフォルトのスタイルシートが読み込まれます。 |
| input.filters | xslt default-to-xhtml loose-html |
1.0.0 |
入力HTML(XML)のフィルタリングです。適用される順にフィルタ名をスペース区切りで並べます。
以下のフィルタ名が用意されています。
|
| input.property-pi | false | 2.0.0 | trueを設定するとドキュメント中でjp.cssj.property-pi処理命令を使うことが出来るようになります。 |
| input.stylesheet.titles | - | 1.0.0 | 適用するCSSスタイルシートのタイトルをスペース区切りで並べます。 link要素またはxml-stylesheet処理命令で関連付けられたスタイルシートについて、 デフォルトでは代替スタイル以外が全て適用されますが、 このプロパティを用いて適用するスタイルシートを指定することが出来ます。 |
| input.xslt.default-stylesheet | - | 1.2.0 | デフォルトのXSLTスタイルシートのURIです。 このプロパティが指定されている場合、最初にデフォルトのスタイルシートが読み込まれます。 input.filtersにxsltフィルタが存在するとき場合のみ有効です。 |
| 名前 | デフォルト | バージョン | 説明 |
|---|---|---|---|
| input.http.referer | true | 1.0.1 |
HTTP通信でサーバー側のデータを取得するときにRefererヘッダを送るかどうかの指定です。
trueまたはfalseで指定します。 falseを指定すると、Refererを用いて画像などのリソースへの直接アクセスを規制しているサイトでリソースにアクセス出来なくなります。 |
| input.http.proxy.host | - | 1.2.6 |
プロクシのホスト名です。 この設定するとHTTP通信でプロクシを用います。 |
| input.http.proxy.port | 8080 | 1.2.6 |
プロクシを使う際のポート番号です。 この設定はinput.http.proxy.hostが設定されている場合のみ有効です。 |
|
input.http.proxy.authentication.user input.http.proxy.authentication.password |
- | 1.2.6 | 認証が必要なプロクシサーバーでの認証情報(user,password)です。 この設定はinput.http.proxy.hostが設定されている場合のみ有効です。 |
|
input.http.header.n.name input.http.header.n.value |
- | 2.0.0 |
HTTP接続で送信するヘッダです。 nは0から始まる通し番号で、nが同じ2つのプロパティで一組です。 nameはヘッダ名でvalueはヘッダの値です。 通し番号は0から開始してカウントしていき、必要な情報(name)が欠けていた時点で以降のパラメータは無効となります。 |
| input.http.authentication.preemptive | false | 1.2.6 |
HTTP通信で認証を行う場合に、最初から認証情報を送るかどうかの設定です。
trueまたはfalseで指定します。 trueを指定すると、Authorizationヘッダ等の認証情報を最初の接続で送ります。 falseを指定すると、最初にサーバーから401レスポンスを受け取ってレルムや認証スキーマ等の情報を取得します。 trueを指定した場合、Digest認証や複数のレルムが存在するサーバーで認証が行われなくなります。 |
|
input.http.authentication.n.host input.http.authentication.n.user input.http.authentication.n.password input.http.authentication.n.port input.http.authentication.n.realm input.http.authentication.n.schema |
- | 1.2.6 |
認証が必要なサイトでの認証情報です。 nは通し番号で、nが同じ4つのプロパティで一組です。 hostは対象となるホストで、user,passwordが認証に用いられるユーザー名とパスワードです。 portはポート番号、realmは認証領域のレルム、schemaは認証スキーマ(basicまたはdigest)です。 port,realm,schemaは省略可能で、省略した場合はそれぞれ全てのポート、レルム、スキーマでの認証が行われます。 通し番号は0から開始してカウントしていき、必要な情報(hostおよびuser)が欠けていた時点で以降のパラメータは無効となります。 |
|
input.http.cookie.n.domain input.http.cookie.n.name input.http.cookie.n.value input.http.cookie.n.path |
- | 1.2.6 |
送信するクッキーです。
nは通し番号で、nが同じ4つのプロパティで一組です。
domain,name,valueはそれぞれクッキーのドメインと名前、値です。
pathはクッキーのパスで、省略した場合はルート(/)となります。 通し番号は0から開始してカウントしていき、必要な情報(domainおよびname)が欠けていた時点で以降のパラメータは無効となります。 |
|
input.http.connection.timeout |
0 | 2.0.7 | HTTP接続の接続タイムアウト(ミリ秒)です。 設定した時間内に接続が確立されない場合は、接続エラーとします。 0の場合はタイムアウトなしです。 |
|
input.http.socket.timeout |
0 | 2.0.7 | HTTP接続のソケット通信タイムアウト(ミリ秒)です。 設定した時間以上待ち時間が発生した場合は、通信エラーとします。 0の場合はタイムアウトなしです。 |
| 名前 | デフォルト | バージョン | 説明 |
|---|---|---|---|
| output.auto-height | false | 1.0.0 |
自動高さの指定です。falseまたはtrueで指定します。 trueにすると、自動改ページをせず、ページの高さを文書の内容の高さに合わせます。 このとき、output.page-heightプロパティは無効になります。 出力可能なページのサイズには制限があります。 |
| output.broken-image | none | 1.2.2 noneは2.0.0 |
壊れた画像の表示方法。none,hidden,crossで指定します。 noneでは代替テキスト(alt属性の値)だけが挿入されます。 hiddenではwidth, height属性による矩形の範囲が空白となります。 crossでは、width, height属性による矩形の範囲に×印が表示されます。 |
| output.clip | true | 2.0.3 | trueに設定した場合、印刷面の外側(トンボのドブの外側、あるいはページの外側)を描画しません。 falseに設定した場合、印刷面の外側を描画します。 |
| output.color | rgb | 1.2.1 | 出力結果のカラー・タイプです。rgb,grayで指定します。 rgbではフルカラーで出力されます。 grayでは、グレイスケールに変換されます。 |
| output.compatible_mode | copper | 2.0.0 | レイアウトの互換モードです。copper,msieで指定します。 msieを指定すると、Internet Explorer 7に近いレイアウトを再現します。 |
| output.default-font-family | serif | 2.0.0 |
デフォルトのフォントファミリです。
ドキュメント中でフォントが指定されていない場合、
あるいは該当するフォントが見つからない場合、このフォントを使用します。 CSSのfont-familyと同じ形式で複数のフォントを指定することが出来ます。 空白を含むフォント名はクウォート('または")で囲うことに注意してください。 |
| output.fit-to-paper | false | 2.0.0 | trueに設定した場合、内容が用紙に合わせて拡大されます。 falseに設定した場合、中央寄せされます。 |
| output.marks | none | 1.0.0 hiddenは1.2.1 |
トンボおよび裁ち口の表示です。none,crop,cross,both,hiddenのいずれかを指定します。 それぞれ、トンボ・裁ち口なし、コーナートンボを表示、センタートンボを表示、両方のトンボを表示、裁ち口だけを表示する、という意味になります。 |
| output.media_types | all print paged visual bitmap static | 2.0.0 | 適用するスタイルシートのメディアタイプです。 |
|
output.meta.n.name output.meta.n.value |
- | 2.0.3 |
文書情報をあらかじめ設定します。
nは0から始まる通し番号で、nが同じ2つのプロパティで一組です。
文書情報はドキュメント内の<meta name="名前" content="値">要素によって上書きされます。 詳細は文書情報の節を参照してください。 |
| output.no-page-break | false | 2.0.3 | trueに設定すると改ページを全くしなくなります。 output.auto-height をtrueに設定するのと異なり、ページの高さを内容に合わせて拡大しません。 |
| output.page-height | 297mm | 1.0.0 |
ページの高さです。デフォルトはA4の高さです。 CSSの長さの単位(mm,cm,in,pt,pc,px)を使ってください。 出力可能なページのサイズには制限があります。 この設定は文書中の@pageルール内で上書き出来ます。 |
| output.page-limit | - | 1.2.0 | 最大ページ数です。ページ数が限界に達すると、処理が中断されます。 デフォルトでは無制限です。 |
| output.page-margins | 12.7mm | 2.0.0 | ページの余白です。 CSSのmarginプロパティと同じ形式で記述します。 長さの単位は(mm,cm,in,pt,pc,px)が使用可能です。 この設定は文書中の@pageルール内で上書き出来ます。 |
| output.page-width | 210mm | 1.0.0 |
ページの幅です。デフォルトはA4の横幅です。 CSSの長さの単位(mm,cm,in,pt,pc,px)を使ってください。 出力可能なページのサイズには制限があります。 この設定は文書中の@pageルール内で上書き出来ます。 |
| output.paper-height | output.page-heightの値 | 2.0.0 |
用紙の高さです。デフォルトはページの高さです。
用紙とページの大きさが異なる場合の動作はoutput.fit-to-paperの設定によります。 CSSの長さの単位(mm,cm,in,pt,pc,px)を使ってください。 出力可能なページのサイズには制限があります。 |
| output.paper-width | output.paper-widthの値 | 2.0.0 |
用紙の幅です。デフォルトはページの横幅です。 用紙とページの大きさが異なる場合の動作はoutput.fit-to-paperの設定によります。 CSSの長さの単位(mm,cm,in,pt,pc,px)を使ってください。 出力可能なページのサイズには制限があります。 |
| output.print-mode | double-side | 2.0.0 |
印刷モードです。single-side, double-sideのいずれかを指定します。 single-sideでは片面印刷となり、@pageルールの:left, :right擬似クラスは適用されなくなります。 |
| output.resolution | 96 | 2.0.0 |
px単位の基準となる解像度です。 ppi(1インチあたりのピクセル数)を指定します。 一般的なブラウザでは96という値が使われます。 72を指定すると1pt(PDFの基本単位)と1pxの長さが同じになります。 |
| output.image.resolution | 96 | 2.0.4 |
output.typeの設定によりラスター画像を出力する際の解像度(dpi)です。 なお、2.0.8以前ではデフォルト値が72となっており、解像度が正しく反映されないバグがありました。 2.0.9以降では 以前の設定 × output.resolution / 72) で換算した値を設定してください。 |
| output.size-limit | - | 1.2.0 | 出力データの最大サイズ(バイト)です。サイズが限界に達すると、処理が中断されます。 デフォルトでは無制限です。 |
| output.htrim | 1cm | 2.0.0 |
左右の裁ち口の幅です。 CSSの長さの単位(mm,cm,in,pt,pc,px)を使ってください。 |
| output.vtrim | 1cm | 2.0.0 |
上下の裁ち口の幅です。 CSSの長さの単位(mm,cm,in,pt,pc,px)を使ってください。 |
| output.type | application/pdf | 1.0.0 |
出力(MIME)形式です。
"application/pdf"(PDFファイル)は必ず利用することが出来ます。 Copper PDF 2.0.3から画像の出力に対応しました。画像の出力はJava Image I/Oに依存しており、 Java実行環境がサポートする画像形式("image/png"など)を利用することが出来ます。 また、JAI等のプラグインをJava実行環境にインストールすることで、 利用可能な画像形式を追加することが出来ます。 画像の出力では最後のページだけが出力されます。 また、コア14フォントとフォント設定ファイルのcid-keyed-font要素によるCID-Keyedフォントは正確に描画出来ません。 |
| 名前 | デフォルト | バージョン | 説明 |
|---|---|---|---|
|
output.pdf.attachments.n.name output.pdf.attachments.n.description output.pdf.attachments.n.mime-type output.pdf.attachments.n.uri |
なし | 1.2.0 (PDF 1.4) |
添付ファイルです。 nは通し番号で、nが同じ4つのプロパティで一組です。 nameはファイル名、descriptionはファイルについての説明で、省略可能です。 mime-typeはファイルのMIME型で、省略可能です。 uriはファイルの内容が置かれたURIで、省略出来ません。 通し番号は0から開始してカウントしていき、必要な情報(uri)が欠けていた時点でファイルの添付を終わります。 nameにはASCII文字だけを使うことを推奨します(マルチバイト文字を含むことは出来ますが、表示環境によっては文字化けします)。 マルチバイト文字が含まれる場合は、URLエンコードなどでASCIIに変換したものをnameに使い、 実際のファイル名をdescriptionにセットしてください。 |
| output.pdf.bookmarks | false | 1.0.0 (PDF 1.2) |
ブックマーク機能です。falseまたはtrueで指定します。 trueにすると、H1〜H6要素をもとにブックマーク(アウトライン)を生成します。 |
| output.pdf.compression | binary | 1.0.0 (PDF 1.2) |
圧縮方法です。none,ascii,binaryで指定します。 後者ほど圧縮効率がよくなります。 noneでは画像以外は圧縮せず、asciiでは画像以外の内容も圧縮されますが、生成されるPDFはテキストファイルとなります。 binaryの場合、生成されるPDFは圧縮され、かつバイナリ形式となります。 ただし、暗号化を行う場合は、結果的に全てバイナリとなることに注意してください。 |
| output.pdf.encryption | none | 1.2.0 (PDF 1.2) (v2はPDF 1.3) |
暗号化方式です。none,v1,v2で指定します。 noneは暗号化なし、v1は40ビットArcfour暗号、v2は40-128ビットArcfour暗号です。 |
| output.pdf.encryption.length | 128 | 1.2.0 (PDF 1.3) |
暗号化キーの長さ(ビット)です。 output.pdf.encryption=v1では40で固定です。 v2では40から128の間で、8ビット刻みで指定可能です。 |
| output.pdf.encryption.user-password | 空 | 1.2.0 (PDF 1.2) |
文書を開くためのパスワードです。 このパスワードを使って文書を閲覧する場合は、文書に設定されたパーミッションによる制限がかかります。 |
| output.pdf.encryption.owner-password | ユーザーのパスワード | 1.2.0 (PDF 1.2) |
文書の権限を変更するためのパスワード(マスタパスワード)です。 文書に対するあらゆる操作を可能にします。 |
| output.pdf.encryption.permissions.print | true | 1.2.0 (PDF 1.2) |
文書を印刷する権限です。 true=許可,false=禁止 です。 |
| output.pdf.encryption.permissions.modify | true | 1.2.0 (PDF 1.2) |
文書中の内容を変更をする権限です。 true=許可,false=禁止 です。 |
| output.pdf.encryption.permissions.copy | true | 1.2.0 (PDF 1.2) |
文書中のテキストや画像をコピーする権限です。 true=許可,false=禁止 です。 |
| output.pdf.encryption.permissions.add | true | 1.2.0 (PDF 1.2) |
注釈を追加・変更する、あるいはフォームに入力する権限です。
output.pdf.encryption.permissions.modify=trueであればフォームの追加・変更も許可されます。 true=許可,false=禁止 です。 |
| output.pdf.encryption.permissions.fill | true | 1.2.0 (PDF 1.3) |
フォームに入力する権限です。 output.pdf.encryptionがv2のときだけ有効です true=許可,false=禁止 です。 |
| output.pdf.encryption.permissions.extract | true | 1.2.0 (PDF 1.3) |
障害のあるユーザーのために文書中のテキストや画像を抽出する権限です。 output.pdf.encryptionがv2のときだけ有効です true=許可,false=禁止 です。 |
| output.pdf.encryption.permissions.assemble | true | 1.2.0 (PDF 1.3) |
文書中に新しいページ、ブックマーク、サムネイル画像を追加する権限です。 output.pdf.encryptionがv2のときだけ有効です true=許可,false=禁止 です。 |
| output.pdf.encryption.permissions.print-high | true | 1.2.0 (PDF 1.3) |
文書を高画質で印刷する権限です。 output.pdf.encryptionがv2のときだけ有効です true=許可,false=禁止 です。 |
| output.pdf.file-id | ランダムに生成 | 2.0.9 |
PDFのファイルIDを設定します。32桁固定の16進数を使用してください。 例: "000067A36902BF8D2A0617B9CD02BCFA" |
| output.pdf.fonts.policy | cid-keyed | 1.1.0 (PDF 1.2) |
デフォルトのフォントの埋め込みポリシーです。cid-keyed,cid-identity,embeddedで指定します。
指定する値と、使用するフォントの対応は以下の通りです。
Copper PDF 2.0.1からは、スペース区切りで複数の指定が可能になりました。 例えば"embedded cid-keyed"という指定をすると、埋め込みフォントが見つからない場合はCID Keyedフォントを使用します。 |
| output.pdf.hyperlinks | false | 1.0.0 (PDF 1.2) |
ハイパーリンク機能です。falseまたはtrueで指定します。 trueにすると、PDFからWWWなどへのハイパーリンクが有効になります。 |
| output.pdf.hyperlinks.href | relative | 1.1.0 (PDF 1.2) |
ハイパーリンクのアドレスの記述方法です。relativeまたはabsoluteで指定します。 relativeでは相対アドレス指定となり、HTMLのa要素のhref属性がそのまま使われます。 absoluteでは絶対URIに変換されてPDFに反映されます。 |
| output.pdf.hyperlinks.base | ドキュメントのURI | 2.0.0 (PDF 1.2) |
output.pdf.hyperlinks.hrefにrelativeを指定した場合の、基準となるURIです。 output.pdf.hyperlinks.hrefがabsoluteの場合は、このプロパティは無効です。 |
| output.pdf.hyperlinks.fragment | true | 2.0.0 (PDF 1.2) |
trueを設定するとHTMLの<a name～あるいはid属性によりドキュメントフラグメントが配置され、URLのフラグメント識別子によって
ドキュメント内の特定の場所へリンクすることが出来るようになります。 falseを設定した場合はドキュメントフラグメントを配置しません。 |
| output.pdf.image.compression | flate | 2.0.3 |
画像をPDFに埋め込むときの圧縮形式です。以下の値を指定可能です。
|
| output.pdf.image.compression.lossless | 200 | 2.0.3 | output.pdf.image.compression により非可逆圧縮(JPEG形式等)を使用する場合、非可逆圧縮を適用する画像サイズの閾値です。 指定されたサイズ(縦のピクセル数と横のピクセル数を足したもの)より小さければ可逆圧縮(FlateDecode)を使用します。 |
| output.pdf.jpeg-image | raw | 1.1.0 (PDF 1.2) |
JPEG画像の埋め込み方法です。raw,to-flate,recompress(Copper PDF 2.0.3以降)で指定します。 rawでは元のデータをそのまま使います。 to-flateまたはrecompressを設定すると、データを再圧縮します (Copper PDF 2.0.2以前ではto-flateしか使用出来ず、文字通りFlateDecode形式に再圧縮していました。 Copper PDF 2.0.3以降ではoutput.pdf.image.compressionの設定により他の圧縮形式も使用出来ますが、 to-flateとrecompressは全く同じ意味です)。 Copper PDF 2.0.3以降ではシステムにJAIがインストールされ、かつPDF 1.5以降の出力でJPEG 2000に対しても有効になります。 |
| output.pdf.meta.creation-date | サーバーの現在時刻 | 2.0.9 |
PDFのメタ情報のCreationDateを設定します。 設定例: "2009-05-22 21:10:14" "2009-06-04 15:53:02 +0900" (タイムゾーンを明示する場合) |
| output.pdf.meta.mod-date | output.pdf.meta.creation-dateの値 | 2.0.9 |
PDFのメタ情報のModDateを設定します。 時刻の形式はoutput.pdf.meta.creation-dateと同じです。 |
| output.pdf.platform-encoding | MS932 | 1.2.0 (PDF 1.2) |
PDFを表示する環境のプラットフォームのキャラクタ・エンコーディングです。 PDF1.2以前ではフォント名が影響を受けます。PDF1.3以降ではユニコードが使われるため無関係です。 PDF1.6以前では添付ファイル名が影響を受けます。 ファイル名にマルチバイト文字が使われている場合、このエンコーディングが表示するプラットフォームのものと一致しないと文字化けします。 日本語の文書であればMS932(Windows版Shift_JIS)、韓国語であればEUC-KR、繁体字中国語ではBig5といった指定をしてください。 PDF1.7以降ではユニコードが使われるため無関係です(Copper PDF 2.0.3)。 |
| output.pdf.version | 1.5 | 1.1.0 |
出力されるPDFファイルのバージョンです。1.2,1.3,1.4,1.5,1.6,1.7が指定可能です(1.5,1.6,1.7はCSSJ 1.xでは対応していません)。
PDFのバージョンによって利用出来る機能が変わります。
指定されたバージョンで未対応の機能を使おうとすると警告が出力され、PDFに反映されません。 PDFの一定のバージョンで有効になる機能は以下の通りです。
|
| 名前 | デフォルト | バージョン | 説明 |
|---|---|---|---|
| processing.page-references | false | 2.0.0 | trueを設定すると、目次、ページ参照のための情報を収集します。 falseを設定すると、目次、ページ参照のための情報を収集しないため一部の機能が利用出来なくなります。 詳細はページの参照を参照してください。 |
| processing.pass-count | 1 | 1.2.0 | 1回のフォーマット処理のために、文書を処理する回数です。 詳細は2パス以上の変換処理を参照してください。 |
以下のリストにあるプロパティはinput.property-piの設定とは関係なく、 jp.cssj.property処理命令による設定が出来ません。
機能限定版の場合、原則として入出力プロパティはデフォルトのままで固定されます。 ただし、以下のプロパティは例外的に変更することが出来ます。
また、利用出来るフォントがCID-Keyedフォントのみに固定されているため、 -cssj-font-policyプロパティを利用出来ません。