PFPrintableComponent (MZPlatform Component API)

すべてのスーパーインタフェース:

PFComponent, java.awt.print.Printable, java.io.Serializable

既知の実装クラスのリスト:

PFPaper
```
public interface PFPrintableComponent
extends PFComponent, java.awt.print.Printable
```
帳票印刷が可能なコンポーネントインターフェイス。
帳票印刷が可能なコンポーネントはこのインターフェイスの実装となる。

フィールドのサマリー
- インタフェースから継承されたフィールド java.awt.print.Printable
  NO_SUCH_PAGE, PAGE_EXISTS

メソッドのサマリー

All Methods Instance Methods Abstract Methods
修飾子とタイプ	メソッドと説明
`void`	`addPaperElement(jp.go.aist.dmrc.platform.base.print.PFPaperElement element)` 帳票要素を追加する。
`void`	`addPaperPage()` 帳票のページを追加。
`void`	`addPaperPage(int pageno)` 帳票のページを追加。
`int`	`getGridSize()` グリッド線の間隔を取得する。
`float`	`getPaperDrawHeight()` 帳票の描画縦幅を取得する。
`float`	`getPaperDrawWidth()` 帳票の描画横幅を取得する。
`jp.go.aist.dmrc.platform.base.print.PFPaperElement`	`getPaperElement(int index)` 帳票要素を取得する。
`int`	`getPaperElementCount()` 帳票要素数を取得する。
`int`	`getPaperElementIndex(jp.go.aist.dmrc.platform.base.print.PFPaperElement element)` 帳票要素の位置を取得する。
`float`	`getPaperHeight()` 帳票の縦幅を取得する。
`int`	`getPaperOrientation()` 帳票方向を取得する。
`int`	`getPaperPageCount()` 帳票のページ数を取得。
`int`	`getPaperSize()` 帳票サイズを取得する。
`float`	`getPaperWidth()` 帳票の横幅を取得する。
`float`	`getPrintBottomMargin()` 帳票の下余白を取得する。
`float`	`getPrintLeftMargin()` 帳票の左余白を取得する。
`float`	`getPrintRightMargin()` 帳票の右余白を取得する。
`float`	`getPrintTopMargin()` 帳票の上余白を取得する。
`boolean`	`isExcelOutputButtonVisible()` 印刷プレビューダイアログのExcel出力ボタンの表示/非表示を取得する.
`void`	`movePaperElement(jp.go.aist.dmrc.platform.base.print.PFPaperElement element, int index)` 帳票要素を移動する。
`void`	`movePaperElementBottom(jp.go.aist.dmrc.platform.base.print.PFPaperElement element)` 帳票要素を最背面に移動する。
`void`	`movePaperElementTop(jp.go.aist.dmrc.platform.base.print.PFPaperElement element)` 帳票要素を最前面に移動する。
`void`	`previewPaper(java.awt.Component parent)` 帳票をプレビューする。
`void`	`printPaper()` 帳票を印刷する。
`void`	`printPaper(boolean showDialog)` 帳票を印刷する。
`void`	`removePaperElement(jp.go.aist.dmrc.platform.base.print.PFPaperElement element)` 帳票要素を削除する。
`void`	`removePaperPage()` 帳票のページを削除。
`void`	`removePaperPage(int pageno)` 帳票のページを削除。
`void`	`setExcelOutputButtonVisible(boolean excelOutputButtonVisible)` 印刷プレビューダイアログのExcel出力ボタンの表示/非表示を設定する.
`void`	`setGridSize(int gridSize)` グリッド線の間隔を設定する。
`void`	`setPaperHeight(float height)` 帳票の縦幅を設定する。
`void`	`setPaperOrientation(int orientation)` 帳票方向を設定する。
`void`	`setPaperPageCount(int num)` 帳票のページ数を設定する。
`void`	`setPaperSize(float width, float height)` 帳票サイズを設定する。
`void`	`setPaperSize(int size)` 帳票サイズを設定する。
`void`	`setPaperWidth(float width)` 帳票の横幅を設定する。
`void`	`setPrintBottomMargin(float bottom)` 帳票の下余白を設定する。
`void`	`setPrintLeftMargin(float left)` 帳票の左余白を設定する。
`void`	`setPrintMargin(float top, float bottom, float left, float right)` 帳票の余白を設定する。
`void`	`setPrintRightMargin(float right)` 帳票の右余白を設定する。
`void`	`setPrintTopMargin(float top)` 帳票の上余白を設定する。
`void`	`writeExcel()` Excelファイルに出力する。

インタフェースから継承されたメソッド jp.go.aist.dmrc.platform.base.PFComponent
getComponentID, getComponentKey, getComponentName, getComponentPublicName, getComponentString, isAllowPullTransfer, isAllowPushTransfer, isAllowRemoteInvocation, localeUpdated, setAllowPullTransfer, setAllowPushTransfer, setAllowRemoteInvocation, setComponentID, setComponentKey, setComponentPublicName

インタフェースから継承されたメソッド java.awt.print.Printable
print

- メソッドの詳細
  - getPaperElementCount
```
int getPaperElementCount()
```
    帳票要素数を取得する。
    
    戻り値:
    
    帳票要素数
  - getPaperElement
```
jp.go.aist.dmrc.platform.base.print.PFPaperElement getPaperElement(int index)
```
    帳票要素を取得する。
    
    パラメータ:
    
    index - 取得対象インデックス
    
    戻り値:
    
    帳票要素
  - addPaperElement
```
void addPaperElement(jp.go.aist.dmrc.platform.base.print.PFPaperElement element)
```
    帳票要素を追加する。
    
    パラメータ:
    
    element - 帳票要素
  - removePaperElement
```
void removePaperElement(jp.go.aist.dmrc.platform.base.print.PFPaperElement element)
```
    帳票要素を削除する。
    
    パラメータ:
    
    element - 帳票要素
  - printPaper
```
void printPaper()
```
    帳票を印刷する。
  - printPaper
```
void printPaper(boolean showDialog)
```
    帳票を印刷する。
    
    パラメータ:
    
    showDialog - 印刷ダイアログ表示
  - previewPaper
```
void previewPaper(java.awt.Component parent)
```
    帳票をプレビューする。
    
    パラメータ:
    
    parent - 親コンポーネント
  - setPaperSize
```
void setPaperSize(int size)
```
    帳票サイズを設定する。
    
    パラメータ:
    
    size - 帳票サイズ
  - getPaperSize
```
int getPaperSize()
```
    帳票サイズを取得する。
    
    戻り値:
    
    帳票サイズ
  - setPaperSize
```
void setPaperSize(float width,
                  float height)
           throws PFComponentException
```
    帳票サイズを設定する。
    
    パラメータ:
    
    width - 帳票横幅（単位：mm）
    
    height - 帳票縦幅（単位：mm）
    
    例外:
    
    PFComponentException - 指定されたサイズの値が正しくない
  - getPaperWidth
```
float getPaperWidth()
```
    帳票の横幅を取得する。
    
    戻り値:
    
    帳票横幅（単位：mm）
  - getPaperHeight
```
float getPaperHeight()
```
    帳票の縦幅を取得する。
    
    戻り値:
    
    帳票縦幅（単位：mm）
  - setPaperWidth
```
void setPaperWidth(float width)
            throws PFComponentException
```
    帳票の横幅を設定する。
    
    パラメータ:
    
    width - 帳票横幅（単位：mm）
    
    例外:
    
    PFComponentException - 指定されたサイズの値が正しくない
  - setPaperHeight
```
void setPaperHeight(float height)
             throws PFComponentException
```
    帳票の縦幅を設定する。
    
    パラメータ:
    
    height - 帳票縦幅（単位：mm）
    
    例外:
    
    PFComponentException - 指定されたサイズの値が正しくない
  - setPaperOrientation
```
void setPaperOrientation(int orientation)
```
    帳票方向を設定する。
    
    パラメータ:
    
    orientation - 帳票方向（横長：PAPER_ORIENTATION_LANDSCAPE、縦長：PAPER_ORIENTATION_PORTRAIT）
  - getPaperOrientation
```
int getPaperOrientation()
```
    帳票方向を取得する。
    
    戻り値:
    
    帳票方向（横長：PAPER_ORIENTATION_LANDSCAPE、縦長：PAPER_ORIENTATION_PORTRAIT）
  - setPrintMargin
```
void setPrintMargin(float top,
                    float bottom,
                    float left,
                    float right)
             throws PFComponentException
```
    帳票の余白を設定する。
    
    パラメータ:
    
    top - 上余白（単位：mm）
    
    bottom - 下余白（単位：mm）
    
    left - 左余白（単位：mm）
    
    right - 右余白（単位：mm）
    
    例外:
    
    PFComponentException - 指定された余白の値が正しくない
  - getPrintTopMargin
```
float getPrintTopMargin()
```
    帳票の上余白を取得する。
    
    戻り値:
    
    上余白（単位：mm）
  - getPrintBottomMargin
```
float getPrintBottomMargin()
```
    帳票の下余白を取得する。
    
    戻り値:
    
    下余白（単位：mm）
  - getPrintLeftMargin
```
float getPrintLeftMargin()
```
    帳票の左余白を取得する。
    
    戻り値:
    
    左余白（単位：mm）
  - getPrintRightMargin
```
float getPrintRightMargin()
```
    帳票の右余白を取得する。
    
    戻り値:
    
    右余白（単位：mm）
  - setPrintTopMargin
```
void setPrintTopMargin(float top)
                throws PFComponentException
```
    帳票の上余白を設定する。
    
    パラメータ:
    
    top - 上余白（単位：mm）
    
    例外:
    
    PFComponentException - 指定された余白の値が正しくない
  - setPrintBottomMargin
```
void setPrintBottomMargin(float bottom)
                   throws PFComponentException
```
    帳票の下余白を設定する。
    
    パラメータ:
    
    bottom - 下余白（単位：mm）
    
    例外:
    
    PFComponentException - 指定された余白の値が正しくない
  - setPrintLeftMargin
```
void setPrintLeftMargin(float left)
                 throws PFComponentException
```
    帳票の左余白を設定する。
    
    パラメータ:
    
    left - 左余白（単位：mm）
    
    例外:
    
    PFComponentException - 指定された余白の値が正しくない
  - setPrintRightMargin
```
void setPrintRightMargin(float right)
                  throws PFComponentException
```
    帳票の右余白を設定する。
    
    パラメータ:
    
    right - 右余白（単位：mm）
    
    例外:
    
    PFComponentException - 指定された余白の値が正しくない
  - getPaperDrawWidth
```
float getPaperDrawWidth()
```
    帳票の描画横幅を取得する。
    
    戻り値:
    
    帳票描画横幅（単位：mm）
  - getPaperDrawHeight
```
float getPaperDrawHeight()
```
    帳票の描画縦幅を取得する。
    
    戻り値:
    
    帳票描画縦幅（単位：mm）
  - setGridSize
```
void setGridSize(int gridSize)
```
    グリッド線の間隔を設定する。
    
    パラメータ:
    
    gridSize - グリッド線の間隔
  - getGridSize
```
int getGridSize()
```
    グリッド線の間隔を取得する。
    
    戻り値:
    
    グリッド線の間隔
  - movePaperElement
```
void movePaperElement(jp.go.aist.dmrc.platform.base.print.PFPaperElement element,
                      int index)
```
    帳票要素を移動する。
    
    パラメータ:
    
    element - 帳票要素
    
    index - 移動位置
  - movePaperElementBottom
```
void movePaperElementBottom(jp.go.aist.dmrc.platform.base.print.PFPaperElement element)
```
    帳票要素を最背面に移動する。
    
    パラメータ:
    
    element - 帳票要素
  - movePaperElementTop
```
void movePaperElementTop(jp.go.aist.dmrc.platform.base.print.PFPaperElement element)
```
    帳票要素を最前面に移動する。
    
    パラメータ:
    
    element - 帳票要素
  - getPaperElementIndex
```
int getPaperElementIndex(jp.go.aist.dmrc.platform.base.print.PFPaperElement element)
```
    帳票要素の位置を取得する。
    
    パラメータ:
    
    element - 帳票要素
    
    戻り値:
    
    位置
  - setPaperPageCount
```
void setPaperPageCount(int num)
```
    帳票のページ数を設定する。
    
    パラメータ:
    
    num - ページ数
  - getPaperPageCount
```
int getPaperPageCount()
```
    帳票のページ数を取得。
    
    戻り値:
    
    ページ数
  - addPaperPage
```
void addPaperPage(int pageno)
```
    帳票のページを追加。
    
    パラメータ:
    
    pageno - ページ番号
  - addPaperPage
```
void addPaperPage()
```
    帳票のページを追加。
  - removePaperPage
```
void removePaperPage()
```
    帳票のページを削除。
  - removePaperPage
```
void removePaperPage(int pageno)
```
    帳票のページを削除。
    
    パラメータ:
    
    pageno - ページ番号
  - writeExcel
```
void writeExcel()
```
    Excelファイルに出力する。
  - isExcelOutputButtonVisible
```
boolean isExcelOutputButtonVisible()
```
    印刷プレビューダイアログのExcel出力ボタンの表示/非表示を取得する.
    
    戻り値:
    
    表示の場合はtrue
  - setExcelOutputButtonVisible
```
void setExcelOutputButtonVisible(boolean excelOutputButtonVisible)
```
    印刷プレビューダイアログのExcel出力ボタンの表示/非表示を設定する.
    
    パラメータ:
    
    excelOutputButtonVisible -

インタフェース PFPrintableComponent

フィールドのサマリー

インタフェースから継承されたフィールド java.awt.print.Printable

メソッドのサマリー

インタフェースから継承されたメソッド jp.go.aist.dmrc.platform.base.PFComponent

インタフェースから継承されたメソッド java.awt.print.Printable

メソッドの詳細

getPaperElementCount

getPaperElement

addPaperElement

removePaperElement

printPaper

printPaper

previewPaper

setPaperSize

getPaperSize

setPaperSize

getPaperWidth

getPaperHeight

setPaperWidth

setPaperHeight

setPaperOrientation

getPaperOrientation

setPrintMargin

getPrintTopMargin

getPrintBottomMargin

getPrintLeftMargin

getPrintRightMargin

setPrintTopMargin

setPrintBottomMargin

setPrintLeftMargin

setPrintRightMargin

getPaperDrawWidth

getPaperDrawHeight

setGridSize

getGridSize

movePaperElement

movePaperElementBottom

movePaperElementTop

getPaperElementIndex

setPaperPageCount

getPaperPageCount

addPaperPage

addPaperPage

removePaperPage

removePaperPage

writeExcel

isExcelOutputButtonVisible

setExcelOutputButtonVisible