Interface PopupSource

    • Method Detail

      • getPopupDefinition

        PopupDefinition getPopupDefinition()
        Gets the PopupDefinition that is currently defined or set on the entity.
        Returns:
        the current PopupDefinition. Will return null if an error occurs or if the pop-up source is not associated with a pop-up definition.
        Since:
        100.0.0
        See Also:
        setPopupDefinition(PopupDefinition)
      • setPopupDefinition

        void setPopupDefinition​(PopupDefinition popupDefinition)
        Sets a new PopupDefinition on the entity, overriding any previously existing one.
        Parameters:
        popupDefinition - the PopupDefinition to set
        Since:
        100.0.0
        See Also:
        getPopupDefinition()
      • isPopupEnabled

        boolean isPopupEnabled()
        Checks if the pop-up definition returned from getPopupDefinition() is enabled or disabled.
        Returns:
        true if the pop-up definition is enabled; false otherwise. Will return false if an error occurs.
        Since:
        100.0.0
        See Also:
        setPopupEnabled(boolean)
      • setPopupEnabled

        void setPopupEnabled​(boolean enabled)
        Sets whether the pop-up definition returned from getPopupDefinition() is enabled or disabled.
        Parameters:
        enabled - true to enable the PopupDefinition; false otherwise
        Since:
        100.0.0
        See Also:
        isPopupEnabled()