PFConstructBase (MZPlatform Component API)

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

PFComponent, java.io.Serializable

既知のサブインタフェースのリスト:

PFCombinativeComponent

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

PFCombinativeComponentImpl, PFComponentBus, PFGUICombinativeComponent, PFWebApplicationComponent
```
public interface PFConstructBase
extends PFComponent
```
構築対象となる基本構造のインターフェイス。
アプリケーションや複合コンポーネントなど、構築作業の単位となるすべてのオブジェクトはこのインターフェイスを実装する。

メソッドのサマリー

All Methods Instance Methods Abstract Methods
修飾子とタイプ	メソッドと説明
`void`	`addComment(PFApplicationComment comment)` 引数で与えられたアプリケーションコメントをプラットフォームに追加する。
`void`	`addComment(PFApplicationComment comment, int index)` 引数で与えられたアプリケーションコメントをプラットフォームに追加する。
`void`	`addComponent(PFComponent component)` 引数で与えられたコンポーネントをプラットフォームに追加する。
`void`	`addComponent(PFComponent component, int index)` 引数で与えられたコンポーネントをプラットフォームに追加する。
`int`	`checkTheApplicationWasLocked()` パスワードでロックされているかを確かめる.
`void`	`clear()` アプリケーション情報をクリアする。
`void`	`clear(java.util.Stack stack)` アプリケーション情報をクリアする。
`void`	`clearIndent(PFComponent component)` コンポーネントのインデント設定を解除する。
`void`	`decrementIndent(PFComponent component)` コンポーネントのインデントレベルを1つ減らす。
`int`	`getAllComponentCount()` コメントを含むコンポーネント数を取得する。
`java.util.Iterator`	`getAllComponentList()` コメントを含むコンポーネントリストを取得する。
`PFComponent`	`getComponentAt(int index)` 指定された位置のコンポーネントを取得する。
`int`	`getContainComponentCount()` コンポーネント数を取得する。
`java.util.Iterator`	`getContainComponentList()` コンポーネント配列を取得する。
`int`	`getIndent(PFComponent component)` コンポーネントのインデントレベルを取得する。
`java.util.Map`	`getIndentMap()` コンポーネントのインデントレベルを表すマップを取得する。
`void`	`incrementIndent(PFComponent component)` コンポーネントのインデントレベルを1つ増やす。
`void`	`informEventCompleted(jp.go.aist.dmrc.platform.util.PFComponentConnector connector)` 階層内でのイベント完了を通知する。
`void`	`informEventFired(jp.go.aist.dmrc.platform.util.PFComponentConnector connector)` 階層内でのイベント発生を通知する。
`boolean`	`isChild(PFComponent comp)` 指定されたコンポーネントを直下に含むかどうかをチェックする。
`boolean`	`moveComment(PFApplicationComment comment, int i)` コメントを移動する。
`boolean`	`moveComponent(PFComponent component, int i)` コンポーネントを移動する。
`boolean`	`moveComponentToTop(int count)` 最後尾のコンポーネントを先頭に移動する。
`void`	`removeComment(PFApplicationComment comment)` 引数で与えられたアプリケーションコメントをプラットフォームから削除する。
`void`	`removeComponent(PFComponent component)` 引数で与えられたコンポーネントをプラットフォームから削除する。
`void`	`removeComponent(java.util.Stack baseStack, PFComponent component)` 引数で与えられたコンポーネントをプラットフォームから削除する。
`void`	`renumberComponentID()` コンポーネントIDを振り直す。
`void`	`save(java.io.File saveFile)` アプリケーションをファイルに保存する。
`PFComponent`	`searchComponent(int id)` IDからコンポーネントを検索する。
`void`	`setIndentMap(java.util.Map map)` コンポーネントのインデントレベルを表すマップを設定する。
`void`	`sortComponent()` コンポーネントをID順に並べなおす。
`boolean`	`verifyPassword(java.lang.String readPass, java.lang.String inputPass)` パスワードを照合する.

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

- メソッドの詳細
  - addComponent
```
void addComponent(PFComponent component)
```
    引数で与えられたコンポーネントをプラットフォームに追加する。同時にコンポーネントにプラットフォーム内で一意のIDを設定する。
    
    パラメータ:
    
    component - 追加対象コンポーネント
  - addComponent
```
void addComponent(PFComponent component,
                  int index)
```
    引数で与えられたコンポーネントをプラットフォームに追加する。同時にコンポーネントにプラットフォーム内で一意のIDを設定する。
    
    パラメータ:
    
    component - 追加対象コンポーネント
    
    index - 追加位置
  - removeComponent
```
void removeComponent(PFComponent component)
              throws PFRuntimeException
```
    引数で与えられたコンポーネントをプラットフォームから削除する。
    
    パラメータ:
    
    component - 削除対象コンポーネント
    
    例外:
    
    PFRuntimeException - コンポーネント削除不可
  - removeComponent
```
void removeComponent(java.util.Stack baseStack,
                     PFComponent component)
              throws PFRuntimeException
```
    引数で与えられたコンポーネントをプラットフォームから削除する。
    
    パラメータ:
    
    baseStack - アプリケーション階層
    
    component - 削除対象コンポーネント
    
    例外:
    
    PFRuntimeException - コンポーネント削除不可
  - moveComponent
```
boolean moveComponent(PFComponent component,
                      int i)
```
    コンポーネントを移動する。
    
    パラメータ:
    
    component - 移動対象コンポーネント
    
    i - 移動先
    
    戻り値:
    
    移動があったかどうか
  - moveComponentToTop
```
boolean moveComponentToTop(int count)
```
    最後尾のコンポーネントを先頭に移動する。
    
    パラメータ:
    
    count - 移動数
    
    戻り値:
    
    移動があったかどうか
  - addComment
```
void addComment(PFApplicationComment comment)
```
    引数で与えられたアプリケーションコメントをプラットフォームに追加する。
    
    パラメータ:
    
    comment - 追加対象コメント
  - addComment
```
void addComment(PFApplicationComment comment,
                int index)
```
    引数で与えられたアプリケーションコメントをプラットフォームに追加する。
    
    パラメータ:
    
    comment - 追加対象コメント
    
    index - 追加位置
  - removeComment
```
void removeComment(PFApplicationComment comment)
```
    引数で与えられたアプリケーションコメントをプラットフォームから削除する。
    
    パラメータ:
    
    comment - 削除対象コメント
  - moveComment
```
boolean moveComment(PFApplicationComment comment,
                    int i)
```
    コメントを移動する。
    
    パラメータ:
    
    comment - 移動対象コメント
    
    i - 移動先
    
    戻り値:
    
    移動があったかどうか
  - sortComponent
```
void sortComponent()
```
    コンポーネントをID順に並べなおす。
  - renumberComponentID
```
void renumberComponentID()
```
    コンポーネントIDを振り直す。
  - getContainComponentList
```
java.util.Iterator getContainComponentList()
```
    コンポーネント配列を取得する。
    
    戻り値:
    
    コンポーネント配列
  - getContainComponentCount
```
int getContainComponentCount()
```
    コンポーネント数を取得する。
    
    戻り値:
    
    コンポーネント数
  - getComponentAt
```
PFComponent getComponentAt(int index)
```
    指定された位置のコンポーネントを取得する。
    
    パラメータ:
    
    index - 取得位置
    
    戻り値:
    
    コンポーネント
  - getAllComponentList
```
java.util.Iterator getAllComponentList()
```
    コメントを含むコンポーネントリストを取得する。
    
    戻り値:
    
    コンポーネントリスト
  - getAllComponentCount
```
int getAllComponentCount()
```
    コメントを含むコンポーネント数を取得する。
    
    戻り値:
    
    コンポーネント数
  - save
```
void save(java.io.File saveFile)
   throws java.io.FileNotFoundException,
          java.io.IOException
```
    アプリケーションをファイルに保存する。
    
    パラメータ:
    
    saveFile - 保存先ファイル
    
    例外:
    
    java.io.FileNotFoundException - ファイルが見つからない
    
    java.io.IOException - ファイル出力に失敗
  - clear
```
void clear()
```
    アプリケーション情報をクリアする。
  - clear
```
void clear(java.util.Stack stack)
```
    アプリケーション情報をクリアする。
    
    パラメータ:
    
    stack - コンポーネント階層
  - searchComponent
```
PFComponent searchComponent(int id)
```
    IDからコンポーネントを検索する。
    
    パラメータ:
    
    id - 検索するコンポーネントのID
  - verifyPassword
```
boolean verifyPassword(java.lang.String readPass,
                       java.lang.String inputPass)
```
    パスワードを照合する.
    
    パラメータ:
    
    readPass - 読み込んだパスワード
    
    inputPass - 入力されたパスワード
    
    戻り値:
    
    一致したらtrue
  - checkTheApplicationWasLocked
```
int checkTheApplicationWasLocked()
```
    パスワードでロックされているかを確かめる.
    
    戻り値:
    
    ロックされていない場合には-1、最上位層がロックされている場合には0、下位層にロックが含まれている場合には1
  - isChild
```
boolean isChild(PFComponent comp)
```
    指定されたコンポーネントを直下に含むかどうかをチェックする。
    
    パラメータ:
    
    comp - コンポーネント
    
    戻り値:
    
    含む場合true
  - informEventFired
```
void informEventFired(jp.go.aist.dmrc.platform.util.PFComponentConnector connector)
```
    階層内でのイベント発生を通知する。
    
    パラメータ:
    
    connector - 発生イベントのコンポーネントコネクタ
  - informEventCompleted
```
void informEventCompleted(jp.go.aist.dmrc.platform.util.PFComponentConnector connector)
```
    階層内でのイベント完了を通知する。
    
    パラメータ:
    
    connector - 発生イベントのコンポーネントコネクタ
  - getIndentMap
```
java.util.Map getIndentMap()
```
    コンポーネントのインデントレベルを表すマップを取得する。
    
    戻り値:
    
    インデントマップ
  - setIndentMap
```
void setIndentMap(java.util.Map map)
```
    コンポーネントのインデントレベルを表すマップを設定する。
    
    パラメータ:
    
    インデントマップ -
  - getIndent
```
int getIndent(PFComponent component)
```
    コンポーネントのインデントレベルを取得する。
    
    パラメータ:
    
    component - コンポーネント
  - incrementIndent
```
void incrementIndent(PFComponent component)
```
    コンポーネントのインデントレベルを1つ増やす。
    
    パラメータ:
    
    component - コンポーネント
  - decrementIndent
```
void decrementIndent(PFComponent component)
```
    コンポーネントのインデントレベルを1つ減らす。
    
    パラメータ:
    
    component - コンポーネント
  - clearIndent
```
void clearIndent(PFComponent component)
```
    コンポーネントのインデント設定を解除する。
    
    パラメータ:
    
    component - コンポーネント

インタフェース PFConstructBase

メソッドのサマリー

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

メソッドの詳細

addComponent

addComponent

removeComponent

removeComponent

moveComponent

moveComponentToTop

addComment

addComment

removeComment

moveComment

sortComponent

renumberComponentID

getContainComponentList

getContainComponentCount

getComponentAt

getAllComponentList

getAllComponentCount

save

clear

clear

searchComponent

verifyPassword

checkTheApplicationWasLocked

isChild

informEventFired

informEventCompleted

getIndentMap

setIndentMap

getIndent

incrementIndent

decrementIndent

clearIndent