content
Gets or sets the HTML element contained in this Popup.
- Type
- HTMLElement
Class that shows an element as a popup.
Popups may be have owner elements, in which case they behave as rich tooltips that may be shown or hidden based on actions specified by the showTrigger and hideTrigger properties.
Popups with no owner elements behave like dialogs. They are centered on the screen and displayed using the show method.
To close a hide method.
Alternatively, any clickable elements within a Popup that have the classes starting with the 'wj-hide' string will hide the Popup when clicked and will set the dialogResult property to the class name so the caller may take appropriate action.
For example, the Popup below will be hidden when the user presses the OK or Cancel buttons, and the dialogResult property will be set to either 'wj-hide-cancel' or 'wj-hide-ok':
<button id="btnPopup">Show Popup</button> <wj-popup owner="#btnPopup" style="padding:12px"> <p>Press one of the buttons below to hide the Popup.</p> <hr/> <button class="wj-hide-ok" ng-click="handleOK()">OK</button> <button class="wj-hide-cancel">Cancel</button> </wj-popup>
The example below shows how you can use the Popup control to implement popups attached to owner elements and dialogs:
{@sample Input/Popup/PopupsWithOwnerElements/purejs}
constructor(element: any, options?: any): Popup
Initializes a new instance of the Popup class.
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
JavaScript object containing initialization data for the control.
Gets or sets a value used as a return value for the Popup after it is hidden.
This property is set to null when the Popup is displayed. It can be set in response to button click events or in the call to the hide method to provide a result value to callers.
Gets or sets a value to be used as a dialogResult when the user presses the Enter key while the Popup is visible.
If the user presses Enter and the dialogResultEnter property is not null, the popup checks whether all its child elements are in a valid state. If so, the popup is closed and the dialogResult property is set to the value of the dialogResultEnter property.
Gets or sets a value that determines whether the Popup should use a fade-in animation when it is shown.
The default value for this property is true.
Gets or sets a value that determines whether the Popup should use a fade-out animation when it is hidden.
The default value for this property is true.
Gets or sets the actions that hide the Popup.
By default, the hideTrigger property is set to Blur, which hides the popup when it loses focus.
If you set the hideTrigger property to Click, the popup will be hidden only when the owner element is clicked.
If you set the hideTrigger property to None, the popup will be hidden only when the hide method is called.
Gets the DOM element that is hosting the control.
Gets or sets a value that determines whether the control is disabled.
Disabled controls cannot get mouse or keyboard events.
Gets or sets a value that determines whether the popup can be dragged with the mouse by its header.
The header is identified by the '.wj-dialog-header' CSS selector. If the dialog does not contain any elements with the 'wj-dialog-header' class, user will not be able to drag the popup.
When making popups draggable, you may want to set the cursor property of the '.wj-dialog-header' CSS selector. For example:
<style>
.wj-popup {
width: 30%;
}
.wj-dialog-header {
cursor: move;
}
</style>
The default value for this property is false.
Gets a value that indicates whether the control is currently handling a touch event.
Gets a value that indicates whether the control is currently being updated.
Gets or sets a value that determines whether the Popup should be displayed as a modal dialog.
Modal dialogs show a dark backdrop that makes the Popup stand out from other content on the page.
If you want to make a dialog truly modal, also set the hideTrigger property to None, so users won't be able to click the backdrop to dismiss the dialog. In this case, the dialog will close only if the hide method is called or if the user presses the Escape key.
The default value for this property is false.
Gets or sets the element that owns this Popup.
If the owner is null, the Popup behaves like a dialog. It is centered on the screen and must be shown using the show method.
Gets or sets a value that determines whether the Popup element should be removed from the DOM when the Popup is hidden, as opposed to being hidden.
The default value for this property is true.
Gets a value indicating whether the control is hosted in an element with right-to-left layout.
Gets or sets the actions that show the Popup.
By default, the showTrigger property is set to Click, which causes the popup to appear when the user clicks the owner element.
If you set the showTrigger property to None, the popup will be shown only when the show method is called.
addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void
Adds an event listener to an element owned by this Control.
The control keeps a list of attached listeners and their handlers, making it easier to remove them when the control is disposed (see the dispose and removeEventListener methods).
Failing to remove event listeners may cause memory leaks.
The passive parameter is set to false by default, which means the event handler may call event.preventDefault(). If you are adding passive handlers to touch or wheel events, setting this parameter to true will improve application performance.
For details on passive event listeners, please see Improving scrolling performance with passive listeners.
Target element for the event.
String that specifies the event.
Function to execute when the event occurs.
Whether the listener should be handled by the control before it is handled by the target element.
Indicates that the handler will never call preventDefault().
applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement
Applies the template to a new instance of a control, and returns the root element.
This method should be called by constructors of templated controls. It is responsible for binding the template parts to the corresponding control members.
For example, the code below applies a template to an instance of an InputNumber control. The template must contain elements with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'. The control members '_tbx', '_btnUp', and '_btnDn' will be assigned references to these elements.
this.applyTemplate('wj-control wj-inputnumber', template, {
_tbx: 'input',
_btnUp: 'btn-inc',
_btnDn: 'btn-dec'
}, 'input');
Names of classes to add to the control's host element.
An HTML string that defines the control template.
A dictionary of part variables and their names.
Name of the part to be named after the host element. This determines how the control submits data when used in forms.
beginUpdate(): void
Suspends notifications until the next call to endUpdate.
deferUpdate(fn: Function): void
Executes a function within a beginUpdate/endUpdate block.
The control will not be updated until the function has been executed. This method ensures endUpdate is called even if the function throws an exception.
Function to be executed.
dispose(): void
Disposes of the control by removing its association with the host element.
The dispose method automatically removes any event listeners added with the addEventListener method.
Calling the dispose method is important in applications that create and remove controls dynamically. Failing to dispose of the controls may cause memory leaks.
disposeAll(e?: HTMLElement): void
Disposes of all Wijmo controls contained in an HTML element.
Container element.
endUpdate(): void
Resumes notifications suspended by calls to beginUpdate.
getControl(element: any): Control
Gets the control that is hosted in a given DOM element.
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
getTemplate(): string
Gets the HTML template used to create instances of the control.
This method traverses up the class hierarchy to find the nearest ancestor that specifies a control template. For example, if you specify a prototype for the ComboBox control, which does not specify a template, it will override the template defined by the DropDown base class (the nearest ancestor that does specify a template).
hide(dialogResult?: any): void
Hides the Popup.
Optional value assigned to the dialogResult property before closing the Popup.
initialize(options: any): void
Initializes the control by copying the properties from a given object.
This method allows you to initialize controls using plain data objects instead of setting the value of each property in code.
For example:
grid.initialize({
itemsSource: myList,
autoGenerateColumns: false,
columns: [
{ binding: 'id', header: 'Code', width: 130 },
{ binding: 'name', header: 'Name', width: 60 }
]
});
// is equivalent to
grid.itemsSource = myList;
grid.autoGenerateColumns = false;
// etc.
The initialization data is type-checked as it is applied. If the initialization object contains unknown property names or invalid data types, this method will throw.
Object that contains the initialization data.
invalidate(fullUpdate?: boolean): void
Invalidates the control causing an asynchronous refresh.
Whether to update the control layout as well as the content.
invalidateAll(e?: HTMLElement): void
Invalidates all Wijmo controls contained in an HTML element.
Use this method when your application has dynamic panels that change the control's visibility or dimensions. For example, splitters, accordions, and tab controls usually change the visibility of its content elements. In this case, failing to notify the controls contained in the element may cause them to stop working properly.
If this happens, you must handle the appropriate event in the dynamic container and call the invalidateAll method so the contained Wijmo controls will update their layout information properly.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
onGotFocus(e?: EventArgs): void
Raises the gotFocus event.
onHidden(e?: EventArgs): void
Raises the hidden event.
onLostFocus(e?: EventArgs): void
Raises the lostFocus event.
onRefreshed(e?: EventArgs): void
Raises the refreshed event.
onRefreshing(e?: EventArgs): void
Raises the refreshing event.
onShowing(e: CancelEventArgs): boolean
Raises the showing event.
onShown(e?: EventArgs): void
Raises the shown event.
refresh(fullUpdate?: boolean): void
Refreshes the control.
Whether to update the control layout as well as the content.
refreshAll(e?: HTMLElement): void
Refreshes all Wijmo controls contained in an HTML element.
This method is similar to invalidateAll, except the controls are updated immediately rather than after an interval.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
Removes one or more event listeners attached to elements owned by this Control.
Target element for the event. If null, removes listeners attached to all targets.
String that specifies the event. If null, removes listeners attached to all events.
Handler to remove. If null, removes all handlers.
Whether the listener is capturing. If null, removes capturing and non-capturing listeners.
show(modal?: boolean, handleResult?: Function): void
Shows the Popup.
Whether to show the popup as a modal dialog. If provided, this sets the value of the modal property.
Callback invoked when the popup is hidden. If provided, this should be a function that receives the popup as a parameter.
The handleResult callback allows callers to handle the result of modal dialogs without attaching handlers to the hidden event. For example, the code below shows a dialog used to edit the current item in a CollectionView. The edits are committed or canceled depending on the dialogResult value. For example:
$scope.editCurrentItem = function () {
$scope.data.editItem($scope.data.currentItem);
$scope.itemEditor.show(true, function (e) {
if (e.dialogResult == 'wj-hide-ok') {
$scope.data.commitEdit();
} else {
$scope.data.cancelEdit();
}
});
}
Occurs after the control has refreshed its contents.
Occurs when the control is about to refresh its contents.