public class ImprintPastingParameters
extends java.lang.Object
ImprintPastingParameters は印影を PDF 文書内に表示するために必要な構成パラメータを提供します。
PDFTimeStampGenerator はこれらのパラメータを使用し、印影付きの PDF タイムスタンプを生成します。
ImprintPastingParameters は印影を表示させるページを指定するときにページ原点とページ数を指定します。
ページ数の指定のみではなくページ数をカウントする起点を指定できることによって
文書の最終ページから n ページといった指定ができます。
このことにより常に文書の最終ページに印影を表示させるという設定が可能となります。
PDF Lib-J ではページ内の印影の位置を指定する場合に APLPosition
により距離 (x、y) を double 値で、またその単位を指定できるようになっています。
しかし、PDF 文書へ実際に PDF タイムスタンプを埋め込む際には、
距離はポイント単位に変換され、変換後の値の小数点以下は切り捨てられて整数値として格納されます。
したがって PDF Lib-J で作成済みの PDF 文書から印影の位置を取得すると APLPosition
の単位は常にポイントになり、距離はポイント単位の整数値となります。
ミリ単位からポイント単位への距離の変換には次の式を使用します。 式中の xm はミリ単位の x 値、 xp はポイント単位の x 値を表します。 また、ym はミリ単位の y 値、 ypはポイント単位の y 値を表します。
インチ単位からポイント単位への距離の変換には次の式を使用します。 式中の xi はインチ単位の x 値、 xp はポイント単位の x 値を表します。 また、yi はインチ単位の y 値、 ypはポイント単位の y 値を表します。
ImprintPastingParameters のすべてのメソッドは、いかなるパラメータに null を渡しても NullPointerException をスローします。
修飾子とタイプ | フィールドと説明 |
---|---|
static int |
FIRST_PAGE
ページ数をカウントする起点を PDF 文書の最初のページにすることを表します。
|
static int |
LAST_PAGE
ページ数をカウントする起点を PDF 文書の最終のページにすることを表します。
|
コンストラクタと説明 |
---|
ImprintPastingParameters()
ImprintPastingParameters オブジェクトを生成します。
|
修飾子とタイプ | メソッドと説明 |
---|---|
Imprint |
getImprint()
印影を返します。
|
int |
getPage()
ページ番号を返します。
|
int |
getPageOrigin()
ページ数をカウントする起点を返します。
|
APLPosition |
getPosition()
ページ内で印影を表示する位置を返します。
|
void |
setImprint(Imprint imprint)
印影を設定します。
|
void |
setPage(int pageIndex)
ページ番号を設定します。
|
void |
setPageOrigin(int pageOrigin)
ページ数をカウントする起点を設定します。
|
void |
setPosition(APLPosition position)
ページ内で印影を表示する位置を設定します。
|
public static final int FIRST_PAGE
public static final int LAST_PAGE
public ImprintPastingParameters()
public int getPage()
setPageOrigin メソッドを使用して文書の最終ページからページ数をカウントするようにしている場合は最終ページが 0、 その前のページが 1 と続きます。
ImprintPastingParameters が作成されると、ページ番号は 0 に初期化されます。
setPage(int)
public void setPage(int pageIndex)
setPageOrigin メソッドを使用して文書の最終ページからページ数をカウントするようにしている場合は最終ページが 0、 その前のページが 1 と続きます。
ImprintPastingParameters が作成されると、ページ番号は 0 に初期化されます。
pageIndex
- ページ番号(0〜)java.lang.IndexOutOfBoundsException
- ページ番号が負の値の場合getPage()
public int getPageOrigin()
ImprintPastingParameters が作成されると、ページ数をカウントする起点は FIRST_PAGE に初期化されます。
setPageOrigin(int)
public void setPageOrigin(int pageOrigin)
ImprintPastingParameters が作成されると、ページ数をカウントする起点は FIRST_PAGE に初期化されます。
pageOrigin
- ページ数をカウントする起点java.lang.IllegalArgumentException
- pageOrigin が FIRST_PAGE、または LAST_PAGE のどちらでもない場合getPageOrigin()
public APLPosition getPosition()
ImprintPastingParameters が作成されると、ページ内で印影を表示する位置は次の値を持つ APLPosition オブジェクトに初期化されます。
origin (原点): | UPPER_LEFT_ORIGIN (ページ左上) |
unit (単位): | MM (ミリメートル) |
x (x 値): | 0 |
y (y 値): | 0 |
setPosition(jp.co.amano.etiming.apl3161.APLPosition)
public void setPosition(APLPosition position)
ImprintPastingParameters が作成されると、ページ内で印影を表示する位置は次の値を持つ APLPosition オブジェクトに初期化されます。
origin (原点): | UPPER_LEFT_ORIGIN (ページ左上) |
unit (単位): | MM (ミリメートル) |
x (x 値): | 0 |
y (y 値): | 0 |
position
- ページ内で印影を表示する位置getPosition()
public Imprint getImprint()
ImprintPastingParameters が作成されると、印影は Imprint のデフォルトコンストラクタで作成したオブジェクトに初期化されます。
setImprint(jp.co.amano.etiming.apl3161.Imprint)
public void setImprint(Imprint imprint)
ImprintPastingParameters が作成されると、印影は Imprint のデフォルトコンストラクタで作成したオブジェクトに初期化されます。
imprint
- 印影getImprint()
Copyright(C) 2005-2023 AMANO Corporation. All Rights Reserved.