public class HelpTag extends CommonTagSupport
画面IDと同じヘルプファイルがあればリンクを作成するタグです(通常は 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 で、読込処理していました。
●形式:一般ユーザーが直接組み込むことはありません。 ●body:なし ●Tag定義: <og:help guiInfoKey 【TAG】GUIInfo のキーを指定します extension 【廃止】拡張子を指定します(初期値:html) lbl 【TAG】ラベルリソースのラベルIDを指定します target 【TAG】TARGET 属性を指定します(初期値:_blank) viewMsg 【TAG】メッセージを常時表示させるかどうか[true/false]を指定します(初期値:false) iconURL 【TAG】ヘルプリンクをアイコンで指定する場合のアイコンURLを指定します (初期値:DEFAULT_HELP_ICON[=/image/help.png]) faqIconURL 【TAG】FAQリンクをアイコンで指定する場合のアイコンURLを指定します (初期値:DEFAULT_FAQ_ICON[=/image/qaicon.png]) useFaq 【TAG】FAQ表示の機能を利用するかどうか[true/false]を指定します (初期値:USE_GUI_FAQ[=false]) debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) /> ●使用例 <og:help guiInfoKey="{@GUI.KEY}" lbl="HELP" /> <og:help guiInfoKey = "GUIInfo のキーを指定します(必須)。" extension = "6.3.8.4 (2015/10/09) 廃止。拡張子を指定します(初期値:html)。" lbl = "ラベルリソースのメッセージIDを指定します。" target = "TARGET 属性を指定します(初期値:_blank)。" viewMsg = "メッセージを常時表示させるかどうか[true/false]を指定します(初期値:false)。" iconURL = "ヘルプアイコンのURL(初期値:/image/help.png)"; // 5.3.8.0 (2011/08/01) />
BR, BUFFER_MIDDLE, CR
bodyContent
id, pageContext
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
EVAL_BODY_AGAIN
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
コンストラクタと説明 |
---|
HelpTag()
デフォルトコンストラクター
|
修飾子とタイプ | メソッドと説明 |
---|---|
int |
doEndTag()
Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
|
protected void |
release2()
タグリブオブジェクトをリリースします。
|
void |
setExtension(java.lang.String ext)
【廃止】拡張子を指定します(初期値:html)。
|
void |
setFaqIconURL(java.lang.String url)
【TAG】FAQリンクをアイコンで指定する場合のアイコンURLを指定します
(初期値:DEFAULT_FAQ_ICON[=/image/qaicon.png])。
|
void |
setGuiInfoKey(java.lang.String key)
【TAG】GUIInfo のキーを指定します。
|
void |
setIconURL(java.lang.String url)
【TAG】ヘルプリンクをアイコンで指定する場合のアイコンURLを指定します
(初期値:DEFAULT_HELP_ICON[=/image/help.png])。
|
void |
setTarget(java.lang.String val)
【TAG】TARGET 属性を指定します(初期値:_blank)。
|
void |
setUseFaq(java.lang.String flag)
【TAG】FAQ表示の機能を利用するかどうか[true/false]を指定します
(初期値:USE_GUI_FAQ[=false])。
|
void |
setUseFaqCtrl(java.lang.String flag)
【TAG】FAQに関連画面機能を利用するかどうか[true/false]を指定します
(初期値:USE_GUI_FAQ_CTRL[=true])。
|
void |
setViewMsg(java.lang.String flag)
【TAG】メッセージを常時表示させるかどうか[true/false]を指定します(初期値:false)。
|
java.lang.String |
toString()
このオブジェクトの文字列表現を返します。
|
add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, doStartTag, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getCommonTagThrowable, getContextAttribute, getContextPath, getCookie, getCSVParameter, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLASTAttri, getLongLabel, getMsg, getMsglbl, getNVLAttri, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getSumRequestValue, 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
doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getParent, setPageContext, setParent
public HelpTag()
6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor. |
public int 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メソッドに変更する。 |
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 廃止。 |
public void setGuiInfoKey(java.lang.String key)
key
- GUIInfoのキーGUIInfo のキーを指定します。
public void setExtension(java.lang.String ext)
ext
- 拡張子なにも設定されていない場合は、"html" が初期値となります。 ここでは、ピリオドは、含める必要はありません。
6.3.8.4 (2015/10/09) 廃止。 フォルダをスキャンして、必要なHelpファイルを見つけるため、 拡張子を指示する必要がなくなりました。 |
public void setTarget(java.lang.String val)
val
- TARGET属性(初期値:"_blank")初期値は、 "_blank" として、新規に画面を立ち上げます。 CONTENTS 等を指定すれば、コンテンツフレーム(メニューの右側全面)に、 RESULT を指定すれば、リザルトフレーム(メニュー右下側)に表示します。
3.0.0.3 (2003/02/21) ターゲット属性の新規追加 |
public void setViewMsg(java.lang.String flag)
flag
- メッセージ常時表示 [true:常時表示/false:非表示]"true"の場合は、常時表示させます。 ファイルが、存在した場合は、リンクが張られ、存在しない場合は、リンクが 張られません。 "false" の場合は、ファイルが、存在した場合は、リンクが張られ、存在しない場合は、 なにも表示されません。 初期値は、 "false"(メッセージを常時表示しない)です。
3.0.0.3 (2003/02/21) メッセージ表示属性の新規追加 |
public void setIconURL(java.lang.String url)
url
- アイコンURLSystemData.DEFAULT_HELP_ICON
ヘルプリンクをアイコンで指定する場合、そのアイコン画像のURLを指定します。 URLは、/[CONTEXT_PATH]/jspを基準として指定します。 例) /ge/jsp/image/help.pngに存在する画像を指定する場合、iconURL=/image/help.pngを指定します。 このURLが指定されない場合、ヘルプリンクは、msgLbl属性で指定されたテキストで表示されます。 (初期値:システム定数のDEFAULT_HELP_ICON[=/image/help.png])。
5.3.8.0 (2011/08/01) 新規追加 |
public void setFaqIconURL(java.lang.String url)
url
- アイコンURLSystemData.DEFAULT_FAQ_ICON
FAQリンクをアイコンで指定する場合、そのアイコン画像のURLを指定します。 URLは、/[CONTEXT_PATH]/jspを基準として指定します。 例) /ge/jsp/image/help.pngに存在する画像を指定する場合、iconURL=/image/help.pngを指定します。 (初期値:システム定数のDEFAULT_FAQ_ICON[=/image/qaicon.png])。
5.3.8.0 (2011/08/01) 新規追加 |
public void setUseFaq(java.lang.String flag)
flag
- FAQ表示利用 [true:利用する/false:利用しない]SystemData.USE_GUI_FAQ
,
setUseFaqCtrl( String )
trueを指定すると、FAQ画面へのリンクが表示されます。(GE80にデータが存在するかは無関係) リンク先はfaqGUIでセットした画面に対して画面IDを引数としてわたします。 (初期値:システム定数のUSE_GUI_FAQ[=false])。
5.5.0.4 (2012/03/167) 新規追加 |
public void setUseFaqCtrl(java.lang.String flag)
flag
- FAQの存在チェック機能 [true:利用する/false:利用しない]SystemData.USE_GUI_FAQ_CTRL
,
setUseFaq( String )
trueを指定すると、GE80にデータが関連画面IDとして存在する場合のみアイコンを リンク先はfaqGUIでセットした画面に対して画面IDを引数として渡します。 falseの場合は、瀬音z内チェックを行わないため、常に表示されます。 (ただし、useFaq=true の場合のみ) (初期値:システム定数のUSE_GUI_FAQ[=false])。
5.6.4.3 (2013/05/24) 新規追加 |
public java.lang.String toString()
toString
クラス内 CommonTagSupport
Webアプリケーションフレームワーク openGionCopyright (c) 2009 The openGion Project.