Developers

FooterButton

FooterButtonクラスはフッターエリアの各種ボタンに対して操作を行うためのメンバーを持っています。

継承

Item

インスタンスプロパティ

disabled

ボタンが非活性かどうかを表す真偽値です。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const submitButton = screen.getSubmitButton();

  submitButton.onMounted(function () {
    console.log(submitButton.disabled);
  });
});

インスタンスメソッド

onClicked

ボタンがクリックされたタイミングで関数を実行するeventHookを登録します。

構文

onClick(callback);
onClick(callback, options);
onClick(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を解除する関数を返します。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const submitButton = screen.getSubmitButton();

  // ボタンがクリックされたタイミングで関数を実行
  const unregister = submitButton.onClicked(function () {
    console.log("clicked");
    unregister();
  });

  // Ctrlキーを押しながらボタンがクリックされたタイミングで関数を実行
  submitButton.onClicked(
    function () {
      console.log("clicked with ctrlKey");
      unregister();
    },
    { ctrlKey: true }
  );
});

isDisabled

disabledの値を返します。

構文

isDisabled();
引数

なし

返値

ボタンが非活性かどうかを表す真偽値を返します。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const submitButton = screen.getSubmitButton();

  submitButton.onMounted(function () {
    console.log(submitButton.isDisabled()); // true
  });
});

setDisabled

真偽値を受け取り、ボタンの非活性状態を変更します。

構文

setDisabled(value);
引数

value

ボタンが非活性かどうかを表す真偽値です。

返値

なし

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const submitButton = screen.getSubmitButton();

  submitButton.onMounted(function () {
    submitButton.setDisabled(true); // 非活性に設定
    console.log(submitButton.disabled); // true
  });
});

setColor

文字列を受け取り、ボタンの文字色を変更します。

構文

setColor(color);
引数

color

ボタンの文字色を表す文字列です。
null や空文字列などの falsy な値を指定した場合や何も指定しなかった場合はアプリケーションのデフォルトの文字色が適用されます。

返値

なし

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const submitButton = screen.getSubmitButton();

  submitButton.onMounted(function () {
    submitButton.setColor("red"); // 赤色になります
    submitButton.setColor("#FFFFFF"); // 白色になります
    submitButton.setColor(null); // デフォルトの色になります
  });
});

setBackgroundColor

文字列を受け取り、ボタンの背景色を変更します。

構文

setBackgroundColor(color);
引数

color

ボタンの背景色を表す文字列です。
null や空文字列などの falsy な値を指定した場合や何も指定しなかった場合はアプリケーションのデフォルトの背景色が適用されます。

返値

なし

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const submitButton = screen.getSubmitButton();

  submitButton.onMounted(function () {
    submitButton.setBackgroundColor("red"); // 赤色になります
    submitButton.setBackgroundColor("#FFFFFF"); // 白色になります
    submitButton.setBackgroundColor(null); // デフォルトの色になります
  });
});

関連情報