SheetDetailScreen
SheetDetailScreen クラスはに対して操作を行うためのメンバーを持っています。
インスタンスメソッド
onRepresentativeItemAreaMounted
RepresentativeItemAreaインスタンスが初期化されたタイミングで関数を実行するeventHookを登録します。
構文
onRepresentativeItemAreaMounted(callback);
onRepresentativeItemAreaMounted(callback, group);
引数
callback
RepresentativeItemAreaインスタンスが初期化されたタイミングで実行する関数です。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
登録したeventHookを解除する関数を返します。
例
esmJSPlugin.screen
.sheetDetail("customer")
.onRepresentativeItemAreaMounted(function (screen) {
const representativeItemArea = screen.getRepresentativeItemArea();
representativeItemArea.setBackgroundColor("red"); // 赤色になります
});
onBasicItemAreaMounted
BasicItemAreaインスタンスが初期化されたタイミングで関数を実行するeventHookを登録します。
構文
onBasicItemAreaMounted(callback);
onBasicItemAreaMounted(callback, group);
引数
callback
BasicItemAreaインスタンスが初期化されたタイミングで実行する関数です。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
登録したeventHookを解除する関数を返します。
例
esmJSPlugin.screen.sheetDetail("customer").onBasicItemAreaMounted(function (screen) {
const basicItemArea = screen.getBasicItemArea();
basicItemArea.setBackgroundColor("red"); // 赤色になります
});
onSheetItemsMounted
代表項目と基本情報項目の両方が初期化されたタイミングで関数を実行するeventHookを登録します。
getSheetItemsの返値であるSheetItemsインスタンスのonMountedと同等です。
構文
onSheetItemsMounted(callback);
onSheetItemsMounted(callback, group);
引数
callback
代表項目と基本情報項目の両方が初期化されたタイミングで実行する関数です。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
登録したeventHookを解除する関数を返します。
例
esmJSPlugin.screen
.sheetDetail("customer")
.onSheetItemsMounted(function (screen) {
const sheetItems = screen.getSheetItems();
console.log(sheetItems.length); // 配置されているシート項目の個数を出力
});
onSheetItemsUpdated
表示項目が変更されたタイミングが関数を実行するeventHookを登録します。
getSheetItemsの返値であるSheetItemsインスタンスのonUpdatedと同等です。
構文
onSheetItemsUpdated(callback);
onSheetItemsUpdated(callback, group);
引数
callback
表示項目が変更されたタイミングで実行する関数です。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
登録したeventHookを解除する関数を返します。
例
esmJSPlugin.screen
.sheetDetail("customer")
.onSheetItemsUpdated(function (screen) {
const sheetItems = screen.getSheetItems();
console.log(sheetItems.length); // 配置されているシート項目の個数を出力
});
onRepresentativeSheetItemsMounted
代表項目が初期化されたタイミングで関数を実行するeventHookを登録します。
getRepresentativeSheetItemsの返値であるSheetItemsインスタンスのonMountedと同等です。
構文
onRepresentativeSheetItemsMounted(callback);
onRepresentativeSheetItemsMounted(callback, group);
引数
callback
代表項目が初期化されたタイミングで実行する関数です。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
登録したeventHookを解除する関数を返します。
例
esmJSPlugin.screen
.sheetDetail("customer")
.onRepresentativeSheetItemsMounted(function (screen) {
const representativeSheetItems = screen.getRepresentativeSheetItems();
console.log(representativeSheetItems.length); // 代表項目エリアに配置されているシート項目の個数を出力
});
onRepresentativeSheetItemsUpdated
代表項目エリアの表示項目が変更されたタイミングが関数を実行するeventHookを登録します。
getRepresentativeSheetItemsの返値であるSheetItemsインスタンスのonUpdatedと同等です。
構文
onRepresentativeSheetItemsUpdated(callback);
onRepresentativeSheetItemsUpdated(callback, group);
引数
callback
代表項目エリアの表示項目が変更されたタイミングで実行する関数です。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
登録したeventHookを解除する関数を返します。
例
esmJSPlugin.screen
.sheetDetail("customer")
.onRepresentativeSheetItemsUpdated(function (screen) {
const representativeSheetItems = screen.getRepresentativeSheetItems();
console.log(representativeSheetItems.length); // 代表項目エリアに配置されているシート項目の個数を出力
});
onBasicSheetItemsMounted
基本情報項目が初期化されたタイミングで関数を実行するeventHookを登録します。
getBasicSheetItemsの返値であるSheetItemsインスタンスのonMountedと同等です。
構文
onBasicSheetItemsMounted(callback);
onBasicSheetItemsMounted(callback, group);
引数
callback
基本情報項目が初期化されたタイミングで実行する関数です。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
登録したeventHookを解除する関数を返します。
例
esmJSPlugin.screen
.sheetDetail("customer")
.onBasicSheetItemsMounted(function (screen) {
const basicSheetItems = screen.getBasicSheetItems();
console.log(basicSheetItems.length); // 基本情報項目エリアに配置されているシート項目の個数を出力
});
onBasicSheetItemsUpdated
基本情報項目エリアの表示項目が変更されたタイミングが関数を実行するeventHookを登録します。
getBasicSheetItemsの返値であるSheetItemsインスタンスのonUpdatedと同等です。
構文
onBasicSheetItemsUpdated(callback);
onBasicSheetItemsUpdated(callback, group);
引数
callback
基本情報項目エリアの表示項目が変更されたタイミングで実行する関数です。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
登録したeventHookを解除する関数を返します。
例
esmJSPlugin.screen
.sheetDetail("customer")
.onBasicSheetItemsUpdated(function (screen) {
const basicSheetItems = screen.getBasicSheetItems();
console.log(basicSheetItems.length); // 基本情報項目エリアに配置されているシート項目の個数を出力
});
onCancelButtonClicked
フッターの「キャンセル」ボタンがクリックされたタイミングで関数を実行するeventHookを登録します。
構文
onCancelButtonClicked(callback);
onCancelButtonClicked(callback, options);
onCancelButtonClicked(callback, options, group);
引数
callback
フッターの「キャンセル」ボタンがクリックされたタイミングで実行する関数です。
options
eventHookをカスタマイズするオプションのオブジェクトです。
ctrlKey
- 真偽値で、
trueの場合 Ctrl キーを押下しながらクリックした時に関数を実行します。規定値はfalseです。altKey
- 真偽値で、
trueの場合 Alt キー(Mac の場合は Option キー)を押下しながらクリックした時に関数を実行します。規定値はfalseです。stop
- 真偽値で、
trueの場合関数を実行後に以降の処理を中断します。規定値はfalseです。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
登録したeventHookを解除する関数を返します。
例
const screen = esmJSPlugin.screen.sheetDetail("customer");
// 「キャンセル」ボタンがクリックされたタイミングで関数を実行
const unregister = screen.onCancelButtonClicked(function () {
console.log("clicked");
unregister();
});
// Ctrlキーを押しながら「キャンセル」ボタンがクリックされたタイミングで関数を実行
screen.onCancelButtonClicked(
function () {
console.log("clicked with ctrlKey");
},
{ ctrlKey: true }
);
onModifyButtonClicked
フッターの「変更」ボタンがクリックされたタイミングで関数を実行するeventHookを登録します。
構文
onModifyButtonClicked(callback);
onModifyButtonClicked(callback, options);
onModifyButtonClicked(callback, options, group);
引数
callback
フッターの「変更」ボタンがクリックされたタイミングで実行する関数です。
options
eventHookをカスタマイズするオプションのオブジェクトです。
ctrlKey
- 真偽値で、
trueの場合 Ctrl キーを押下しながらクリックした時に関数を実行します。規定値はfalseです。altKey
- 真偽値で、
trueの場合 Alt キー(Mac の場合は Option キー)を押下しながらクリックした時に関数を実行します。規定値はfalseです。stop
- 真偽値で、
trueの場合関数を実行後に以降の処理を中断します。規定値はfalseです。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
登録したeventHookを解除する関数を返します。
例
const screen = esmJSPlugin.screen.sheetDetail("customer");
// 「登録」および「保存」ボタンがクリックされたタイミングで関数を実行
const unregister = screen.onModifyButtonClicked(function () {
console.log("clicked");
unregister();
});
// Ctrlキーを押しながら登録」および「保存」ボタンがクリックされたタイミングで関数を実行
screen.onModifyButtonClicked(
function () {
console.log("clicked with ctrlKey");
},
{ ctrlKey: true }
);
getHeader
ヘッダーを表すHeaderインスタンスを返します。
構文
getHeader();
引数
なし
返値
ヘッダーを表すHeaderインスタンスです。
例
esmJSPlugin.screen.sheetDetail("customer").onEntered((screen) => {
const header = screen.getHeader();
header.onMounted(function () {
header.title = `${header.title}(株)`;
});
});
getRepresentativeItemArea
代表項目表示エリアを表すRepresentativeItemAreaインスタンスを返します。
構文
getRepresentativeItemArea();
引数
なし
返値
代表項目表示エリアを表すRepresentativeItemAreaインスタンスです。
例
esmJSPlugin.screen.sheetDetail("customer").onEntered(function (screen) {
const representativeItemArea = screen.getRepresentativeItemArea();
representativeItemArea.onMounted(function () {
representativeItemArea.setBackgroundColor("red");
});
});
getBasicItemArea
基本情報項目表示エリアを表すBasicItemAreaインスタンスを返します。
構文
getBasicItemArea();
引数
なし
返値
基本情報項目表示エリアを表すBasicItemAreaインスタンスです。
例
esmJSPlugin.screen.sheetDetail("customer").onEntered(function (screen) {
const basicItemArea = screen.getBasicItemArea();
basicItemArea.onMounted(function () {
basicItemArea.setBackgroundColor("yellow");
});
});
getSheetItems
画面に配置されているすべてのシート項目を内包するSheetItemsインスタンスを返します。
返値のSheetItemsインスタンスに対してonMountedでeventHookを登録すると、代表項目と基本情報項目の両方が初期化されたタイミングでコールバック関数を実行されます。
構文
getSheetItems();
引数
なし
返値
画面に配置されているすべてのシート項目を内包するSheetItemsインスタンスです。
例
esmJSPlugin.screen.sheetDetail("customer").onEntered(function (screen) {
const sheetItems = screen.getSheetItems();
sheetItems.onMounted(function () {
console.log(sheetItems.length); // 配置されているシート項目の個数を出力
});
});
getRepresentativeSheetItems
代表項目エリアに配置されているシート項目を内包するSheetItemsインスタンスを返します。
構文
getRepresentativeSheetItems();
引数
なし
返値
代表項目エリアに配置されているシート項目を内包するSheetItemsインスタンスです。
例
esmJSPlugin.screen.sheetDetail("customer").onEntered(function (screen) {
const representativeSheetItems = screen.getRepresentativeSheetItems();
representativeSheetItems.onMounted(function () {
console.log(representativeSheetItems.length); // 代表項目エリアに配置されているシート項目の個数を出力
});
});
getBasicSheetItems
基本情報項目エリアに配置されているシート項目を内包するSheetItemsインスタンスを返します。
構文
getBasicSheetItems();
引数
なし
返値
基本情報項目エリアに配置されているシート項目を内包するSheetItemsインスタンスです。
例
esmJSPlugin.screen.sheetDetail("customer").onEntered(function (screen) {
const basicSheetItems = screen.getBasicSheetItems();
basicSheetItems.onMounted(function () {
console.log(basicSheetItems.length); // 基本情報項目エリアに配置されているシート項目の個数を出力
});
});
getSheetItem
シート項目のキーを指定して、対応するSheetItemインスタンスを取得します。
取得したインスタンスは解決されるとそれぞれの具象クラスの API が利用できるようになります。
項目キーの取得方法はこちらをご確認ください。
構文
getSheetItem(itemKey);
引数
itemKey
シート項目のキーを表す文字列です。
返値
指定した項目キーに対応するSheetItemインスタンスです。
例
esmJSPlugin.screen.sheetDetail("businessplan").onEntered(function (screen) {
const businessplanNameItem = screen.getSheetItem(
"businessplans.businessplan.businessplan_name"
); // 項目キーを指定
businessplanNameItem.onMounted(function () {
console.log(businessplanNameItem.value);
});
const customerNameItem = screen.getSheetItem(
"businessplans.businessplan.relational_customer@customers.customer.customer_name"
); // 項目キーを指定
customerNameItem.onMounted(function () {
console.log(customerNameItem.value);
});
});
getSheetItemByLabel
シート項目のラベル名を指定して、対応するSheetItemインスタンスを取得します。
取得したインスタンスは解決されるとそれぞれの具象クラスの API が利用できるようになります。
紐づけ型項目が持つ項目については、ラベル名が衝突する可能性があるためこのメソッドによる取得は制限しています。getSheetItemをご利用ください。
構文
getSheetItemByLabel(label);
引数
label
シート項目のラベル名を表す文字列です。
返値
指定したラベル名に対応するSheetItemインスタンスです。
例
esmJSPlugin.screen.sheetDetail("customer").onEntered(function (screen) {
const customerNameItem = screen.getSheetItemByLabel("顧客名"); // 項目名を指定
customerNameItem.onMounted(function () {
console.log(customerNameItem.value);
});
});
getCancelButton
フッターの「キャンセル」ボタンを表すFooterButtonインスタンスを返します。
構文
getCancelButton();
引数
なし
返値
フッターの「キャンセル」ボタンを表すFooterButtonインスタンスです。
例
esmJSPlugin.screen.sheetDetail("customer").onEntered(function (screen) {
const cancelButton = screen.getCancelButton();
// ボタンがクリックされたタイミングで関数を実行
cancelButton.onClicked(function () {
alert("clicked");
});
});
getModifyButton
フッターの「変更」ボタンを表すFooterButtonインスタンスを返します。
構文
getModifyButton();
引数
なし
返値
フッターの「変更」ボタンを表すFooterButtonインスタンスです。
例
esmJSPlugin.screen.sheetDetail("customer").onEntered(function (screen) {
const submitButton = screen.getModifyButton();
// ボタンがクリックされたタイミングで関数を実行
submitButton.onClicked(function () {
alert("clicked");
});
});