Constructor
new module:caplin/grid/refine/component/presenter/RefinerSummaryPresentationModel()
A
module:br/presenter/PresentationModel
used to display a summary of which filters and sorts are applied
to a grid.
This class is intended to be used with the 'caplin.grid.refine.refiner-summary
' HTML template.
Extends:
- Implements:
Extends
Methods
-
getClassName()
-
Returns the presentation model class name.
- Inherited From:
Returns:
Presentation model class name. -
getComponentFrame()
-
Presentation models can use this method to receive a reference to the frame containing the
module:br/presenter/component/PresenterComponent
that this model resides within.- Inherited From:
-
getPath()
-
Returns the path that would be required to bind this node from the view.
This method is used internally, but might also be useful in allowing the dynamic construction of views for arbitrary presentation models.
- Inherited From:
-
initialise(columnModel)
-
Initialise the summary panel, making it display filter and sort data for a given
module:caplin/grid/GridColumnModel
.Parameters:
Name Type Description columnModel
module:caplin/grid/GridColumnModel The column model of the grid that this summary panel will display filter and sort data for. -
nodes(sNodeName, vProperties)
-
Returns all nested nodes matching the search criteria reachable from this node.
Care is taken not to search up the tree in cyclic presentation models (where some of the presentation nodes have back references to presentation nodes higher up in the tree).
Parameters:
Name Type Description sNodeName
String The name of nodes to match. vProperties
Object Only nodes having this array or map of properties will be matched. - Inherited From:
- See:
-
onClose()
-
properties(sPropertyName, vValue)
-
Returns all nested properties matching the search criteria reachable from this node.
Care is taken not to search up the tree in cyclic presentation models (where some of the presentation nodes have back references to presentation nodes higher up in the tree).
Parameters:
Name Type Description sPropertyName
String The name of properties to match. vValue
Object The value of properties to match. - Inherited From:
- See:
-
removeAllListeners()
-
- Inherited From:
- Deprecated:
- This method has been replaced by #removeChildListeners which recurses the node tree.
Removes all listeners attached to the properties contained by this
PresentationNode
.
- This method has been replaced by #removeChildListeners which recurses the node tree.
Removes all listeners attached to the properties contained by this
-
removeChildListeners()
-
Removes all listeners attached to the properties contained by this
PresentationNode
, and any nodes it contains.- Inherited From:
-
setComponentFrame(oComponentFrame)
-
Presentation models can use the
module:br/presenter/PresentationModel#getComponentFrame
to receive a reference to the frame containing themodule:br/presenter/component/PresenterComponent
that this model resides within.Parameters:
Name Type Description oComponentFrame
module:br/component/Frame The frame within which the presenter component resides. - Inherited From: