jp.terasoluna.fw.web.struts.taglib
クラス BodyTag

java.lang.Object
  上位を拡張 javax.servlet.jsp.tagext.TagSupport
      上位を拡張 jp.terasoluna.fw.web.struts.taglib.BodyTag
すべての実装されたインタフェース:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class BodyTag
extends javax.servlet.jsp.tagext.TagSupport

HTMLbody タグを拡張する body タグの実装クラス。

PageContext"ON_LOAD" をキーに 埋め込まれたスクリプトを onLoad イベント処理に追加する。
このタグで生成するHTML <body> タグでは、onLoad イベント処理時のスクリプトとして、JavaScript関数の __onLoad__() を呼び出す。JavaScript関数 __onLoad__() の定義は、 このタグで生成するため、HTML内に同名のJavaScriptを記述してはならない。

"styleClass""bgcolor""text""link""vlink""alink" といった このタグの属性は、そのままこのタグが生成するHTMLの <body> タグの属性として展開される。


タグがサポートする属性

body タグでは、以下の属性をサポートする。



属性名 デフォルト値 必須性 実行時式 概要
onload - false true 画面表示時に実行するJavaScript。
onunload - false true 画面アンロード時に実行するJavaScript。
styleClass - false true スタイルシートのクラス名。
bgcolor - false true 背景色。
background - false true 背景に設定する画像。
text - false true テキスト文字の色。
link - false true リンク部分の色。
vlink - false true 既に選択されたリンク部分の色。
alink - false true 選択中のリンク部分の色。


カスタムタグのスクリプティング変数

このタグによって設定されるスクリプティング変数はありません。


使用方法
  • JSP
  •   <%
        String script="任意のスクリプト文";
        pageContext.setAttribute("ON_LOAD", script);
      %>
      ・・・
      <ts:body>
      ・・・
      </ts:body>
     
  • 生成されたHTML
  •   <body onLoad="__onLoad__()">
        <script type="text/javascript">
          <!--
            function __onLoad__() {
              //キーが"ON_LOAD"のpageContextに格納されたスクリプト文
            }
          //-->
        </script>
      ・・・
      </body>
     

    関連項目:
    MessagesPopupTag, 直列化された形式

    フィールドの概要
    static String ON_LOAD_KEY
              onLoad イベントの処理に追加するスクリプトを取り出すための リクエスト属性のキー。
     
    クラス javax.servlet.jsp.tagext.TagSupport から継承されたフィールド
    id, pageContext
     
    インタフェース javax.servlet.jsp.tagext.IterationTag から継承されたフィールド
    EVAL_BODY_AGAIN
     
    インタフェース javax.servlet.jsp.tagext.Tag から継承されたフィールド
    EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
     
    コンストラクタの概要
    BodyTag()
               
     
    メソッドの概要
     int doEndTag()
              タグ評価終了時に呼ばれるメソッド。
     int doStartTag()
              タグ評価開始時に呼ばれるメソッド。
     void release()
              タグハンドラ解放時の処理。
     void setAlink(String value)
              選択中のリンク部分の色を設定する。
     void setBackground(String value)
              背景画像を設定する。
     void setBgcolor(String value)
              背景色を設定する。
     void setLink(String value)
              リンク部分の色を設定する。
     void setOnload(String value)
              画面表示時に実行するJavaScriptを設定する。
     void setOnunload(String value)
              画面アンロード時に実行するJavaScriptを設定する。
     void setStyleClass(String value)
              スタイルシートのクラス名を設定する。
     void setText(String value)
              テキスト文字の色を設定する。
     void setVlink(String value)
              既に選択されたリンク部分の色を設定する。
     
    クラス javax.servlet.jsp.tagext.TagSupport から継承されたメソッド
    doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
     
    クラス java.lang.Object から継承されたメソッド
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     

    フィールドの詳細

    ON_LOAD_KEY

    public static final String ON_LOAD_KEY
    onLoad イベントの処理に追加するスクリプトを取り出すための リクエスト属性のキー。

    関連項目:
    定数フィールド値
    コンストラクタの詳細

    BodyTag

    public BodyTag()
    メソッドの詳細

    setOnload

    public void setOnload(String value)
    画面表示時に実行するJavaScriptを設定する。

    パラメータ:
    value - JavaScript

    setOnunload

    public void setOnunload(String value)
    画面アンロード時に実行するJavaScriptを設定する。

    パラメータ:
    value - JavaScript

    setStyleClass

    public void setStyleClass(String value)
    スタイルシートのクラス名を設定する。

    パラメータ:
    value - クラス名

    setBgcolor

    public void setBgcolor(String value)
    背景色を設定する。

    パラメータ:
    value - 背景色

    setBackground

    public void setBackground(String value)
    背景画像を設定する。

    パラメータ:
    value - 背景色

    setText

    public void setText(String value)
    テキスト文字の色を設定する。

    パラメータ:
    value - テキスト文字の色

    setLink

    public void setLink(String value)
    リンク部分の色を設定する。

    パラメータ:
    value - リンク部分の色

    setVlink

    public void setVlink(String value)
    既に選択されたリンク部分の色を設定する。

    パラメータ:
    value - 既に選択されたリンク部分の色

    setAlink

    public void setAlink(String value)
    選択中のリンク部分の色を設定する。

    パラメータ:
    value - 選択中のリンク部分の色

    doStartTag

    public int doStartTag()
                   throws javax.servlet.jsp.JspException
    タグ評価開始時に呼ばれるメソッド。

    定義:
    インタフェース javax.servlet.jsp.tagext.Tag 内の doStartTag
    オーバーライド:
    クラス javax.servlet.jsp.tagext.TagSupport 内の doStartTag
    戻り値:
    処理制御指示。常に EVAL_BODY_INCLUDE
    例外:
    javax.servlet.jsp.JspException - JSP例外

    doEndTag

    public int doEndTag()
                 throws javax.servlet.jsp.JspException
    タグ評価終了時に呼ばれるメソッド。

    定義:
    インタフェース javax.servlet.jsp.tagext.Tag 内の doEndTag
    オーバーライド:
    クラス javax.servlet.jsp.tagext.TagSupport 内の doEndTag
    戻り値:
    処理制御指示。常に EVAL_PAGE
    例外:
    javax.servlet.jsp.JspException - JSP例外

    release

    public void release()
    タグハンドラ解放時の処理。

    定義:
    インタフェース javax.servlet.jsp.tagext.Tag 内の release
    オーバーライド:
    クラス javax.servlet.jsp.tagext.TagSupport 内の release


    Copyright © 2012. All Rights Reserved.