|
|
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectjavax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.tagext.BodyTagSupport
org.opengion.hayabusa.taglib.CommonTagSupport
org.opengion.hayabusa.taglib.HelpTag
public class HelpTag
画面IDと同じヘルプファイルがあればリンクを作成するタグです(通常は query.jsp に組込み)。 ヘルプファイルは、システムパラメータ の HELP_URL で定義されているhelpフォルダに配置します。 このフォルダに、画面IDと同じファイル(例えば、GE0001.html など)があれば、リンクを作成します。 ファイルがなければ、リンクは表示されません。 メッセージの表示の制御は、viewMsg 属性で指定します。(false でファイルが存在した場合のみ表示) ファイルの拡張子も指定できますが、一般に、html でヘルプファイルを作成するほうが すばやく表示できます。 また、og:topMenuタグ内にこのタグを記述することで、各画面分類に対するヘルプを表示することが できるようになります。 (この場合も、画面分類のキーがヘルプファイルのキーになります)
●形式:一般ユーザーが直接組み込むことはありません。 ●body:なし ●Tag定義: <og:help guiInfoKey 【TAG】GUIInfo のキーを指定します extension 【TAG】拡張子を指定します(初期値:html) lbl 【TAG】ラベルリソースのラベルIDを指定します target 【TAG】TARGET 属性を指定します(初期値:_blank) viewMsg 【TAG】メッセージを常時表示させるかどうか[true/false]を指定します(初期値:false) iconURL 【TAG】ヘルプリンクをアイコンで指定する場合のアイコンURLを指定します (初期値:DEFAULT_HELP_ICON[=/image/help2.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 = "拡張子を指定します(初期値:html)。" lbl = "ラベルリソースのメッセージIDを指定します。" target = "TARGET 属性を指定します(初期値:_blank)。" viewMsg = "メッセージを常時表示させるかどうか[true/false]を指定します(初期値:false)。" iconURL = "ヘルプアイコンのURL(初期値:/image/help.png)"; // 5.3.8.0 (2011/08/01) />
フィールドの概要 |
---|
クラス 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 |
コンストラクタの概要 | |
---|---|
HelpTag()
|
メソッドの概要 | |
---|---|
int |
doEndTag()
Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。 |
protected String |
makeTag()
HELPリンクを作成します。 |
protected String |
makeTagFaq()
FAQリンクを作成します。 |
protected void |
release2()
タグリブオブジェクトをリリースします。 |
void |
setExtension(String ext)
【TAG】拡張子を指定します(初期値:html)。 |
void |
setFaqIconURL(String url)
【TAG】FAQリンクをアイコンで指定する場合のアイコンURLを指定します (初期値:DEFAULT_FAQ_ICON[=/image/qaicon.png])。 |
void |
setGuiInfoKey(String key)
【TAG】GUIInfo のキーを指定します。 |
void |
setIconURL(String url)
【TAG】ヘルプリンクをアイコンで指定する場合のアイコンURLを指定します (初期値:DEFAULT_HELP_ICON[=/image/help2.png])。 |
void |
setTarget(String val)
【TAG】TARGET 属性を指定します(初期値:_blank)。 |
void |
setUseFaq(String flag)
【TAG】FAQ表示の機能を利用するかどうか[true/false]を指定します (初期値:USE_GUI_FAQ[=false])。 |
void |
setUseFaqCtrl(String flag)
【TAG】FAQに関連画面機能を利用するかどうか[true/false]を指定します。 |
void |
setViewMsg(String flag)
【TAG】メッセージを常時表示させるかどうか[true/false]を指定します(初期値:false)。 |
String |
toString()
このオブジェクトの文字列表現を返します。 |
クラス 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 |
コンストラクタの詳細 |
---|
public HelpTag()
メソッドの詳細 |
---|
public int doEndTag()
Tag
内の doEndTag
CommonTagSupport
内の doEndTag
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の画面別対応 |
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 |
5.6.4.3 (2013/05/24) faqCtrl |
5.6.7.3 (2013/08/23) useFaq と useFaqCtrl のキーの後ろにスペースが入っていた。 |
protected String makeTag()
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 |
protected String makeTagFaq()
5.3.9.0 (2011/09/01) メニューでのヘルプアイコン対応 |
5.6.4.3 (2013/05/24) FAQ存在チェック対応 |
public void setGuiInfoKey(String key)
key
- GUIInfo のキーGUIInfo のキーを指定します。
public void setExtension(String ext)
ext
- 拡張子なにも設定されていない場合は、"html" が初期値となります。 ここでは、ピリオドは、含める必要はありません。
public void setTarget(String val)
val
- TARGET 属性を指定します(初期値:"_blank")初期値は、 "_blank" として、新規に画面を立ち上げます。 CONTENTS 等を指定すれば、コンテンツフレーム(メニューの右側全面)に、 RESULT を指定すれば、リザルトフレーム(メニュー右下側)に表示します。
3.0.0.3 (2003/02/21) ターゲット属性の新規追加 |
public void setViewMsg(String flag)
flag
- メッセージを常時表示させるかどうかを指定 [true:常時表示/false:非表示]"true"の場合は、常時表示させます。 ファイルが、存在した場合は、リンクが張られ、存在しない場合は、リンクが 張られません。 "false" の場合は、ファイルが、存在した場合は、リンクが張られ、存在しない場合は、 なにも表示されません。 初期値は、 "false"(メッセージを常時表示しない)です。
3.0.0.3 (2003/02/21) メッセージ表示属性の新規追加 |
public void setIconURL(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[={@og.value org.opengion.hayabusa.common.SystemData#DEFAULT_HELP_ICON}])。
5.3.8.0 (2011/08/01) 新規追加 |
public void setFaqIconURL(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[={@og.value org.opengion.hayabusa.common.SystemData#DEFAULT_FAQ_ICON}])。
5.3.8.0 (2011/08/01) 新規追加 |
public void setUseFaq(String flag)
flag
- FAQ表示の機能を利用するかどうか [true:利用する/false:利用しない]SystemData.USE_GUI_FAQ
trueを指定すると、FAQ画面へのリンクが表示されます。(GE80にデータが存在するかは無関係) リンク先はfaqGUIでセットした画面に対して画面IDを引数としてわたします。 (初期値:システム定数のUSE_GUI_FAQ[={@og.value org.opengion.hayabusa.common.SystemData#USE_GUI_FAQ}])。
5.5.0.4 (2012/03/167) 新規追加 |
public void setUseFaqCtrl(String flag)
flag
- FAQの存在チェック機能を利用するかどうか [true:利用する/false:利用しない]SystemData.USE_GUI_FAQ_CTRL
trueを指定すると、GE80にデータが関連画面IDとして存在する場合のみアイコンを リンク先はfaqGUIでセットした画面に対して画面IDを引数としてわたします。 (初期値:システム定数のUSE_GUI_FAQ[={@og.value org.opengion.hayabusa.common.SystemData#USE_GUI_FAQ}])。
5.6.4.3 (2013/05/24) 新規追加 |
public String toString()
CommonTagSupport
内の toString
|
openGion 5.8.4.0 | ||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |