Caplin Trader 5.0.0

Class: module:ct-grid/refine/component/GridColumnRefinerPresenterComponent

module:ct-grid/refine/component/GridColumnRefinerPresenterComponent(gridColumn, presentationModel)

A PresenterComponent that can be given control of a grid column for the purposes of sorting and filtering. It listens on the presentation model for the module:ct-grid/refine/GridColumnRefinerEvents#event:REFINER_ACTION_COMPLETE event, on which it triggers the same event, signifying that it is to be closed.

Constructor

new module:ct-grid/refine/component/GridColumnRefinerPresenterComponent(gridColumn, presentationModel)

Extends:
Parameters:
Name Type Description
gridColumn string
presentationModel module:GridColumnRefiner
Implements:

Extends

Methods

addComponentLifecycleListener(oListener)

Add a component life-cycle event listener.

Parameters:
Name Type Description
oListener module:ct-component/ComponentLifecycleEvents

The listener being registered.
Inherited From:

deserialize(sPresenterData)

Extracts the data inside the presenter tag and gives it to the PresentationModel for deserialization. Only has affect if the Presentation Model implements module:br-presenter/SerializablePresentationModel.

Parameters:
Name Type Description
sPresenterData String

The presenter xml node in string format
Inherited From:

getPresentationModel()

Retrieve the presentation model being displayed by this component.

Inherited From:

isViewAttached()

Returns true once module:ct-component/ComponentLifecycleEvents#onOpen has fired, and the element returned from module:ct-presenter/component/PresenterComponent#getElement has been attached to the page.

Inherited From:

isViewBound()

Returns true if the element is part of the view, otherwise returns false.

Inherited From:

removeComponentLifecycleListener(oListener)

Remove a previously registered component life-cycle event listener.

Parameters:
Name Type Description
oListener module:ct-component/ComponentLifecycleEvents

The listener being removed.
Inherited From:

setColumn(gridColumn)

Set the column which the component should apply refinements to

Parameters:
Name Type Description
gridColumn module:ct-grid/GridColumn
Implements: