new components.dt/js/spi/creators/DropPopupController(model, markup, dropCustomizer) → {components.dt/js/spi/creators/DropPopupController}
stable API
Final drop popup controller class.
Drop popup controller is a controller for the popup displayed when a PopupCreator constructs a view and adds it into the page. The PopupCreator uses the popup to modify the default created view with user's input.
It is up to the specific creator to provide an instance of DropPopupController with a proper popup markup and model that updates the view's properties.
The infrastructure raises a popup with the content (HTML markup and view model) passed as constructor arguments and informs about the popup state through a callback instance passed as the third parameter.
Parameters:
| Name | Type | Description |
|---|---|---|
model |
Object | view model part of the popup. Pass any object you use as your view model. |
markup |
String | HTML markup part of the popup internals. The markup should include accept and cancel buttons (popup footer) as these are not added by the infrastructure. |
dropCustomizer |
components.dt/js/spi/creators/DropPopupController.DropCustomizer | object providing callback methods called when the popup state changes. |
- Version:
- 16.3.5
- Source:
- See:
-
- PopupCreator for an example
Returns:
DropPopupController instance
Object Literals
Members
Methods
finish(accepted)
stable API
Closes the popup from inside a drop customizer implementation. This usually happens when user clicks on a cancel or finish button.
Popup creators will call this method on their own when their popup is to be closed (canceled or finished).
Parameters:
| Name | Type | Description |
|---|---|---|
accepted |
Boolean | flag indicating if the popup was accepted or canceled and dismissed by user. |
- Version:
- 16.3.5
- Source: