jp.co.intra_mart.foundation.ui.tags.theme

インタフェース UtilityItemProvider

既知の実装クラスのリスト:

jp.co.intra_mart.foundation.ui.tags.theme.utility.AbstractUtilityItemProvider, ChangeToSPItemProvider

public interface UtilityItemProvider

ユーザユーティリティをクリックしたときに表示されるドロップダウンメニューの内容を提供します。

バージョン:

8.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
List<UtilityItemProvider>	getChildren() 子供の要素をリストとして返します。
String	getLabel() ドロップダウンメニューに表示するラベルを返します。
String	getUrl() クリックしたときの遷移先 URL を返します。
boolean	isVisible() この UtilitiItemProvider をユーザユーティリティに表示するかどうかを返します。
String	scriptSource() 外部 JavaScript のパスを返します。
String	toListString() この UtilityItemProvider の HTML 表現を返します。

メソッドの詳細

getChildren

List<UtilityItemProvider> getChildren()
                               throws javax.servlet.jsp.JspException

子供の要素をリストとして返します。 表示上は、ドロップダウンメニューのサブメニューとなります。

戻り値:

子供の要素

例外:

javax.servlet.jsp.JspException - 子供の要素の取得に失敗した

getLabel

String getLabel()
         throws javax.servlet.jsp.JspException

ドロップダウンメニューに表示するラベルを返します。

戻り値:

ドロップダウンメニューに表示するラベル

例外:

javax.servlet.jsp.JspException - ラベルの取得に失敗した

getUrl

String getUrl()
       throws javax.servlet.jsp.JspException

クリックしたときの遷移先 URL を返します。

戻り値:

遷移先 URL

例外:

javax.servlet.jsp.JspException - 遷移先 URL の取得に失敗した

isVisible

boolean isVisible()
           throws javax.servlet.jsp.JspException

この UtilitiItemProvider をユーザユーティリティに表示するかどうかを返します。

戻り値:

表示する場合は true、表示しない場合は false

例外:

javax.servlet.jsp.JspException - 表示するかどうかを決定するのに失敗した

scriptSource

String scriptSource()

外部 JavaScript のパスを返します。 ここで返すパスは script タグの src 属性に指定され、head タグの中に展開されます。

戻り値:

外部 JavaScript のパス

toListString

String toListString()
             throws javax.servlet.jsp.JspException

この UtilityItemProvider の HTML 表現を返します。

通常 ul タグとして返すことになります。

戻り値:

HTML 表現

例外:

javax.servlet.jsp.JspException - HTML 表現の生成に失敗した