jp.co.intra_mart.foundation.mobile_fw.menu

クラス BaseSPUtilityMenuCreator

java.lang.Object

jp.co.intra_mart.foundation.mobile_fw.menu.BaseSPUtilityMenuCreator

すべての実装されたインタフェース:

SPUtilityMenuCreator

public class BaseSPUtilityMenuCreator
extends Object
implements SPUtilityMenuCreator

SP版ユーティリティメニューのメニューアイテムを生成するための基底クラスです。
このクラスを継承した場合は、各要素はxmlで設定された値を利用します。

• :メニュー名
• :パス
• :ソート数
• :メニューを表示するかどうか

独自のロジックで各要素を判定する場合は、継承先のクラスで各メソッドをオーバーライドしてください。
xmlにおいて各要素が未設定の場合は各メソッドの引数に null が渡ります。
継承先のクラスで null が返却されないようにチェックを行ってください。

バージョン:

8.0.12

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
BaseSPUtilityMenuCreator()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected String	convertName(String name) メニュー名から % を取り除き、キャプションのキー名に変換します。
String	createName(String defaultName) メニュー名を生成します。
String	createPath(String defaultPath) パスを生成します。
int	createSort(Integer defaultSort) ソート数を生成します。
boolean	createVisible(Boolean defaultVisible) メニューとして表示するかどうかを生成します。
protected boolean	isConvert(String name) メニュー名をキャプションとして変換するかどうか判定します メニュー名が % から記載されているかどうかで、キャプションなのかを判定します。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

BaseSPUtilityMenuCreator

public BaseSPUtilityMenuCreator()

メソッドの詳細

createName

public String createName(String defaultName)
                  throws SPUtilityMenuCreateException,
                         AccessSecurityException

インタフェースからコピーされた説明: SPUtilityMenuCreator

メニュー名を生成します。

定義:

createName インタフェース内 SPUtilityMenuCreator

パラメータ:

defaultName - に設定されている初期値

戻り値:

メニュー名

例外:

SPUtilityMenuCreateException - メニューの生成に失敗した場合に発生します

AccessSecurityException - メッセージの取得に失敗した場合に発生します

createPath

public String createPath(String defaultPath)
                  throws SPUtilityMenuCreateException

インタフェースからコピーされた説明: SPUtilityMenuCreator

パスを生成します。

定義:

createPath インタフェース内 SPUtilityMenuCreator

パラメータ:

defaultPath - に設定されている初期値

戻り値:

遷移先のパス

例外:

SPUtilityMenuCreateException - メニューの生成に失敗した場合に発生します

createSort

public int createSort(Integer defaultSort)
               throws SPUtilityMenuCreateException

インタフェースからコピーされた説明: SPUtilityMenuCreator

ソート数を生成します。

定義:

createSort インタフェース内 SPUtilityMenuCreator

パラメータ:

defaultSort - に設定されている初期値

戻り値:

ソート数

例外:

SPUtilityMenuCreateException - メニューの生成に失敗した場合に発生します

createVisible

public boolean createVisible(Boolean defaultVisible)
                      throws SPUtilityMenuCreateException

インタフェースからコピーされた説明: SPUtilityMenuCreator

メニューとして表示するかどうかを生成します。

定義:

createVisible インタフェース内 SPUtilityMenuCreator

パラメータ:

defaultVisible - に設定されている初期値

戻り値:

true:メニューを表示する / false:メニューを表示しない

例外:

SPUtilityMenuCreateException - メニューの生成に失敗した場合に発生します

convertName

protected String convertName(String name)

メニュー名から % を取り除き、キャプションのキー名に変換します。

パラメータ:

name - メニュー名

戻り値:

% を除去したメニュー名

isConvert

protected boolean isConvert(String name)

メニュー名をキャプションとして変換するかどうか判定します
メニュー名が % から記載されているかどうかで、キャプションなのかを判定します。
キャプションとして判定された場合のみ、MessageManager を利用してロケールに沿ったメッセージに変換します。

パラメータ:

name - メニュー名

戻り値:

true: キャプションとして判定します / false: キャプションとして判定しません。