5.5.2.1.31. PopupView
API DOCS

PopupView is a component that allows you to open a popup with a container. The popup can be opened by clicking on minimized value or programmatically. It can be closed by mouse out or by clicking on outside area.

A typical PopupView with hidden and visible popup is shown below:

Popup hidden
Figure 21. Popup hidden
Popup visible
Figure 22. Popup visible

The component is implemented for Web Client.

An example of a PopupView with minimized value retrieved from a localized message pack:

<popupView id="popupView"
           minimizedValue="msg://minimizedValue"
           caption="PopupView caption">
    <vbox width="60px" height="40px">
        <label value="Content" align="MIDDLE_CENTER"/>
    </vbox>
</popupView>

The inner content of the PopupView should be a container, for example BoxLayout.

PopupView methods:

  • setPopupVisible() allows you to open popup window programmatically.

    @Inject
private PopupView popupView;

@Override
public void init(Map<String, Object> params) {
    popupView.setPopupVisible(true);
}

  • setMinimizedValue() allows you to set a minimized value programmatically.

    @Inject
private PopupView popupView;

@Override
public void init(Map<String, Object> params) {
    popupView.setMinimizedValue("Hello world!");
}

  • addPopupVisibilityListener(PopupVisibilityListener listener) allows you to listen to the popup window visibility changes.

    @Inject
private PopupView popupView;

@Override
public void init(Map<String, Object> params) {
    popupView.addPopupVisibilityListener(event ->
        showNotification(event.isPopupVisible() ? "The popup is visible" : "The popup is hidden",
            NotificationType.HUMANIZED));
}

PopupView attributes:

  • minimizedValue attribute defines the text of popup button. This text may contain HTML tags.

  • If the hideOnMouseOut attribute is set to false, popup container will close after click on outside area.

  • captionAsHtml attribute allows to use HTML tags in caption of component.

Attributes of popupView

caption - captionAsHtml - description - height - hideOnMouseOut - icon - id - minimizedValue - stylename - visible - width

API

addPopupVisibilityListener