Forguncy.Forguncy.TabControlCell

类: TabControlCell

选项卡容器单元格。

继承关系

ContainerCellBase

↳ TabControlCell

构造方法

constructor

• new TabControlCell()

继承自

ContainerCellBase.constructor

方法

bind

▸ bind(type, data?, fn?): void

为被选单元格添加一个或多个事件处理程序，并规定事件发生时运行的函数。

Example

// 当点击按钮时，弹出一个消息框。
// 不需要给事件处理函数传递自定义参数：
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`	可选参数，如果不忽略表示给事件处理函数传递的自定义参数。
`fn?`	`Function`	事件处理函数。

返回值

void

继承自

ContainerCellBase.bind

disable

▸ disable(): void

禁用单元格。单元格禁用后，不可以被点击，可使用enable方法重新将其启用。

Example

// 下面的示例代码中，通过disable方法，单击按钮可禁用一个指定的复选框。
// 获取当前页面
var page = Forguncy.Page;
// 获取当前页面上名称为checkBox的复选框
var cell = page.getCell("checkBox");
// 禁用复选框
cell.disable();

返回值

void

继承自

ContainerCellBase.disable

enable

▸ enable(): void

启用单元格。单元格禁用后，不可以被点击，可使用disable方法重新将其禁用。

Example

// 通过单击一个复选框`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

继承自

ContainerCellBase.enable

getActiveTabIndex

▸ getActiveTabIndex(): number

获取当前选项卡的编号，编号从0开始。只有当单元格类型为选项卡时才有该方法。

Example

// 下面的示例代码中，通过getActiveTabIndex方法，获取了当前选项卡的编号。
// 获取当前页面
var page = Forguncy.Page;
// 获取选项卡
var tabControlCell = page.getCell("tabControl");
// 获得当前选项卡的编号。编号从0开始。
var activeTabIndex = tabControlCell.getActiveTabIndex();
// 弹出警告框，显示当前选项卡的编号
alert(activeTabIndex);

返回值

number

getCellType

▸ getCellType(): CellTypeBase

获取单元格上的单元格类型。

返回值

CellTypeBase

继承自

ContainerCellBase.getCellType

getTabCount

▸ getTabCount(): number

获取选项卡的数量。只有当单元格类型为选项卡时才有该方法。

Example

// 下面的示例代码中，通过getTabCount方法，获取了选项卡（tabControl）的数量。
// 获取当前页面
var page = Forguncy.Page;
// 获取选项卡
var tabControlCell = page.getCell("tabControl");
// 获得当前选项卡的编号。编号从0开始。
var activeTabIndex = tabControlCell.getActiveTabIndex();
// 弹出警告框，显示当前选项卡的编号
alert(activeTabIndex);

返回值

number

getTabPage

▸ getTabPage(tabIndex): SubPage

获取选项卡容器中的子页面对象。只有当单元格类型为选项卡时才有该方法。

Example

// 下面的示例代码中，通过getTabPage方法，获取了指定的选项卡（container）的子页面（页面1）中的单元格（myCell）的值。
// 获取当前页面
var page = Forguncy.Page;
// 获取选项卡
var tabControlCell = page.getCell("tabControl");
// 获取选项卡的子页面。如果需要获取选项卡中的单元格或表格，需要先获取到选项卡中的子页面的信息。选项卡编号从0开始。
var tab1 = tabControlCell.getTabPage(0);
// 获取第一个标签中名为myCell的单元格
var subPageCell = tab1.getCell("myCell");
// 获取单元格的值，弹出警告框
alert(subPageCell.getValue());

参数

属性名	类型	说明
`tabIndex`	`number`	页面索引。从`0`开始。

返回值

SubPage

getValue

▸ getValue(): any

获取指定单元格的值。获取单元格的值后，您可以将该值用于其他地方，比如命令中。

Example

// 下面的示例代码中，通过getValue方法，获取了指定的单元格（myCell）的值。
// 获取当前页面
var page = Forguncy.Page;
// 获取当前页面上名称为myCell的单元格
var cell = page.getCell("myCell");
// 获取此单元格的值
var cellValue = cell.getValue();
// 弹出警告框以显示此单元格的值
alert(cellValue);

返回值

any

继承自

ContainerCellBase.getValue

hasFocus

▸ hasFocus(): boolean

获取指定单元格是否具有焦点。可用于检测页面中的任一单元格是否获取焦点。返回值为true或false，true：单元格获取焦点；false：单元格未获取焦点。

Example

// 下面的示例代码中，通过hasFocus方法，获取指定单元格（myCell）是否具有焦点。
// 获取当前页面
var p = Forguncy.Page;
// 获取当前页面上名称为myCell的单元格
var cell = page.getCell("myCell");
// 获取当前单元格是否具有焦点
var f = cell.hasFocus();
// 弹出警示框，显示指定单元格是否具有焦点
alert(f);

返回值

boolean

继承自

ContainerCellBase.hasFocus

hide

▸ hide(): void

隐藏单元格。将页面中指定的单元格进行隐藏，只能隐藏单元格的值、类型等，而不能隐藏单元格的背景。与show方法相对，可根据实际需求结合使用。

Example

// 下面的示例代码中，通过hide方法，将指定的单元格（myCell）隐藏。
// 获取当前页面
var page = Forguncy.Page;
// 获取当前页面上名称为myCell的单元格
var cell = page.getCell("myCell");
// 隐藏名称为myCell的单元格
cell.hide();

返回值

void

继承自

ContainerCellBase.hide

setBackColor

▸ setBackColor(color): void

给指定的单元格设置背景色。

Example

// 下面的示例代码中，通过setBackColor方法，给指定单元格设置背景色。
// 获取当前页面
var page = Forguncy.Page;
// 获取当前页面上名称为myCell的单元格
var cell = page.getCell("myCell");
// 给单元格设置背景色
var setColor = cell.setBackColor("red");

参数

属性名	类型	说明
`color`	`any`	设置的颜色，支持以下三种形式：・颜色名称，如 red；・十六进制值，如 #ff0000；・rgb 代码，如 rgb(255,0,0)。

返回值

void

继承自

ContainerCellBase.setBackColor

setFocus

▸ setFocus(): void

设置焦点到指定单元格。一般情况下，当通过鼠标点击选中元素或通过 tab 键定位到单元格时，该单元格就会获得焦点。使用setFocus方法可直接让指定的单元格获得焦点。

Example

// 下面的示例代码中，通过setFocus方法，将焦点设置到单元格（myCell）。
// 获取当前页面
var p = Forguncy.Page;
// 获取当前页面上名称为myCell的单元格
var cell = page.getCell("myCell");
// 将焦点设置到单元格myCell上
cell.setFocus();

返回值

void

继承自

ContainerCellBase.setFocus

setForeColor

▸ setForeColor(color): void

给指定的单元格设置其字体颜色。与setBackColor方法类似。

Example

// 下面的示例代码中，通过setForeColor方法，给指定单元格的字体设置颜色。
// 获取当前页面
var page = Forguncy.Page;
// 获取当前页面上名称为myCell的单元格
var cell = page.getCell("myCell");
// 给单元格设置字体颜色
var setColor = cell.setForeColor("red");

参数

属性名	类型	说明
`color`	`any`	设置的颜色，支持以下三种形式：・颜色名称，如 red；・十六进制值，如 #ff0000；・rgb 代码，如 rgb(255,0,0)。

返回值

void

继承自

ContainerCellBase.setForeColor

setReadOnly

▸ setReadOnly(isReadOnly): any

设置单元格的只读状态。

Example

// 单击复选框“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，设置为只读状态，否则取消只读状态。

返回值

any

继承自

ContainerCellBase.setReadOnly

setValue

▸ setValue(value): void

给指定的单元格设置值，值可以是任意值，没有限制。

Example

// 通过单击按钮`button1`来修改文本框`textBox1`的值。
// 获取当前页面
var p = Forguncy.Page;
p.ready(function(){
    p.getCell("button1").bind("click", function(){
        // 获取当前页面上名称为textBox1的单元格
        var textCell = p.getCell("textBox1");
        // 设置指定单元格的值
        textCell.setValue("活字格");
    })
});

参数

属性名	类型	说明
`value`	`any`	值。

返回值

void

继承自

ContainerCellBase.setValue

show

▸ show(): void

显示单元格。将页面中隐藏的单元格进行显示，显示单元格的值、类型等。与hide方法相对，可根据实际需求结合使用。

Example

// 下面的示例代码中，通过show方法，显示指定的单元格（button）。
// 获取当前页面
var page = Forguncy.Page;
// 获取当前页面上名称为button的单元格
var cell = page.getCell("button");
// 显示此单元格的值
var cellShow = cell.show();

返回值

void

继承自

ContainerCellBase.show

showTab

▸ showTab(tabIndex): void

Example

// 下面的示例代码中，通过showTab方法，将显示的选项卡由第一个选项卡更改为第二个选项卡。
// 获取当前页面
var page = Forguncy.Page;
// 获取选项卡
var tabControlCell = page.getCell("tabControl");
// 更改选项卡容器的当前选项卡为第二个，选项卡编号从0开始。
tabControlCell.showTab(1);

参数

属性名	类型	说明
`tabIndex`	`number`	选项卡的编号。选项卡编号从0开始。

返回值

void

unbind

▸ unbind(type, fn?): void

移除被选元素的事件处理程序。该方法能够移除被选的事件处理程序，或者当事件发生时终止指定函数的运行。

Example

// 先给按钮绑定点击事件处理函数：
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

继承自

ContainerCellBase.unbind

unbindAll

▸ unbindAll(): void

移除页面上所有事件的绑定。该方法能够移除页面上所有的事件处理程序，或者当事件发生时终止指定函数的运行。

Example

// 使用unbindAll方法释放与单元格关联的所有事件处理程序的示例。
// 给按钮绑定点击事件处理函数
var onClick = function(arg) {
    alert("活字格");
}
// 获取当前页面
var page = Forguncy.Page;
// 获取当前页面上名称为button的按钮
var cell = page.getCell("button");
// 取消所有点击事件处理函数的绑定
cell.unbindAll();

返回值

void

继承自

ContainerCellBase.unbindAll