Forguncy.Forguncy.ListView

类: ListView

表格。

构造方法

constructor

• new ListView()

方法

addNewRow

▸ addNewRow(rowValues, isText?): void

给表格中添加一个新行，包括新行的数据。

Example

// 如果表格有 3 列
// 第一列是`Name`
// 第二列是`Birthday`
// 第三列是`Department`,模板单元格类型是`ComboBoxCellType`，值是 [1,2,3]，显示文本值是["DD1","DD2","DD3"]
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 以下三种用法将添加一样的新行：
listview.addNewRow({"Name":"Lily","Birthday":new Date(1990,1,3),"Department":1});
listview.addNewRow(["Lily",new Date(1990,1,3),1]);
listview.addNewRow({"Name":"Lily","Birthday":"1990/02/03","Department":"DD1"}, true);

参数

属性名	类型	说明
`rowValues`	`any`[] \| { `[columnName: string]`: `any`; }	新行的数据。
`isText?`	`boolean`	可选参数。指定`rowValues`里的数据是否要当作文本进行解析。默认值为`false`。

返回值

void

addSelectedRow

▸ addSelectedRow(rowIndex): void

在表格中选中一个指定的行。如果表格可以多选，则选中一个行后，可使用此方法再选中一个指定的行；如果表格仅允许单选，则选中一行后，再使用此方法会选中指定的行，之前的行会取消选中。

Example

// 下面的示例代码中，通过addSelectedRow方法，在表格中选定一个指定的行。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 添加新行
listview.addSelectedRow(2);

参数

属性名	类型	说明
`rowIndex`	`number`	行索引，从0开始。

返回值

void

bind

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

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

Example

// 下面的示例代码中，通过bind方法，给表格添加当前行变化事件处理函数，当表格的当前行发生改变时，弹出一个警告框。
// 获取当前页面
var listview = Forguncy.Page.getListView("表格1");

// 不需要给事件处理函数传递自定义参数
listview.bind("SelectionChanged", function () {
    alert("活字格");
});

// 需要给事件处理函数传递自定义参数
var text = "活字格";
listview.bind("SelectionChanged", text, function (arg) {
    alert(arg.data);
});

参数

属性名	类型	说明
`type`	`string`	表示事件类型的字符串。表格支持的事件请参考`ListViewEvents`类。
`data?`	`any`	可选参数，如果不忽略表示给事件处理函数传递的自定义参数。
`fn?`	`any`	事件处理函数。

返回值

void

clearAllColumnFilters

▸ clearAllColumnFilters(): void

清除ListView中的所有列筛选项。主要用于ReloadListViewCommand中，作为一个可选参数提供

Example

// 下面的代码中，通过clearAllColumnFilters清空ListView中的所有列筛选项。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 清除表格对象的列筛选项
listview.clearAllColumnFilters();

返回值

void

clearAllSelectedRows

▸ clearAllSelectedRows(selectionRowMode?): void

将表格中选择行的选中状态取消掉。

Example

// 下面的示例代码中，通过clearAllSelectedRows方法，将表格中所有选择行的选中状态取消掉。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 取消当前分页下的选择行的选中状态。
listview.clearAllSelectedRows();

// 取消当前分页下的选择行的选中状态。
listview.clearAllSelectedRows(Forguncy.SelectionRowMode.CurrentPagination);

// 取消所有分页下的选择行的选中状态。
listview.clearAllSelectedRows(Forguncy.SelectionRowMode.AllPagination);

参数

属性名	类型	说明
`selectionRowMode?`	`SelectionRowMode`	表格的选择行受影响的分页范围。默认只影响当前分页的选择行。

返回值

void

clearSelectedRow

▸ clearSelectedRow(rowIndex): void

将表格中指定的选择行的选中状态取消掉。

Example

// 下面的示例代码中，通过clearSelectedRow方法，将表格中指定的选择行的选中状态取消掉。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 取消所有选择行的选中状态
listview.clearSelectedRow(1);

参数

属性名	类型	说明
`rowIndex`	`number`	行索引。

返回值

void

clearSelectedRowByQuery

▸ clearSelectedRowByQuery(query): void

根据查询条件清除表格的选择行。

Example

// 下面的示例代码中，通过clearSelectedRowByQuery方法，根据查询条件清除表格的选择行。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 根据查询条件清除表格的选择行
listview.clearSelectedRowByQuery({ID:1});

参数

属性名	类型	说明
`query`	`Object`	所选行的查询条件，以主键名作为主键，以对应数据作为值。

返回值

void

deleteRow

▸ deleteRow(rowIndex): void

删除表格中的一行。

Example

// 下面的示例代码中，通过deleteRow方法，将表格中指定的行删除。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 删除表格中的指定行
listview.deleteRow(1);

参数

属性名	类型	说明
`rowIndex`	`number`	行索引，从0开始。

返回值

void

getDataTableName

▸ getDataTableName(): string

获取表格所绑定的数据表或视图的名称。

Example

// 下面的示例代码中，通过getDataTableName方法，获取表格所绑定的数据表或视图的名称。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 获取表格所绑定的数据表或视图的名称
var name = listview.getDataTableName();
// 弹出警告框，显示数据表或视图的名称
alert(name);

返回值

string

getDesignerRangeInfo

▸ getDesignerRangeInfo(): CellRange

获取表格在设计器中位置信息，包括起始行索引、起始列索引、表格行数和列数。

Example

// 下面的示例代码中，通过getDesignerRangeInfo方法，获取表格在设计器中位置信息，包括起始行索引、起始列索引、表格行数和列数。行、列索引从0开始。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 获取表格在设计器中位置信息
var range = listview.getDesignerRangeInfo();
// 弹出提示框，显示表格的位置信息
alert( "起始行索引："+range.Row+"\n"+"起始列索引："+range.Column+"\n"+"表格的行数："+range.RowCount+"\n"+"表格的列数："+range.ColumnCount);

返回值

CellRange

getMergedColumnInfos

▸ getMergedColumnInfos(): IMergedColumnInfo[]

获取表格中所有列的信息。包括行头列，选择列，隐藏列等等。

Example

// 下面的示例代码中，通过getMergedColumnInfos方法，获取表格中所有列的信息。包括行头列、选择列、隐藏列等。
// 获取当前页面
var page = Forguncy.Page;
// 获取页面上的表格
var listview = page.getListViews()[0];
// 获取表格中所有列的信息
var infos=listview.getMergedColumnInfos();
// 弹出警告框，显示表格中所有列的信息
alert(JSON.stringify(infos, null, " "));

返回值

IMergedColumnInfo[]

getName

▸ getName(): string

获取表格的名称。

Example

// 下面的示例代码中，通过getName方法，获取表格的名称。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 获取表格的名称
var name = listview.getName();
// 弹出警告框，显示表格的名称
alert(name);

返回值

string

getPaginationInfo

▸ getPaginationInfo(): ListviewPaginationInfo

获取表格页码信息。如果表格没有分页，返回值将为null。

返回值示例

{
    // 页数
    "PageCount":3,
    // 当前第几页的页号
    "PageIndex":1,
    // 每页最大行数
    "MaxRowCountOfOnePage":10
}

Example

// 最好在页面的`PageDefaultDataLoaded`事件处理函数中调用该方法，因为在此之前，表格的数据还没有加载完成。
Forguncy.Page.bind(Forguncy.PageEvents.PageDefaultDataLoaded, function () {
    var listview = Forguncy.Page.getListView("表格1");
    // 获取表格页码信息
    var pagingInfo = listview.getPaginationInfo();
    listview.bind(Forguncy.ListViewEvents.Reloaded, function() {
        // 在分页导航单元格中单击“上一页”或“下一页”后，表格将重新加载数据，页码信息也会更新。
        var pagingInfo = listview.getPaginationInfo();
        // 弹出警告框，显示表格页码信息
        alert(JSON.stringify(pagingInfo, null, " "));
    });
});

返回值

ListviewPaginationInfo

getQuery

▸ getQuery(rowIndex): Object

获取指定行的查询信息（主键）。

Example

// 下面的示例代码中，通过getQuery方法，获取表格指定行的主键。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 获取指定行的主键
var query = listview.getQuery(0);
// 弹出警告框，显示主键信息
alert(JSON.stringify(query, null, " "));

参数

属性名	类型	说明
`rowIndex`	`number`	指定行的行索引。

返回值

Object

getRowCount

▸ getRowCount(): number

获取表格的行数。

Example

// 下面的示例代码中，通过getRowCount方法，获取表格的行数。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 获取表格的行数
var count= listview.getRowCount();
// 弹出警告框，显示表格的行数
alert(count);

返回值

number

getRunTimePageName

▸ getRunTimePageName(): string

获取表格所在的运行时页面标识字符串。

返回值

string

getSelectedRowIndex

▸ getSelectedRowIndex(): number

获取当前行的行索引。行索引从0开始。

Example

// 下面的示例代码中，通过getSelectedRowIndex方法，获取当前行的行索引。
// 获取当前页面
var page = Forguncy.Page;
// 获取页面上的表格
var listview = page.getListView("表格1");
// 获取当前行的行索引
var index = listview.getSelectedRowIndex();
// 弹出警告框，显示当前行的行索引
alert(index);

返回值

number

getSelectedRowIndexs

▸ getSelectedRowIndexs(): number[]

获取选择行的行索引。如果选择多个行，则返回一个数组，包含所有选择行的行索引。行索引从0开始。

Example

// 下面的示例代码中，通过getSelectedRowIndexes方法，获取选定行的行索引。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 获取选定行的行索引
var index = listview.getSelectedRowIndexes();
// 弹出警告框，显示选择行的行索引
alert(JSON.stringify(index, null, " "));

返回值

number[]

getSelectedRowsData

▸ getSelectedRowsData(): RowData[]

获取表格选择行的数据。包括选择行的行索引、查询条件和数据。

Example

// 下面的示例代码中，通过getSelectedRowsData方法，获取表格选择行的数据。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 获取表格选择行数据
var rows = listview.getSelectedRowsData();
// 弹出警告框，显示表格中选择行的信息
alert(JSON.stringify(rows, null, " "));

返回值

RowData[]

getText

▸ getText(rowIndex, column): any

获取表格的指定单元格文本。

Example

// 如果表格有两列，分别是`Name`和`Age`。
// 如果想要获取`Age`列的第一行的文本数据：
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 用法1：
var text = listview.getText(0,"Age");
// 用法2：
var text = listview.getText(0,1);

参数

属性名	类型	说明
`rowIndex`	`number`	表格的行索引，从0开始。
`column`	`string` \| `number`	表格的列名，或该列索引的数字，列索引从0开始。

返回值

any

getValue

▸ getValue(rowIndex, column): any

获取表格中指定位置上单元格的值。

Example

// 如果表格有两列，分别是`Name`和`Age`。
// 如果想要获取`Age`列的第一行的数据：
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 用法1：
var text = listview.getValue(0,"Age");
// 用法2：
var text = listview.getValue(0,1);

参数

属性名	类型	说明
`rowIndex`	`number`	表格的行索引。
`column`	`string` \| `number`	表格的列名或列索引。

返回值

any

goToFirstPage

▸ goToFirstPage(): void

如果表格使用分页导航按钮将表格数据分页显示，使用此方法可使表格跳转到第一页，显示第一页的数据。

Example

// 下面的示例代码中，通过goToFirstPage方法，将显示的表格数据跳转到第一页。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 跳转到表格的第一页
listview.goToFirstPage()

返回值

void

goToLastPage

▸ goToLastPage(): void

如果表格使用分页导航按钮将表格数据分页显示，使用此方法可使表格跳转到最后一页，显示最后一页的数据

Example

// 下面的示例代码中，通过goToLastPage方法，将显示的表格数据跳转到最后一页。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 跳转到表格的最后一页
listview.goToLastPage()

返回值

void

goToNextPage

▸ goToNextPage(): void

如果表格使用分页导航按钮将表格数据分页显示，使用此方法可使表格跳转到当前页的下一页，显示下一页的数据。

Example

// 下面的示例代码中，通过goToNextPage方法，将显示的表格数据跳转到当前页的下一页。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 跳转到表格当前页的下一页
listview.goToNextPage()

返回值

void

goToPreviousPage

▸ goToPreviousPage(): void

如果表格使用分页导航按钮将表格数据分页显示，使用此方法可使表格跳转到当前页的前一页，显示前一页的数据。

Example

// 下面的示例代码中，通过goToPreviousPage方法，将显示的表格数据跳转到当前页的前一页。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 跳转到表格当前页的前一页
listview.goToPreviousPage()

返回值

void

goToSpecifiedPage

▸ goToSpecifiedPage(pageIndex): void

如果表格使用分页导航按钮将表格数据分页显示，使用此方法可使表格跳转到指定的页，显示指定页的数据。

Example

// 下面的示例代码中，通过goToSpecifiedPage方法，使表格跳转到指定的页。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 跳转到指定的页
listview.goToSpecifiedPage(3)

参数

属性名	类型	说明
`pageIndex`	`number`	指定的页面索引。

返回值

void

hiddenLoadingIndicator

▸ hiddenLoadingIndicator(): void

隐藏表格的加载图标，并恢复表格的正常的使用。通常与showLoadingIndicator方法配套使用。

Example

// 使用showLoadingIndicator方法和hiddenLoadingIndicator方法在列表视图中显示加载指示器并暂时禁用列表视图的示例。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");

listview.showLoadingIndicator();

// 操作表格...

listview.hiddenLoadingIndicator();

返回值

void

hideColumns

▸ hideColumns(columns): void

隐藏表格的列。

Example

// 下面的示例代码中，展示了如何隐藏表格的列。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");

// 隐藏列名为 "Text" 和 "Text1" 的列。
listview.hideColumns(["Text", "Text1"]);

// 隐藏表格中的第二列和第三列。
listview.hideColumns([1,2]);

参数

属性名	类型	说明
`columns`	(`string` \| `number`)[]	列表视图中的列名数组或列索引数组。

返回值

void

isSelectedRow

▸ isSelectedRow(rowIndex): boolean

获取指定的行是否被选中。

Example

// 下面的示例代码中，通过isSelectedRow方法，获取指定的行是否被选中。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 获取指定的行是否被选中
var row = listview.isSelectedRow(2);
// 弹出警告框，显示指定的行是否被选中
alert(row);

参数

属性名	类型	说明
`rowIndex`	`number`	行索引。

返回值

boolean

reload

▸ reload(): void

重新从数据库加载数据。 * 在表格设置中可以设置“定时刷新数据”，如果不勾选此项，可使用reload方法，重新从数据库加载数据。

Example

// 下面的示例代码中，通过reload方法，重新从数据库加载数据。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 重新从数据库加载数据
listview.reload();

返回值

void

selectAllRows

▸ selectAllRows(): void

选择表格中所有的行。

Example

// 下面的示例代码中，通过selectAllRows方法，选择表格中所有的行。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 选择表格中的所有行
listview.selectAllRows();

返回值

void

selectRow

▸ selectRow(rowIndex): void

将表格中指定的行设置为当前行。

Example

// 下面的示例代码中，通过selectRow方法，将表格中指定的行设置为当前行。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 将表格中指定的行设置为当前行
listview.selectRow(2);

参数

属性名	类型	说明
`rowIndex`	`number`	行索引，从0开始。

返回值

void

setText

▸ setText(rowIndex, column, text): void

设置表格中指定位置上单元格的文本。

Example

// 如果表格有一列是`Name`，并且模板单元格设置为下拉选择框。
// 如果想要设置`Name`列的第一行的数据为[Value=12, Text="Bob"]：
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 用法1：
listview.setText(0,"Name","Bob");
// 用法2：
listview.setText(0,0,"Bob");

参数

属性名	类型	说明
`rowIndex`	`number`	表格的行索引。
`column`	`string` \| `number`	表格的列名或列索引
`text`	`any`	文本。

返回值

void

setValue

▸ setValue(rowIndex, column, value): void

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

Example

// 如果表格有两列，分别是`Name`和`Age`。
// 如果想要设置`Age`列的第一行的数据：
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 用法1：
listview.setValue(0,"Age",12);
// 用法2：
listview.setValue(0,1,12);

参数

属性名	类型	说明
`rowIndex`	`number`	表格的行索引，从0开始。
`column`	`string` \| `number`	表格的列名，或该列索引的数字，列索引从0开始。
`value`	`any`	设定的值。

返回值

void

showColumns

▸ showColumns(columns): void

显现表格中通过API和列选项命令隐藏的列。

Example

// 下面的示例代码中，展示了如何显现表格中通过API和列选项命令隐藏的列。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");

// 显现列名为 "Text" 和 "Text1" 的列。
listview.showColumns(["Text", "Text1"]);

// 显现表格中的第二列和第三列。
listview.showColumns([1,2]);

参数

属性名	类型	说明
`columns`	(`string` \| `number`)[]	列表视图中的列名数组或列索引数组。

返回值

void

showLoadingIndicator

▸ showLoadingIndicator(): void

显示表格的加载图标，并禁用表格，直到调用hiddenLoadingIndicator，表格才能重新启用。通常用于进行大量操作表格之前，以避免意外操作。

Example

// 使用showLoadingIndicator方法和hiddenLoadingIndicator方法在列表视图中显示加载指示器并暂时禁用列表视图的示例。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");

listview.showLoadingIndicator();

// 操作表格...

listview.hiddenLoadingIndicator();

返回值

void

unbind

▸ unbind(type, fn?): void

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

Example

// 下面的示例代码中，通过unbind方法，移除表格的事件绑定。
// 定义事件处理函数
var onSelectionChanged = function () {
    alert("活字格");
}
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 绑定表格的事件
listview.bind("SelectionChanged", onSelectionChanged);
// 取消特定事件处理函数的绑定
listview.unbind("SelectionChanged", onSelectionChanged);
// 取消绑定所有关联到`SelectionChanged`事件的执行函数。
listview.unbind("SelectionChanged");

参数

属性名	类型	说明
`type`	`any`	表示事件类型的字符串。表格支持的事件请参考`ListViewEvents`类。
`fn?`	`any`	事件处理函数。如果忽略，则取消绑定表格上该事件类型的所有处理函数。

返回值

void

usePaginationDisplay

▸ usePaginationDisplay(pageRowCount, pageIndex?): void

使用此方法分页显示表格的数据，您可以设置每页显示的行数，并进入指定的页码。

Example

// 下面的示例代码中，通过usePaginationDisplay方法，设置每页显示的行数，并进入指定的页码。
// 获取当前页面
var page = Forguncy.Page;
// 获取表格对象
var listview = page.getListView("表格1");
// 设置每页显示行数，并进入指定页码
listview.usePaginationDisplay(6, 2)

参数

属性名	类型	说明
`pageRowCount`	`number`	一页的最多行数。
`pageIndex?`	`number`	显示的页面的索引。如果忽略则进入第一页。

返回值

void