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

クラス HelpTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
jakarta.servlet.jsp.tagext.BodyTagSupport
org.opengion.hayabusa.taglib.CommonTagSupport
org.opengion.hayabusa.taglib.HelpTag
すべての実装されたインタフェース:
BodyTag, IterationTag, JspTag, Tag, TryCatchFinally, Serializable
public class HelpTag extends CommonTagSupport
画面ＩＤと同じヘルプファイルがあればリンクを作成するタグです(通常は query.jsp に組込み)。 ヘルプファイルは、システムパラメータ の HELP_URL で定義されているhelpフォルダに配置します。 このフォルダに、画面IDと同じファイル(例えば、GE0001.html など)があれば、リンクを作成します。 ファイルがなければ、リンクは表示されません。 メッセージの表示の制御は、viewMsg 属性で指定します。(false でファイルが存在した場合のみ表示) ファイルの拡張子も指定できますが、一般に、html でヘルプファイルを作成するほうが すばやく表示できます。 ※ 6.3.8.4 (2015/10/09) topMenuタグ内のhelpタグ機能 廃止 また、og:topMenuタグ内にこのタグを記述することで、各画面分類に対するヘルプを表示することが できるようになります。 (この場合も、画面分類のキーがヘルプファイルのキーになります) ※ 6.3.8.4 (2015/10/09) ヘルプファイルと、GE80(FAQﾃｰﾌﾞﾙ)の関連画面IDについて、先に検索してMapにセットする方法に変更します。 従来は、ヘルプファイルは都度、GE80(FAQﾃｰﾌﾞﾙ)は、org.opengion.hayabusa.resource.GUIDataLoader で、読込処理していました。
関連項目:
変更履歴:
7.3.2.3 (2021/04/09) ｼｽﾃﾑ定数のICON_DIRを使用します。
機能分類
メニュー制御
形式ｻﾝﾌﾟﾙ:
●形式：一般ユーザーが直接組み込むことはありません。 ●body：なし ●Tag定義： <og:help guiInfoKey 【TAG】GUIInfo のキーを指定します lbl 【TAG】ラベルリソースのラベルIDを指定します target 【TAG】TARGET 属性を指定します(初期値:_blank) viewMsg 【TAG】メッセージを常時表示させるかどうか[true/false]を指定します(初期値:false) iconURL 【TAG】ヘルプリンクをアイコンで指定する場合のアイコンURLを指定します (初期値:DEFAULT_HELP_ICON[=/icon/help.png]) faqIconURL 【TAG】FAQリンクをアイコンで指定する場合のアイコンURLを指定します (初期値:DEFAULT_FAQ_ICON[=/icon/qaicon.png]) useFaq 【TAG】FAQ表示の機能を利用するかどうか[true/false]を指定します (初期値:USE_GUI_FAQ[=false]) debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) /> 【廃止】6.3.8.4 (2015/10/09) 物理削除 // extension 【廃止】拡張子を指定します(初期値:html) 6.3.8.4 (2015/10/09) 廃止 ●使用例 <og:help guiInfoKey="{@GUI.KEY}" lbl="HELP" /> <og:help guiInfoKey = "GUIInfo のキーを指定します(必須)。" lbl = "ラベルリソースのメッセージIDを指定します。" target = "TARGET 属性を指定します(初期値:_blank)。" viewMsg = "メッセージを常時表示させるかどうか[true/false]を指定します(初期値:false)。" iconURL = "ヘルプアイコンのURL(初期値:/icon/help.png)"; // 5.3.8.0 (2011/08/01) />
導入されたバージョン:
JDK5.0,

  • コンストラクタの詳細

    • HelpTag

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

  • メソッドの詳細

    • doEndTag

      public int doEndTag()
      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
      doEndTag インタフェース内 Tag
      オーバーライド:
      doEndTag クラス内 CommonTagSupport
      戻り値:
      後続処理の指示
      変更履歴:
      3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 5.3.9.0 (2011/09/01) メニューでのヘルプアイコン対応, 5.5.0.4 (2012/03/16) FAQ対応, 5.6.4.3 (2013/05/26) FAQの画面別対応, 6.3.8.4 (2015/10/09) topMenu 内でのHelp機能を廃止します。, 6.3.9.0 (2015/11/06) helpMapの初期化を、initメソッドに変更する。

    • release2

      protected void release2()
      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
      release2 クラス内 CommonTagSupport
      変更履歴:
      2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加, 3.0.0.3 (2003/02/21) ターゲット属性の新規追加他, 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 3.6.0.7 (2004/11/06) target 属性の初期値を _new から _blank に変更, 5.3.8.0 (2011/08/01) iconURL追加, 5.5.0.4 (2012/03/16) faq, 5.6.4.3 (2013/05/24) faqCtrl, 5.6.7.3 (2013/08/23) useFaq と useFaqCtrl のキーの後ろにスペースが入っていた。, 6.3.8.4 (2015/10/09) extension 廃止。, 6.9.5.0 (2018/04/23) useFaq 初期値固定、useFaqCtrl 廃止。, 7.3.2.3 (2021/04/09) ｼｽﾃﾑ定数のICON_DIRを使用します。, 8.1.0.2 (2022/01/14) faqGUI にICON_DIRを間違って付けていたので元に戻す。

    • setGuiInfoKey

      public void setGuiInfoKey(String key)
      【TAG】GUIInfo のキーを指定します。
      パラメータ:
      key - GUIInfoのキー
      説明:
      GUIInfo のキーを指定します。

    • setTarget

      public void setTarget(String val)
      【TAG】TARGET 属性を指定します(初期値:_blank)。
      パラメータ:
      val - TARGET属性(初期値:"_blank")
      変更履歴:
      3.0.0.3 (2003/02/21) ターゲット属性の新規追加
      説明:
      初期値は、 "_blank" として、新規に画面を立ち上げます。 CONTENTS 等を指定すれば、コンテンツフレーム(メニューの右側全面)に、 RESULT を指定すれば、リザルトフレーム(メニュー右下側)に表示します。

    • setViewMsg

      public void setViewMsg(String flag)
      【TAG】メッセージを常時表示させるかどうか[true/false]を指定します(初期値:false)。
      パラメータ:
      flag - メッセージ常時表示 [true:常時表示/false:非表示]
      変更履歴:
      3.0.0.3 (2003/02/21) メッセージ表示属性の新規追加
      説明:
      "true"の場合は、常時表示させます。 ファイルが、存在した場合は、リンクが張られ、存在しない場合は、リンクが 張られません。 "false" の場合は、ファイルが、存在した場合は、リンクが張られ、存在しない場合は、 なにも表示されません。 初期値は、"false"(メッセージを常時表示しない)です。

    • setIconURL

      public void setIconURL(String url)
      【TAG】ヘルプリンクをアイコンで指定する場合のアイコンURLを指定します (初期値:DEFAULT_HELP_ICON[=])。
      パラメータ:
      url - アイコンURL
      関連項目:
      変更履歴:
      5.3.8.0 (2011/08/01) 新規追加, 7.3.2.3 (2021/04/09) ｼｽﾃﾑ定数のICON_DIRを使用します。
      説明:
      ヘルプリンクをアイコンで指定する場合、そのアイコン画像のURLを指定します。 URLは、/[CONTEXT_PATH]/jspを基準として指定します。 // * 例) /ge/jsp/image/help.pngに存在する画像を指定する場合、iconURL=/image/help.pngを指定します。 例) /ge/jsp/icon/help.pngに存在する画像を指定する場合、iconURL=/icon/help.pngを指定します。 このURLが指定されない場合、ヘルプリンクは、msgLbl属性で指定されたテキストで表示されます。 (初期値:システム定数のDEFAULT_HELP_ICON[=])。

    • setFaqIconURL

      public void setFaqIconURL(String url)
      【TAG】FAQリンクをアイコンで指定する場合のアイコンURLを指定します (初期値:DEFAULT_FAQ_ICON[=])。
      パラメータ:
      url - アイコンURL
      関連項目:
      変更履歴:
      5.3.8.0 (2011/08/01) 新規追加, 7.3.2.3 (2021/04/09) ｼｽﾃﾑ定数のICON_DIRを使用します。
      説明:
      FAQリンクをアイコンで指定する場合、そのアイコン画像のURLを指定します。 URLは、/[CONTEXT_PATH]/jspを基準として指定します。 // * 例) /ge/jsp/image/help.pngに存在する画像を指定する場合、iconURL=/image/help.pngを指定します。 例) /ge/jsp/icon/help.pngに存在する画像を指定する場合、iconURL=/icon/help.pngを指定します。 (初期値:システム定数のDEFAULT_FAQ_ICON[=])。

    • setUseFaq

      public void setUseFaq(String flag)
      【TAG】FAQ表示の機能を利用するかどうか[true/false]を指定します(初期値:false)。
      パラメータ:
      flag - FAQ表示利用 [true:利用する/false:利用しない]
      変更履歴:
      5.5.0.4 (2012/03/16) 新規追加, 6.9.5.0 (2018/04/23) 初期値固定
      説明:
      trueを指定すると、FAQ画面へのリンクが表示されます。(GE80にデータが存在するかは無関係) リンク先はfaqGUIでセットした画面に対して画面IDを引数としてわたします。 (初期値:false)。

    • toString

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