v8
Forguncy Class Cell Forguncy API クラス

Cell クラス

ページ内のセルを表すオブジェクトです。

階層

メソッド

bind

  • bind(type: string, data?: any, fn?: Function): void
  • セルが持つイベントに対してイベントハンドラを関連付けます。

    イベントへのデータの受け渡し

    イベントハンドラーにデータを受け渡すには、第2パラメーターに指定します。その場合、イベントハンドラーは第3パラメーターに指定します。 受け渡されたデータは、イベントハンドラーにおける第1パラメーターのdataプロパティから参照できます。
    使用例
    // 本サンプルコードでは、ボタンをクリックした際にダイアログボックスを表示する例を示します。
    // イベントハンドラーにデータを受け渡さない場合:
    Forguncy.Page.getCell("button1").bind("click", function () {
        alert("Click!");
    });
    
    
    // イベントハンドラーにデータを受け渡す場合:
    var text = "Click!";
    Forguncy.Page.getCell("button1").bind("click", text, function (arg) {
        alert(arg.data);
    });

    引数

    • type: string

      関連付けするイベントを表す文字列。セルでサポートされているイベントについては、CellEventsクラスを参照してください。

    • オプション data: any

      イベントハンドラーに渡すデータ。関数では第1パラメーターのdataプロパティから参照します。省略可能。

    • オプション fn: Function

      イベント発生時に実行される関数。

    戻り値 void

disable

  • disable(): void
  • セルのユーザーとの対話を無効化します。

    使用例
    // 本サンプルコードでは、disableメソッドを使用してチェックボックス型セルを無効化する例を示します。
    // 現在のページを取得する。
    var page = Forguncy.Page;
    // 現在のページでcheckBoxという名前のチェックボックス型セルを取得する。
    var cell = page.getCell("checkBox");
    // チェックボックス型セルを無効化する。
    cell.disable();

    戻り値 void

enable

  • enable(): void
  • セルのユーザーとの対話を有効化します。

    使用例
    // 本サンプルコードでは、「checkBox1」チェックボックスをクリックして、「button1」ボタンの無効と有効を切り替える例を示します。
    // 現在のページを取得する。
    var p = Forguncy.Page;
    p.ready(function () {
    // 現在のページでbutton1という名前のボタン型セルを取得する。
        var b = p.getCell("button1");
    // 現在のページでcheckbox1という名前のチェックボックス型セルを取得する。
        var c = p.getCell("checkbox1");
    
        b.disable();
    
        c.bind("valuechanged", function () {
            if (c.getValue() == true)
            {
                // ボタン型セルを有効化する。
                b.enable();
            }
            else
            {
                // ボタン型セルを無効化する。
                b.disable();
            }
        })
    });

    戻り値 void

getValue

  • getValue(): any
  • セルの値を取得します。

    使用例
    // 本サンプルコードでは、getValueメソッドで取得したセルの値をダイアログボックス上に表示します。
    // 現在のページを取得する。
    var page = Forguncy.Page;
    // 現在のページでmyCellという名前のセルを取得する。
    var cell = page.getCell("myCell");
    // getValueメソッドでセルの値を取得する。
    var cellValue = cell.getValue();
    // ダイアログボックスを表示して取得したセルの値を表示する。
    alert(cellValue);

    戻り値 any

hasFocus

  • hasFocus(): boolean
  • セルにフォーカスがあるかどうかを取得します。戻り値がtrueの場合、セルはフォーカスを取得しています。falseの場合、セルはフォーカスを取得していません。

    使用例
    // 本サンプルコードでは、hasFocusメソッドを使用して「myCell」セルがフォーカスを取得しているかどうかをダイアログボックスに表示する例を示します。
    // 現在のページを取得する。
    var p = Forguncy.Page;
    // 現在のページでmyCellという名前のセルを取得する。
    var cell = page.getCell("myCell");
    // セルにフォーカスがあるかどうかを取得する。
    var f = cell.hasFocus();
    // セルにフォーカスがあるかどうかを示す値をダイアログボックスに表示する。
    alert(f);

    戻り値 boolean

hide

  • hide(): void
  • セルを非表示にします。非表示にできるのはセルの背景ではなく、セルの値、もしくはセル型のみです。

    使用例
    // 本サンプルコードでは、指定したセルをhideメソッドを使用して非表示にする例を示します。
    // 現在のページを取得する。
    var page = Forguncy.Page;
    // 現在のページでmyCellという名前のセルを取得する。
    var cell = page.getCell("myCell");
    // myCellという名前のセルを非表示にする。
    cell.hide();

    戻り値 void

setBackColor

  • setBackColor(color: any): void
  • セルの背景色を設定します。

    使用例
    // 本サンプルコードでは、setBackColorメソッドを使用して指定したセルの背景色を設定する例を示します。
    // 現在のページを取得する。
    var page = Forguncy.Page;
    // 現在のページでmyCellという名前のセルを取得する。
    var cell = page.getCell("myCell");
    // セルの背景色を設定する。
    var setColor = cell.setBackColor("red");

    引数

    • color: any

      設定する背景色の色。設定する値は、次の3つの形式をサポートしています。

      • "red"などの色の名前。
      • "#ff0000"などの16進値。
      • "rgb(255,0,0)"などのrgbコード。

    戻り値 void

setFocus

  • setFocus(): void
  • セルがフォーカスを取得できる場合、セルにフォーカスを設定します。

    使用例
    // 本サンプルコードでは、setFocusメソッドを使用して「myCell」セルにフォーカスを設定する例を示します。
    // 現在のページを取得する。
    var p = Forguncy.Page;
    // 現在のページでmyCellという名前のセルを取得する。
    var cell = page.getCell("myCell");
    // 取得したセルにフォーカスを設定する。
    cell.setFocus();

    戻り値 void

setForeColor

  • setForeColor(color: any): void
  • セルのフォントの色を設定します。

    使用例
    // 本サンプルコードでは、setForeColorメソッドを使用して指定したセルのフォントの色を設定する例を示します。
    // 現在のページを取得する。
    var page = Forguncy.Page;
    // 現在のページでmyCellという名前のセルを取得する。
    var cell = page.getCell("myCell");
    // セルのフォントの色を設定する。
    var setColor = cell.setForeColor("red");

    引数

    • color: any

      設定するフォントの色。設定する値は、次の3つの形式をサポートしています。

      • "red"などの色の名前。
      • "#ff0000"などの16進値。
      • "rgb(255,0,0)"などのrgbコード。

    戻り値 void

setReadOnly

  • setReadOnly(isReadOnly: boolean): any
  • セルの読み取り専用の状態を設定します。

    使用例
    // 本サンプルコードでは、「checkBox1」チェックボックスをクリックして、「textbox1」テキストボックスの読み取り専用の状態を切り替える例を示します。
    // 現在のページを取得する。
    var p = Forguncy.Page;
    p.ready(function () {
    // 現在のページでtextbox1という名前のテキストボックス型セルを取得する。
        var t = p.getCell("textbox1");
    // 現在のページでcheckbox1という名前のチェックボックス型セルを取得する。
        var c = p.getCell("checkbox1");
    
        c.bind("valuechanged", function () {
            if (c.getValue() == true)
            {
                // テキストボックス型セルを読み取り専用に設定する。
                t.setReadOnly(true);
            }
            else
            {
                // テキストボックス型セルの読み取り専用を解除する。
                t.setReadOnly(false);
            }
        })
    });

    引数

    • isReadOnly: boolean

      読み取り専用に設定する場合にはtrue、そうでない場合にはfalse。

    戻り値 any

setValue

  • setValue(value: any): void
  • セルに値を設定します。本メソッドは、添付ファイル型セル、画像アップロード型セル、ログインユーザー型セルでは使用できません。

    使用例
    // 本サンプルコードでは、ボタンをクリックしてテキストボックスに値を設定する例を示します。
    // 現在のページを取得する。
    var p = Forguncy.Page;
    p.ready(function(){
        p.getCell("button1").bind("click", function(){
            // 現在のページでtextBox1という名前のセルを取得する。
            var textCell = p.getCell("textBox1");
            // セルに指定した値を設定する。
            textCell.setValue("Forguncy");
        })
    });

    引数

    • value: any

      設定するセルの値。

    戻り値 void

show

  • show(): void
  • 非表示となっているセルを表示します。セルを非表示状態とするには、hideメソッドを使用します。

    使用例
    // 本サンプルコードでは、指定したセルをshowメソッドを使用して表示する例を示します。
    // 現在のページを取得する。
    var page = Forguncy.Page;
    // 現在のページでbuttonという名前のセルを取得する。
    var cell = page.getCell("button");
    // buttonという名前のセルを表示する。
    var cellShow = cell.show();

    戻り値 void

unbind

  • unbind(type: any, fn?: Function): void
  • 指定したイベントにおけるイベントハンドラーの関連付けを解除します。

    使用例
    // ボタンのclickイベントにイベントハンドラーを関連付ける。
    var onClick = function(arg) {
        alert("Click!");
    }
    var clickEvent = Forguncy.CellEvents.Click;
    var button1 = Forguncy.Page.getCell("button1");
    button1.bind("click", onClick);
    
    // イベントの種類とイベントハンドラーの両方を指定して関連付けを解除する。
    button1.unbind("click", onClick);
    
    // イベントの種類のみを指定してすべてのイベントハンドラーの関連付けを解除する。
    button1.unbind("click");

    引数

    • type: any

      関連付けを解除するイベントの種類を表す文字列。セルでサポートされるイベントについては、CellEventsクラスを参照してください。

    • オプション fn: Function

      関連付けを解除するイベントハンドラー。省略した場合、そのセルにおいて指定したイベントの種類に関連付けられているすべてのイベントハンドラーが解除されます。

    戻り値 void

unbindAll

  • unbindAll(): void
  • セルからすべてのイベントハンドラーの関連付けを解除します。

    使用例
    // 本サンプルコードでは、unbindAllメソッドを使用してセルに関連付けられているすべてのイベントハンドラーを解除する例を示します。
    // イベントハンドラーの定義。
    var onClick = function(arg) {
        alert("Forguncy");
    }
    // 現在のページを取得する。
    var page = Forguncy.Page;
    // 現在のページでbuttonという名前のボタン型セルを取得する。
    var cell = page.getCell("button");
    // ボタン型セルに関連付けられているすべてのイベントハンドラーを解除する
    cell.unbindAll();

    戻り値 void