Skip to content

Class: SectionedTableProxy

SectionedTableProxy is a developer-facing class that provides access to a sectioned table and its sections for application specific customizations.

Hierarchy

Implements

Summary

Constructors

Properties

Class Properties

None in this class.

Inherited Properties

Accessors

Class Accessors

Inherited Accessors

Methods

Class Methods

Inherited Methods

Constructors

constructor

+ new SectionedTableProxy(context: IContext): SectionedTableProxy

Overrides ControlProxy.constructor

Parameters:

Name Type
context IContext

Returns: SectionedTableProxy

Accessors

filters

getter

Get the current filters for this Sectioned Table

Returns: FilterCriteria[]

setter

Set and apply the filters for this Sectioned Table

Parameters:

Name Type
filterCriteria FilterCriteria[]

Returns: void


searchString

getter

Get the user provided search string for this section table

Returns: string

setter

Set the user provided search string for this section table

Parameters:

Name Type
searchText string

Returns: void


sections

getter

Get the list of sections in the SectionedTable

Returns: ISectionProxy[]

Methods

dataQueryBuilder

dataQueryBuilder(query: string): DataQueryBuilder

Implementation of ISectionedTableProxy

Factory method to construct an instance of DataQueryBuilder

Parameters:

Name Type Default Description
query string undefined the query string

Returns: DataQueryBuilder


getControl

getControl(name: string): IControlProxy

Implementation of ISectionedTableProxy

Find a FormCell control based on the name. It returns FormCell controls in SectionedTable.

Parameters:

Name Type Description
name string the name of the control to match

Returns: IControlProxy

FormCellControlProxy instance or undefined if not found


getControls

getControls(): IControlProxy[]

Implementation of ISectionedTableProxy

Get the list of FormCell controls if there is any FormCell Section in SectionedTable

Returns: IControlProxy[]


getSection

getSection(name: string): ISectionProxy

Implementation of ISectionedTableProxy

Get the section based on the name

Parameters:

Name Type Description
name string the name of the section to match

Returns: ISectionProxy


getSections

getSections(): ISectionProxy[]

Implementation of ISectionedTableProxy

Get the list of sections in the SectionedTable

Returns: ISectionProxy[]


isContainer

isContainer(): boolean

Implementation of ISectionedTableProxy

Overrides ControlProxy.isContainer

Determine if the SectionedTable is a container.

Returns: boolean

true/false. It always returns true for SectionedTable.