概要 | パッケージ | クラス | 非推奨 API | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.seasar.mayaa.engine.processor
インタフェース TemplateProcessor

すべてのスーパーインタフェース:
  NodeReferenceResolverFinder, ProcessorReferenceResolverFinder, ProcessorTreeWalker, java.io.Serializable

既知のサブインタフェースの一覧:
  ChildEvaluationProcessor, IterationProcessor, TryCatchFinallyProcessor

public interface TemplateProcessor
extends ProcessorTreeWalker

テンプレート中のHTMLタグを処理するクラス。 リクエストに対してステートレスなように実装しなければならない。

メソッドの概要
`ProcessStatus` | `doEndProcess()` 閉じタグの出力。
`ProcessStatus` | `doStartProcess(Page topLevelPage)` 開きタグの出力。
`SpecificationNode` | `getInjectedNode()` インジェクションされたノード情報の取得。
`SpecificationNode` | `getOriginalNode()` テンプレート上の該当するノード情報の取得。
`ProcessorDefinition` | `getProcessorDefinition()` このプロセッサの定義を取得する。
`java.lang.String` | `getUniqueID()` テンプレート内でユニークなID値を取得する。
`void` | `initialize()` インスタンス生成処理の最後、プロパティをセットした後で呼ばれる。
`void` | `kill()` 推奨されていません。
`void` | `notifyBeginRender(Page topLevelPage)` ページに対して予め通知を受けるように登録していた場合に、 呼び出される。
`void` | `setInjectedNode(SpecificationNode node)` インジェクションされたノード情報の設定。
`void` | `setOriginalNode(SpecificationNode node)` テンプレート上の該当するノード情報を設定する。
`void` | `setProcessorDefinition(ProcessorDefinition definition)` このプロセッサの定義への参照を設定する。

インタフェース org.seasar.mayaa.engine.processor.ProcessorTreeWalker から継承したメソッド
`addChildProcessor, clearChildProcessors, getChildProcessor, getChildProcessorSize, getParentProcessor, getStaticParentProcessor, getVariables, insertProcessor, removeProcessor, setParentProcessor`

インタフェース org.seasar.mayaa.engine.specification.serialize.ProcessorReferenceResolverFinder から継承したメソッド
`findProcessorResolver`

インタフェース org.seasar.mayaa.engine.specification.serialize.NodeReferenceResolverFinder から継承したメソッド
`findNodeResolver`

メソッドの詳細

### initialize

    public void initialize()

  インスタンス生成処理の最後、プロパティをセットした後で呼ばれる。

### getUniqueID

    public java.lang.String getUniqueID()

  テンプレート内でユニークなID値を取得する。

  戻り値:
    テンプレート中でユニークなID。

### doStartProcess

    public ProcessStatus doStartProcess(Page topLevelPage)

  開きタグの出力。テンプレートテキストやWhiteSpaceの場合も、 このメソッドで出力する。

  パラメータ:
    `topLevelPage` - 描画トップレベルのページ。
  戻り値:
    子プロセッサを処理する場合にはEVAL_BODY_INCLUDE、 子プロセッサの処理をスキップする場合にはSKIP_BODYを返す。

### doEndProcess

    public ProcessStatus doEndProcess()

  閉じタグの出力。

  戻り値:
    ページのこのタグ以降を処理する場合にはEVAL_PAGE、 以降の処理をスキップする場合にはSKIP_PAGE。

### setOriginalNode

    public void setOriginalNode(SpecificationNode node)

  テンプレート上の該当するノード情報を設定する。

  パラメータ:
    `node` - テンプレートノード。

### getOriginalNode

    public SpecificationNode getOriginalNode()

  テンプレート上の該当するノード情報の取得。

  戻り値:
    テンプレートノード。

### setInjectedNode

    public void setInjectedNode(SpecificationNode node)

  インジェクションされたノード情報の設定。

  パラメータ:
    `node` - インジェクトされたノード。

### getInjectedNode

    public SpecificationNode getInjectedNode()

  インジェクションされたノード情報の取得。

  戻り値:
    インジェクトされたノード。

### setProcessorDefinition

    public void setProcessorDefinition(ProcessorDefinition definition)

  このプロセッサの定義への参照を設定する。

  パラメータ:
    `definition` - プロセッサ定義。

### getProcessorDefinition

    public ProcessorDefinition getProcessorDefinition()

  このプロセッサの定義を取得する。

  戻り値:
    プロセッサ定義。

### kill

    public void kill()

  推奨されていません。

  本プロセッサのインスタンスを破棄対象とし、 本プロセッサが保持していた他のオブジェクトへの参照リンクを切る。

### notifyBeginRender

    public void notifyBeginRender(Page topLevelPage)

  ページに対して予め通知を受けるように登録していた場合に、 呼び出される。

  パラメータ:
    `topLevelPage` - 描画トップレベルのページ。

概要 | パッケージ | クラス | 非推奨 API | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド