Top

Documentation

5-8. デフォルトレイアウト

※この機能は 1.1.10 で追加されました。

レイアウト共有機能を使うためには、対象となるすべての Mayaa ファイルの m:mayaa 要素に m:extends 属性を書く必要があります。多数のページがあり、全部にこの設定をするのは手間がかかります。また、レイアウトを適用するためだけの Mayaa ファイルが必要になることもあるかもしれません。

全部のページに共通で設定する場合、エンジン設定をすることで m:extends 属性を書くことなくレイアウト共有機能を利用できます。明示的に m:extends 属性が書かれているページには適用されません。手順は下記の通りです。

1. templateBuilder の設定
2. デフォルトレイアウト用のページを作成
3. 適用したくないページの定義

templateBuilder の設定

templateBuilder の設定を変更し、TemplateBuilderImpl の代わりに DefaultLayoutTemplateBuilder を使うようにし、デフォルトレイアウト用の追加パラメータを設定します。

org.seasar.mayaa.provider.ServiceProvider
※レイアウトの都合で改行しています。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE provider
    PUBLIC "-//The Seasar Foundation//DTD Mayaa Provider 1.0//EN"
    "http://mayaa.seasar.org/dtd/mayaa-provider_1_0.dtd">
<provider>
    <templateBuilder
            class="org.seasar.mayaa.impl.builder.
                             DefaultLayoutTemplateBuilder">
        (標準の TemplateBuilderImpl と同じ部分は省略)
        <parameter name="defaultLayoutPageName"
                             value="/defaultlayout.html"/>
        <parameter name="generateMayaaNode" value="true"/>
    </templateBuilder>
</provider>

DefaultLayoutTemplateBuilder のデフォルトレイアウト用パラメータは 2 つです。その他は TemplateBuilderImpl と同じパラメータを使えます。

defaultLayoutPageName

デフォルトレイアウトとして使用するテンプレートの名前を "/" 始まりで指定します。Mayaa 起動時に指定したファイルが見つからない場合、デフォルトレイアウト機能は有効になりません。デフォルトは "/defaultlayout.html" です。

generateMayaaNode

Mayaa ファイルのない、テンプレートのみのページにもレイアウトを適用するかどうかを設定します。テンプレートのみのページの場合、doRender は default.mayaa で定義します。true を設定するとテンプレートのみのページにも適用し、false に設定すると適用しません。デフォルトは "true" です。

デフォルトレイアウト用のページを作成

デフォルトレイアウトを使う場合も、各ページ自体は明示的にレイアウト共有機能を使う場合と同じです。Mayaa ファイルのない、テンプレートのみのページにデフォルトレイアウトを適用する場合には、default.mayaa で doRender プロセッサを定義する形になります。

適用したくないページの定義

明示的にレイアウト定義をしている場合、つまり Mayaa タグに m:extends 属性を記述している場合はデフォルトレイアウトは適用されません。

一部のページのみデフォルトレイアウトを使いたくない場合、そのページには明示的に m:extends 属性を記述してください。値が空の場合、レイアウト共有機能は無効です。