org.opengion.hayabusa.taglib
クラス HelpTag
java.lang.Object
javax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.tagext.BodyTagSupport
org.opengion.hayabusa.taglib.CommonTagSupport
org.opengion.hayabusa.taglib.HelpTag
- すべての実装されたインタフェース:
- java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally
public class HelpTag
- extends CommonTagSupport
画面IDと同じヘルプファイルがあればリンクを作成するタグです(通常は query.jsp に組込み)。
ヘルプファイルは、システムパラメータ の HELP_URL で定義されているhelpフォルダに配置します。
このフォルダに、画面IDと同じファイル(例えば、GE0001.html など)があれば、リンクを作成します。
ファイルがなければ、リンクは表示されません。
メッセージの表示の制御は、viewMsg 属性で指定します。(false でファイルが存在した場合のみ表示)
ファイルの拡張子も指定できますが、一般に、html でヘルプファイルを作成するほうが
すばやく表示できます。
また、og:topMenuタグ内にこのタグを記述することで、各画面分類に対するヘルプを表示することが
できるようになります。
(この場合も、画面分類のキーがヘルプファイルのキーになります)
- 関連項目:
- 直列化された形式
- 形式サンプル:
●形式:一般ユーザーが直接組み込むことはありません。
●body:なし
●使用例
<og:help guiInfoKey="{@GUI.KEY}" msg="HELP" />
<og:help
guiInfoKey = "GUIInfo のキーを指定します。(必須)"
extension = "拡張子を指定します(初期値:html)。"
msg = "メッセージリソースのメッセージIDを指定します。"
target = "TARGET 属性を指定します(初期値:_blank)。"
viewMsg = "メッセージを常時表示させるかどうか(true/false)を指定します(初期値:false)。"
iconURL = "ヘルプアイコンのURL(初期値:/image/help.png)"; // 5.3.8.0 (2011/08/01)
/>
- 機能階層
- メニュー制御
- バージョン
- 4.0
- 作成者
- Kazuhiko Hasegawa
- 導入されたバージョン:
- JDK5.0,
クラス javax.servlet.jsp.tagext.BodyTagSupport から継承されたフィールド |
bodyContent |
クラス javax.servlet.jsp.tagext.TagSupport から継承されたフィールド |
id, pageContext |
インタフェース javax.servlet.jsp.tagext.BodyTag から継承されたフィールド |
EVAL_BODY_BUFFERED, EVAL_BODY_TAG |
インタフェース javax.servlet.jsp.tagext.IterationTag から継承されたフィールド |
EVAL_BODY_AGAIN |
インタフェース javax.servlet.jsp.tagext.Tag から継承されたフィールド |
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
メソッドの概要 |
int |
doEndTag()
Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。 |
protected java.lang.String |
makeTag()
HELPリンクを作成します。 |
protected java.lang.String |
makeTagFaq()
FAQリンクを作成します。 |
protected void |
release2()
タグリブオブジェクトをリリースします。 |
void |
setExtension(java.lang.String ext)
【TAG】拡張子を指定します(初期値:html)。 |
void |
setFaqIconURL(java.lang.String url)
【TAG】FAQリンクをアイコンで指定する場合のアイコンURLを指定します。 |
void |
setGuiInfoKey(java.lang.String key)
【TAG】GUIInfo のキーを指定します。 |
void |
setIconURL(java.lang.String url)
【TAG】ヘルプリンクをアイコンで指定する場合のアイコンURLを指定します。 |
void |
setTarget(java.lang.String val)
【TAG】TARGET 属性を指定します(初期値:_blank)。 |
void |
setUseFaq(java.lang.String flag)
【TAG】FAQ表示の機能を利用するか指定します。 |
void |
setViewMsg(java.lang.String flag)
【TAG】メッセージを常時表示させるかどうか(true/false)を指定します(初期値:false)。 |
java.lang.String |
toString()
このオブジェクトの文字列表現を返します。 |
クラス org.opengion.hayabusa.taglib.CommonTagSupport から継承されたメソッド |
add, add, addEventColumn, addEventColumn, check, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, doStartTag, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getLabel, getLabelInterface, getLanguage, getLongLabel, getMsglbl, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getTagName, getUser, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseKey, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, useMainTrans, useQuotCheck, useTag, useXssCheck |
クラス javax.servlet.jsp.tagext.BodyTagSupport から継承されたメソッド |
doInitBody, getBodyContent, getPreviousOut, release, setBodyContent |
クラス javax.servlet.jsp.tagext.TagSupport から継承されたメソッド |
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue |
クラス java.lang.Object から継承されたメソッド |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
インタフェース javax.servlet.jsp.tagext.Tag から継承されたメソッド |
getParent, setPageContext, setParent |
HelpTag
public HelpTag()
doEndTag
public int doEndTag()
- Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
- 定義:
- インタフェース
javax.servlet.jsp.tagext.Tag
内の doEndTag
- オーバーライド:
- クラス
CommonTagSupport
内の doEndTag
- 戻り値:
- int 後続処理の指示
- 変更履歴:
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対応 |
release2
protected void release2()
- タグリブオブジェクトをリリースします。
キャッシュされて再利用されるので、フィールドの初期設定を行います。
- オーバーライド:
- クラス
CommonTagSupport
内の release2
- 変更履歴:
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 |
makeTag
protected java.lang.String makeTag()
- HELPリンクを作成します。
- 戻り値:
- リンクタグ文字列
- 変更履歴:
3.0.0.3 (2003/02/21) ターゲット属性の新規追加 |
3.0.1.0 (2003/03/03) viewMsg フラグの制御のバグ修正 |
5.3.8.0 (2011/08/01) iconURL対応 |
5.3.9.0 (2011/09/01) メニューでのヘルプアイコン対応 |
5.5.0.4 (2012/03/16) faq |
makeTagFaq
protected java.lang.String makeTagFaq()
- FAQリンクを作成します。
- 戻り値:
- リンクタグ文字列
- 変更履歴:
5.3.9.0 (2011/09/01) メニューでのヘルプアイコン対応 |
setGuiInfoKey
public void setGuiInfoKey(java.lang.String key)
- 【TAG】GUIInfo のキーを指定します。
- パラメータ:
key
- String- 説明:
GUIInfo のキーを指定します。
setExtension
public void setExtension(java.lang.String ext)
- 【TAG】拡張子を指定します(初期値:html)。
- パラメータ:
ext
- 拡張子- 説明:
なにも設定されていない場合は、"html" が初期値となります。
ここでは、ピリオドは、含める必要はありません。
setTarget
public void setTarget(java.lang.String val)
- 【TAG】TARGET 属性を指定します(初期値:_blank)。
- パラメータ:
val
- TARGET 属性を指定します(初期値 "_blank")- 説明:
初期値は、 "_blank" として、新規に画面を立ち上げます。
CONTENTS 等を指定すれば、コンテンツフレーム(メニューの右側全面)に、
RESULT を指定すれば、リザルトフレーム(メニュー右下側)に表示します。
- 変更履歴:
3.0.0.3 (2003/02/21) ターゲット属性の新規追加 |
setViewMsg
public void setViewMsg(java.lang.String flag)
- 【TAG】メッセージを常時表示させるかどうか(true/false)を指定します(初期値:false)。
- パラメータ:
flag
- メッセージを常時表示させるかどうかを指定( true:常時表示/false:非表示 )- 説明:
"true"の場合は、常時表示させます。
ファイルが、存在した場合は、リンクが張られ、存在しない場合は、リンクが
張られません。
"false" の場合は、ファイルが、存在した場合は、リンクが張られ、存在しない場合は、
なにも表示されません。
初期値は、 "false"(メッセージを常時表示しない)です。
- 変更履歴:
3.0.0.3 (2003/02/21) メッセージ表示属性の新規追加 |
setIconURL
public void setIconURL(java.lang.String url)
- 【TAG】ヘルプリンクをアイコンで指定する場合のアイコンURLを指定します。(初期値:DEFAULT_HELP_ICON)。
- パラメータ:
url
- アイコンURL- 説明:
ヘルプリンクをアイコンで指定する場合、そのアイコン画像のURLを指定します。
URLは、/[CONTEXT_PATH]/jspを基準として指定します。
例) /ge/jsp/image/help.pngに存在する画像を指定する場合、iconURL=/image/help.pngを指定します。
このURLが指定されない場合、ヘルプリンクは、msgLbl属性で指定されたテキストで表示されます。
- 変更履歴:
5.3.8.0 (2011/08/01) 新規追加 |
setFaqIconURL
public void setFaqIconURL(java.lang.String url)
- 【TAG】FAQリンクをアイコンで指定する場合のアイコンURLを指定します。(初期値:DEFAULT_FAQ_ICON)。
- パラメータ:
url
- アイコンURL- 説明:
FAQリンクをアイコンで指定する場合、そのアイコン画像のURLを指定します。
URLは、/[CONTEXT_PATH]/jspを基準として指定します。
例) /ge/jsp/image/help.pngに存在する画像を指定する場合、iconURL=/image/help.pngを指定します。
- 変更履歴:
5.3.8.0 (2011/08/01) 新規追加 |
setUseFaq
public void setUseFaq(java.lang.String flag)
- 【TAG】FAQ表示の機能を利用するか指定します。初期値:USE_GUI_FAQ
- パラメータ:
flag
- - 説明:
trueを指定すると、FAQ画面へのリンクが表示されます。(GE80にデータが存在するかは無関係)
リンク先はfaqGUIでセットした画面に対して画面IDを引数としてわたします。
- 変更履歴:
5.5.0.4 (2012/03/167) 新規追加 |
toString
public java.lang.String toString()
- このオブジェクトの文字列表現を返します。
基本的にデバッグ目的に使用します。
- オーバーライド:
- クラス
CommonTagSupport
内の toString
- 戻り値:
- このクラスの文字列表現
Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.