intra-mart Accel Platform 設定ファイルリファレンス 第23版 2019-08-01

SP版ユーティリティメニュー設定

概要

SP版ユーティリティメニューの設定に関する情報を設定します。

コラム

本設定は2016 Summer(Nirvana)より使用可能となりました。
PC版のユーティリティメニューの作成に関しては「 テーマ仕様書 」-「 ユーティリティプラグイン 」を参照してください。
モジュール im_mobile_framework
フォーマットファイル(xsd) WEB-INF/schema/sp-utility-menu-config.xsd
設定場所 WEB-INF/conf/sp-utility-menu-config/{任意のファイル名}.xml

<?xml version="1.0" encoding="UTF-8"?>
<sp-utility-menu-config xmlns="http://www.intra-mart.jp/im_mobile_fw/sp-utility-menu-config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <menu>
    <name>%CAP.Z.IWP.MFW.MENU.TOPC</name>
    <path>/home/pc</path>
    <sort>100</sort>
    <visible>true</visible>
  </menu>
  <menu item-class="COPYRIGHT_CLASS">
   <sort>200</sort>
  </menu>
  <menu item-class="jp.co.intra_mart.system.mobile_fw.menu.impl.LogoutSPUtilityMenuCreator">
    <name>%CAP.Z.IWP.MFW.COMPONENTS.LOGOUT</name>
    <path>/logout</path>
    <sort>300</sort>
  </menu>
  <menu item-class="jp.co.intra_mart.system.mobile_fw.menu.impl.LoginSPUtilityMenuCreator">
    <name>%CAP.Z.IWP.MFW.COMPONENTS.LOGIN</name>
    <path>/login</path>
    <sort>300</sort>
  </menu>
  <menu item-class="jp.co.intra_mart.system.mobile_fw.menu.impl.CancelSPUtilityMenuCreator">
    <visible>true</visible>
  </menu>
</sp-utility-menu-config>

リファレンス

メニュー設定

タグ名 menu
SP版ユーティリティメニューで利用するメニューに関する情報です。

【設定項目】

<sp-utility-menu-config>
  <menu>
    ...
  </menu>
</sp-utility-menu-config>

必須項目 ×
複数設定
設定値・設定する内容 メニューの詳細設定
単位・型 なし
省略時のデフォルト値 なし
親タグ sp-utility-menu-config

【属性】

属性名 説明 必須
item-class
Javaインタフェース jp.co.intra_mart.foundation.mobile_fw,menu.SPUtilityMenuCreator を実装したクラスのFQDNを指定します。
標準で用意されているクラスは以下の通りです。
  • jp.co.intra_mart.system.mobile_fw.menu.impl.LogoutSPUtilityMenuCreator
    ログアウトに関するメニュー設定を行うクラスです。
  • jp.co.intra_mart.system.mobile_fw.menu.impl.LoginSPUtilityMenuCreator
    ログインに関するメニュー設定を行うクラスです。
  • jp.co.intra_mart.system.mobile_fw.menu.impl.CancelSPUtilityMenuCreator
    キャンセルに関するメニュー設定を行うクラスです。
×

メニュー名設定

タグ名 name
メニュー名を設定します。
先頭に%を付けた場合はメッセージキーとして解釈され、MessageManagerから表示ロケールに合わせた値を取得します。
%を付けない場合は、設定された値がメニュー名として表示されます。
【例】%CAP.Z.IWP.MFW.MENU.TOPC

【設定項目】

<sp-utility-menu-config>
  <menu>
    <name>
      ...
    </name>
  </menu>
</sp-utility-menu-config>

必須項目
×
省略する場合は、item-class属性で指定する実装クラスでメニュー名を設定する必要があります。
複数設定 ×
設定値・設定する内容 メニュー名
単位・型 文字列
省略時のデフォルト値 なし
親タグ menu

パス設定

タグ名 path
メニューに設定するパスを設定します。

【設定項目】

<sp-utility-menu-config>
  <menu>
    <path>
      ...
    </path>
  </menu>
</sp-utility-menu-config>

必須項目
×
省略する場合は、item-class属性で指定する実装クラスでパスを設定する必要があります。
複数設定 ×
設定値・設定する内容
メニューをクリックした際に遷移するパスを設定します。
コンテキストパスからの相対パスを設定してください。
単位・型 文字列
省略時のデフォルト値 なし
親タグ menu

メニューの表示/非表示設定

タグ名 visible
メニューとして表示するかどうかを設定します。

【設定項目】

<sp-utility-menu-config>
  <menu>
    <visible>
      ...
    </visible>
  </menu>
</sp-utility-menu-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
メニューとして表示するかどうかを設定します。
単位・型 Boolean
省略時のデフォルト値 true
親タグ menu

ソート設定

タグ名 sort
メニューに表示される並び順を設定します。
ソート数が等しい場合は、パス名を元に第2ソートします。

【設定項目】

<sp-utility-menu-config>
  <menu>
    <sort>
      ...
    </sort>
  </menu>
</sp-utility-menu-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
メニューに表示される並び順を設定します。
単位・型 数値
省略時のデフォルト値
2147483647(intの最大値)
親タグ menu