Interface: ColumnControl

ColumnControl

A handle used by HTMLTableWrapperListener to open and close controls in response to client calls and end-user requests. Client code can define custom controls by implementing this interface and returning instances via an implementation of ColumnControlFactory.

Extends

Members

columnIndex :number

Index of the column this ColumnControl handles.

Type:
  • number
Source:

Methods

close()

Closes this ColumnControl such that it is hidden from the end-user.

Source:

dispose()

Optional function to dispose this object. The object should not be relied upon to be usable after calling this function, however whether it actually is, or not, is entirely implementation-dependent.

Inherited From:
Source:

getFilterDescriptor() → {FilterDescriptor}

Called by HTMLTableWrapperListener#processTable to obtain a FilterDescriptor based upon the current state of this ColumnControl. If this control is in a state in which no filtering should be performed, it is permissible to return Nothing.

Source:
Returns:

A FilterDescriptor based upon the state of this ColumnControl or Nothing if no filtering should be performed.

Type
FilterDescriptor

getSortDescriptor() → {SortDescriptor}

Called by HTMLTableWrapperListener#processTable to obtain a SortDescriptor based upon the current state of this ColumnControl. If this control is in a state in which no sorting should be performed, it is permissible to return Nothing.

Source:
Returns:

A SortDescriptor based upon the state of this ColumnControl or Nothing if no sorting should be performed.

Type
SortDescriptor

init()

Optional function to initialize this object for use. The object should be usable after calling this function.

Inherited From:
Source:

open()

Opens this ColumnControl such that it is visible to the end-user.

Source: