パッケージ org.opengion.hayabusa.taglib

# クラス FrameTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
jakarta.servlet.jsp.tagext.BodyTagSupport
org.opengion.hayabusa.taglib.CommonTagSupport
org.opengion.hayabusa.taglib.HTMLTagSupport
org.opengion.hayabusa.taglib.FrameTag

すべての実装されたインタフェース:
  `BodyTag`, `IterationTag`, `JspTag`, `Tag`, `TryCatchFinally`, `Serializable`

直系の既知のサブクラス:
  `IframeTag`

public class FrameTag extends HTMLTagSupport
フレームを作成するHTML拡張タグで、引数の受け渡しが可能です。

関連項目:
  - 直列化された形式
機能分類
  画面部品
形式ｻﾝﾌﾟﾙ:
  ●形式：<og:frame src="…" name="…" /> ●body：なし ●Tag定義： <og:frame src ○【HTML】フレームに表示するソースファイルを指定します(必須)。 name ○【HTML】フレーム名を指定します(例：QUERY,RESULT,CONTENTS など)(必須)。 changeGamen 【TAG】ソース指定の画面を変更します changeHref 【TAG】forwardしたいJSPファイル名を記述します(例:result など) 7.4.2.0 (2021/05/14) keys 【TAG】引数のキーを指定します vals 【TAG】引数の値を指定します 7.4.3.0 (2021/06/11) dbTable 【TAG】前ページで選択したデータ列の情報を次のページに渡すかどうか[true/false]を指定します(初期値:false) longdesc 【HTML】フレームに関する詳しい説明のあるURL(lobgdesc)を指定します forceEnc 【TAG】(通常は使いません) valsの値が[で開始している場合でもURLEncodeを通すかを設定します(初期値:false) 5.10.15.3 (2019/09/27) id 【HTML】要素に対して固有の名前(id)をつける場合に設定します clazz 【HTML】要素に対して class 属性を設定します title 【HTML】要素に対する補足的情報(title)を設定します style 【HTML】この要素に対して適用させるスタイルシート(style)を設定します caseKey 【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 5.7.7.2 (2014/06/20) caseVal 【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 5.7.7.2 (2014/06/20) caseNN 【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20) caseNull 【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20) caseIf 【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない) debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) /> 【廃止】7.0.1.0 (2018/10/15) 物理削除 // marginwidth 【廃止】フレームの左右余白サイズ(marginwidth)を指定します(HTML5廃止属性) // marginheight 【廃止】フレームの上下余白サイズ(marginheight)を指定します(HTML5廃止属性) // noresize 【廃止】フレームサイズを変更できないよう(noresize)に指定します(HTML5廃止属性) 6.9.5.0 (2018/04/23) 物理削除 // frameborder 【廃止】フレームの境界線(frameborder)の[0:非表示/1:表示]を指定します(初期値:1)(HTML5廃止属性) 6.9.5.0 (2018/04/23) 物理削除 // scrolling 【廃止】スクロールバー(scrolling)の表示/非表示[auto/yes/no]を指定します(初期値:auto)(HTML5廃止属性) ●使用例： ・一般的な例：フレーム分割する構文は、HTML準拠。リクエスト変数は各フレームまで転送されます。 <frameset> <og:frame src="query.jsp" name="QUERY" /> <og:frame src="forward.jsp" name="RESULT" /> </frameset> ・DBTableModel の値(例ではPN)を、取り出して、リクエスト変数として利用します。 現状では、commonForward タグ の useTableData="true" dbkeys="{@dbkeys}" 属性を利用します。 <frameset> <og:frame src="query.jsp" name="QUERY" keys="PN" dbTable="true" /> <og:frame src="forward.jsp" name="RESULT" keys="PN" dbTable="true" /> </frameset> ・changeGamen 属性を利用して、ソース指定の画面を切り替えます。 たとえば、jsp/index.jsp では、GAMENID属性がURLに存在する場合、直接その画面を 表示させることができます。 <frameset cols="160,*,0" frameborder="1" framespacing="1"> <og:frame src="menu/menu.jsp" name="MENU" /> <og:frame src="GE0000/index.jsp" name="CONTENTS" keys="PN" vals="LKIS" changeGamen="{@GAMENID}" /> </frameset>
導入されたバージョン:
  JDK5.0,

- ## フィールドの概要

  フィールド
  修飾子とタイプ
  フィールド
  説明
  `protected boolean`
  `useForceEnc`
  強制URLエンコード用

  ### クラスから継承されたフィールド org.opengion.hayabusa.taglib.CommonTagSupport

  `BR, BUFFER_MIDDLE, CR`

  ### クラスから継承されたフィールド jakarta.servlet.jsp.tagext.BodyTagSupport

  `bodyContent`

  ### クラスから継承されたフィールド jakarta.servlet.jsp.tagext.TagSupport

  `id, pageContext`

  ### インタフェースから継承されたフィールド jakarta.servlet.jsp.tagext.BodyTag

  `EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

  ### インタフェースから継承されたフィールド jakarta.servlet.jsp.tagext.IterationTag

  `EVAL_BODY_AGAIN`

  ### インタフェースから継承されたフィールド jakarta.servlet.jsp.tagext.Tag

  `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

- ## コンストラクタの概要

  コンストラクタ
  コンストラクタ
  説明
  `FrameTag()`
  デフォルトコンストラクター

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `protected String`
  `getUrlEncode()`
  keys 属性 を元に、request情報より values の値を取り込む。
  `protected String`
  `makeTag()`
  リンクを作成します。
  `protected String`
  `makeTagFrame(String urlEnc)`
  リンクを作成します。
  `protected void`
  `release2()`
  タグリブオブジェクトをリリースします。
  `void`
  `setChangeGamen(String src)`
  【TAG】ソース指定の画面を変更します。
  `void`
  `setChangeHref(String href)`
  【TAG】ソース指定の画面を変更します。
  `void`
  `setDbTable(String db)`
  【TAG】前ページで選択したデータ列の情報を次のページに渡すかどうか[true:渡す/false:渡さない]を指定します(初期値:false)。
  `void`
  `setForceEnc(String flg)`
  【TAG】valsの値が[で開始している場合でもURLEncodeを通すかを設定します(初期値:false)。
  `void`
  `setKeys(String key)`
  【TAG】引数のキーを指定します。
  `void`
  `setLongdesc(String longdesc)`
  【HTML】フレームに関する詳しい説明のあるURL(lobgdesc)を指定します。
  `void`
  `setName(String name)`
  【HTML】フレーム名を指定します(例：QUERY,RESULT,CONTENTS など)。
  `void`
  `setSrc(String src)`
  【HTML】フレームに表示するソースファイルを指定します。
  `void`
  `setVals(String val)`
  【TAG】引数の値を指定します。
  `String`
  `toString()`
  このオブジェクトの文字列表現を返します。

  ### クラスから継承されたメソッド org.opengion.hayabusa.taglib.HTMLTagSupport

  `doEndTag, getMustType, makeAimaiPicker, makeMustHidden, setAccesskey, setAimai, setAutocomplete, setAutofocus, setClazz, setDir, setDisabled, setId, setLang, setList, setMax, setMin, setMust, setMustAny, setOnBlur, setOnChange, setOnClick, setOndblClick, setOnFocus, setOnKeydown, setOnKeypress, setOnKeyup, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setOptionAttributes, setPattern, setPlaceholder, setReadonly, setRequired, setRoles, setStep, setStyle, setTabindex, setTitle, setUseMustHidden`

  ### クラスから継承されたメソッド org.opengion.hayabusa.taglib.CommonTagSupport

  `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, debugPrint, doAfterBody, doCatch, doFinally, doStartTag, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getCSVParameter, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLongLabel, getMsg, getMsglbl, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getTagName, getTransaction, getUser, getUserEditInfo, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, makeUrl, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseIf, setCaseKey, setCaseNN, setCaseNull, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, useMainTrans, useQuotCheck, useTag, useXssCheck`

  ### クラスから継承されたメソッド jakarta.servlet.jsp.tagext.BodyTagSupport

  `doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

  ### クラスから継承されたメソッド jakarta.servlet.jsp.tagext.TagSupport

  `findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue`

  ### クラスから継承されたメソッド java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

  ### インタフェースから継承されたメソッド jakarta.servlet.jsp.tagext.Tag

  `getParent, setPageContext, setParent`

- ## フィールド詳細

  - ### useForceEnc

    protected boolean useForceEnc
    強制URLエンコード用

- ## コンストラクタの詳細

  - ### FrameTag

    public FrameTag()
    デフォルトコンストラクター
    変更履歴:
      6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

- ## メソッドの詳細

  - ### release2

    protected void release2()
    タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
    オーバーライド:
      `release2` クラス内 `HTMLTagSupport`
    変更履歴:
      2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加, 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 5.10.15.3 (2019/09/27) forceEnc追加, 7.4.3.0 (2021/06/11) URL の引数にセットする値を指定する

  - ### makeTag

    protected String makeTag()
    リンクを作成します。
    定義:
      `makeTag` クラス内 `HTMLTagSupport`
    戻り値:
      リンクタグ文字列
    変更履歴:
      3.5.4.0 (2003/11/25) comand="RENEW" 時には、dbTable 属性は、強制的に false とします。, 5.9.1.2 (2015/10/23) iframeとの継承関係で、共通的に呼び出すメソッドを追加します。
    このﾒｿｯﾄﾞは、nullを返しません

  - ### makeTagFrame

    protected String makeTagFrame(String urlEnc)
    リンクを作成します。
    パラメータ:
      `urlEnc` - エンコードされたURL
    戻り値:
      リンクタグ文字列
    変更履歴:
      5.9.1.2 (2015/10/23) iframeとの継承関係で、共通的に呼び出すメソッドを追加します。
    このﾒｿｯﾄﾞは、nullを返しません

  - ### getUrlEncode

    protected String getUrlEncode()
    keys 属性 を元に、request情報より values の値を取り込む。 keys属性は キー情報がCSV形式になっている為,ばらして values属性の配列に一つづつ設定していきます。
    戻り値:
      URLエンコードされた文字列
    変更履歴:
      2.0.0.2 (2002/09/24) 検索結果の値を取り込めていなかったバグを修正。, 2.1.1.1 (2002/11/15) 選択行情報を取り込めていなかったバグを修正。, 3.4.0.3 (2003/09/10) DBTableModelへのリクエスト情報をURLに連結しないように変更。, 4.0.0.0 (2005/01/31) getParameterRows() を使用するように変更, 5.10.15.3 (2019/09/27) forceEnc追加, 7.4.3.0 (2021/06/11) URL の引数にセットする値を指定する
    このﾒｿｯﾄﾞは、nullを返しません

  - ### setSrc

    public void setSrc(String src)
    【HTML】フレームに表示するソースファイルを指定します。
    パラメータ:
      `src` - ソースファイル
    説明:
      フレームに表示するソースファイルを指定します。

  - ### setName

    public void setName(String name)
    【HTML】フレーム名を指定します(例：QUERY,RESULT,CONTENTS など)。
    パラメータ:
      `name` - フレーム名
    説明:
      フレーム名を指定します。

  - ### setLongdesc

    public void setLongdesc(String longdesc)
    【HTML】フレームに関する詳しい説明のあるURL(lobgdesc)を指定します。
    パラメータ:
      `longdesc` - 詳しい説明のあるURL
    説明:
      lobgdescを指定します。

  - ### setForceEnc

    public void setForceEnc(String flg)
    【TAG】valsの値が[で開始している場合でもURLEncodeを通すかを設定します(初期値:false)。
    パラメータ:
      `flg` - URLEncodeを通す場合は、trueをｾｯﾄ
    変更履歴:
      5.10.15.3 (2019/09/27) forceEnc追加
    説明:
      テーブルモデルの値の変換のため、通常は先頭が[の場合はエンコードがかかりません。 強制的にかける場合にtrueにします。

  - ### setChangeGamen

    public void setChangeGamen(String src)
    【TAG】ソース指定の画面を変更します。
    パラメータ:
      `src` - 置換えソース
    変更履歴:
      3.1.2.0 (2003/04/07) 画面IDと実画面ディレクトリとの関連見直し(DIRの代りにGAMENIDを推奨), 4.2.1.1 (2008/04/30) 画面切り替えをするのは、アドレスが設定されいる場合に限る
    説明:
      src 指定がデフォルト設定で、changeGamen属性が設定されている 場合には、この値が優先されます。 changeGamen は、画面IDのみ指定してください。src には、このID＋"/index.jsp" が 追加されます。つまり、changeGamen="{@GAMENID}" という指定をしておけば、 FavoriteLinkTag 等で引数に GAMENID が指定された場合のみ、この属性が有効になり、 src="実画面ID/index.jsp" が指定されたことと同じ結果になります。 changeHref が指定され場合には、src="実画面ID/JSPID.jsp" が指定されたことと同じ 結果になります。

  - ### setChangeHref

    public void setChangeHref(String href)
    【TAG】ソース指定の画面を変更します。
    パラメータ:
      `href` - 置換えソース
    変更履歴:
      7.4.2.0 (2021/05/14) frameタグでforwardしたいJSPファイルの指定ができるようにする
    説明:
      forwardしたいJSPファイル名を記述します。(例:result など) 初期値は "index.jsp" が設定されます。 実際には、各JSP画面(result.jsp )にリクエストが転送されます。 changeGamenとchangeHref が指定され場合には、src="実画面ID/JSPID.jsp" が 指定されたことと同じ結果になります。

  - ### setKeys

    public void setKeys(String key)
    【TAG】引数のキーを指定します。
    パラメータ:
      `key` - キー(CSV形式)
    説明:
      URL の引数にセットするキーを CSV形式でセットします。

  - ### setVals

    public void setVals(String val)
    【TAG】引数の値を指定します。
    パラメータ:
      `val` - 値(CSV形式)
    変更履歴:
      7.4.3.0 (2021/06/11) URL の引数にセットする値を指定する
    説明:
      URL の引数にセットする値を CSV形式でセットします。

  - ### setDbTable

    public void setDbTable(String db)
    【TAG】前ページで選択したデータ列の情報を次のページに渡すかどうか[true:渡す/false:渡さない]を指定します(初期値:false)。
    パラメータ:
      `db` - 選択データを渡すかどうか [true:渡す/false:渡さない]
    説明:
      ただし、１行分のデータのみです。(複数選択時は、最初の１件目) trueを指定すると、データを渡します。falseの場合は、渡しません。 初期値は、false:渡さない です。

  - ### toString

    public String toString()
    このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
    オーバーライド:
      `toString` クラス内 `CommonTagSupport`
    戻り値:
      このクラスの文字列表現
    このﾒｿｯﾄﾞは、nullを返しません