パッケージ jp.co.antenna.ptl

クラス PtlParamImagePage

java.lang.Object
jp.co.antenna.ptl.PtlParamImagePage
すべての実装されたインタフェース:
AutoCloseable
public class PtlParamImagePage extends Object implements AutoCloseable
画像のページ作成に使うパラメータクラスです。

  • コンストラクタの詳細

    • PtlParamImagePage

      public PtlParamImagePage() throws PtlException
      コンストラクタ
      例外:
      PtlException - 例外

    • PtlParamImagePage

      public PtlParamImagePage(PtlParamImagePage obj) throws PtlException
      コピーコンストラクタ
      パラメータ:
      obj - コピー元オブジェクト。
      例外:
      PtlException - 例外

  • メソッドの詳細

    • close

      public void close()
      終了処理。

      このオブジェクトが抱えているネイティブ側にあるリソースなどを廃棄して終了処理を行ないます。
      このオブジェクトを使い終わったら必ず呼ばなければなりません。

      定義:
      close インタフェース内 AutoCloseable

    • setImage

      public void setImage(PtlParamDrawImage paramDrawImage) throws PtlException
      ページに挿入する画像パラメータを設定。
      パラメータ:
      paramDrawImage - ページに挿入する画像パラメータ。
      例外:
      PtlException - 例外

    • setPaperType

      public void setPaperType(PtlParamImagePage.PAPER_TYPE paperType) throws PtlException
      用紙タイプを設定。

      ※ 設定しない場合はデフォルト値としてPAPER_IMAGE_SIZEが設定されます。

      パラメータ:
      paperType - 用紙タイプの指定。PAPER_XXXのいずれか。
      例外:
      PtlException - 例外

    • setCustomPageSize

      public void setCustomPageSize(PtlSize sizeMM) throws PtlException
      ユーザ定義ページサイズを設定

      setPaperTypeでPAPER_CUSTOM_SIZEが設定された場合に有効となります。
      この関数は新規ページに画像を設定する場合に有効となります。
      setPaperTypeでPAPER_CUSTOM_SIZEを設定してページサイズを設定しないとsetPaperSizeでPAPER_IMAGE_SIZEが設定されたとみなされます。

      パラメータ:
      sizeMM - PDFの用紙サイズを設定します(単位はmm)。
      例外:
      PtlException - 例外

    • setRect

      public void setRect(PtlRect rectMM) throws PtlException
      画像を配置する矩形を設定。

      座標の単位はmmで原点(0,0)は左下となりますので注意してください。
      画像の配置位置の設定はsetRectとsetMarginがあります。
      setMarginも併せて設定するとその値により設定内容は調整されます。
      座標の単位はmmで原点(0,0)は左下となりますので注意してください。

      パラメータ:
      rectMM - 画像を配置する矩形。
      例外:
      PtlException - 例外

    • setMargin

      public void setMargin(float topMM, float leftMM, float bottomMM, float rightMM) throws PtlException
      画像を配置するときの余白を設定。

      画像の配置位置の設定はsetRectとsetMarginがあります。
      setRectも併せて設定するとその値により設定内容は調整されます。
      座標の単位はmmで原点(0,0)は左下となりますので注意してください。

      パラメータ:
      topMM - 画像を配置するときの上側の余白(単位はmm)。
      leftMM - 画像を配置するときの左側の余白(単位はmm)。
      bottomMM - 画像を配置するときの下側の余白(単位はmm)。
      rightMM - 画像を配置するときの右側の余白(単位はmm)。
      例外:
      PtlException - 例外

    • setAlign

      public void setAlign(PtlParamImagePage.ALIGN align) throws PtlException
      画像の配置を設定。

      設定しない場合はALIGN_CENTERが設定されたとみなされます。

      パラメータ:
      align - 画像の配置指定。ALIGN_XXXのいずれか。
      例外:
      PtlException - 例外