jp.veltec.pdf

## クラス PdfLayout

- java.lang.Object
- - jp.veltec.pdf.PdfLayout

- 直系の既知のサブクラス:
    ParagraphLayout, TableLayout

      public abstract class PdfLayout
      extends java.lang.Object

  1ページのレイアウトを行うための基底クラスです。

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `PdfLayout(java.io.OutputStream aOutputStream)`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `addPage()` 属性とデータを確定し、ページを追加します。
    `void` | `addPage(java.util.HashMap<java.lang.String,java.lang.String> aData)` 埋め込む値を指定してページを追加します。
    `void` | `clearAttributes()` setAttributesでセットした属性をクリアします。
    `void` | `clearData()` 埋め込みデータをクリアします。
    `void` | `close()` 帳票をクローズします。
    `void` | `removeAttribute(java.lang.String aId, java.lang.String aKey)` 属性をクリアします。
    `void` | `setAttribute(java.lang.String aId, java.lang.String aKey, java.lang.String aValue)` 属性をセットします。
    `void` | `setAttributes(java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> aExtraAttributes)` 属性をセットします。
    `void` | `setData(java.lang.String aKey, java.lang.String aValue)` テンプレートに埋め込むデータを指定します。
    `void` | `setFontPath(java.lang.String aDefaultFontPath)` フォントファイルのデフォルトパスをセットします。
    `void` | `setImagePath(java.lang.String aImagePath)` 画像ファイルのデフォルトパスをセットします。
    `void` | `setPageHeaderText(java.lang.String aHeaderText)` ページヘッダーのテキストをセットします。
    `void` | `setPageNumber(int aPageNumber)` ページ番号の初期値をセットします。
    `void` | `setTemplate(org.w3c.dom.Element aTemplate)` テンプレートをセットします。
    `void` | `setTemplateFile(java.io.File aFile)` テンプレートファイルをセットします。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### PdfLayout

          public PdfLayout(java.io.OutputStream aOutputStream)

  - ### メソッドの詳細

    - #### setData

          public void setData(java.lang.String aKey,
                     java.lang.String aValue)

      テンプレートに埋め込むデータを指定します。
      パラメータ:
        `aKey` - 値を埋め込む要素のID
        `aValue` - 埋め込む値

    - #### clearData

          public void clearData()

      埋め込みデータをクリアします。

    - #### setAttributes

          public void setAttributes(java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.String>> aExtraAttributes)

      属性をセットします。
      パラメータ:
        `aExtraAttributes` - セット先の要素をキーに属性の[名前=値]ペアを保持するHashMap

    - #### clearAttributes

          public void clearAttributes()

      setAttributesでセットした属性をクリアします。

    - #### setAttribute

          public void setAttribute(java.lang.String aId,
                          java.lang.String aKey,
                          java.lang.String aValue)

      属性をセットします。
      パラメータ:
        `aId` - 属性をセットする要素のID
        `aKey` - 属性名
        `aValue` - 属性値

    - #### removeAttribute

          public void removeAttribute(java.lang.String aId,
                             java.lang.String aKey)

      属性をクリアします。
      パラメータ:
        `aId` - 属性をセットする要素のID
        `aKey` - 属性名

    - #### setImagePath

          public void setImagePath(java.lang.String aImagePath)

      画像ファイルのデフォルトパスをセットします。
      パラメータ:
        `aImagePath` - 画像ファイルのデフォルトパス

    - #### setFontPath

          public void setFontPath(java.lang.String aDefaultFontPath)

      フォントファイルのデフォルトパスをセットします。
      パラメータ:
        `aDefaultFontPath` - フォントファイルのデフォルトパス

    - #### setPageNumber

          public void setPageNumber(int aPageNumber)

      ページ番号の初期値をセットします。
      パラメータ:
        `aPageNumber` - ページ番号

    - #### setPageHeaderText

          public void setPageHeaderText(java.lang.String aHeaderText)

      ページヘッダーのテキストをセットします。
      パラメータ:
        `aHeaderText` - ヘッダーのテキスト

    - #### setTemplateFile

          public void setTemplateFile(java.io.File aFile)
                               throws java.io.IOException

      テンプレートファイルをセットします。
      パラメータ:
        `aFile` - テンプレートファイル
      例外:
        `java.io.IOException`

    - #### setTemplate

          public void setTemplate(org.w3c.dom.Element aTemplate)

      テンプレートをセットします。
      パラメータ:
        `aTemplate` - テンプレート

    - #### addPage

          public void addPage()
                       throws java.lang.IllegalStateException

      属性とデータを確定し、ページを追加します。
      例外:
        `java.lang.IllegalStateException`

    - #### addPage

          public void addPage(java.util.HashMap<java.lang.String,java.lang.String> aData)
                       throws java.lang.IllegalStateException

      埋め込む値を指定してページを追加します。
      パラメータ:
        `aData` - 埋め込む値を[ID=値]形式でセットしたHashMap
      例外:
        `java.lang.IllegalStateException`

    - #### close

          public void close()
                     throws PdfException

      帳票をクローズします。
      例外:
        `PdfException`