Interface UIFunctionsUserPrompter

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ICON_ERROR  
      static java.lang.String ICON_INFO  
      static java.lang.String ICON_WARNING  
    • Method Detail

      • getAutoCloseInMS

        int getAutoCloseInMS()
        Returns the number milliseconds the prompt will wait around until it auto closes. Timer starts after the user is prompted (when #open() is called), and typically does not decrease while the user is viewing the prompt (certain implementations may operate differently)
        Returns:
        MS before prompt auto-closes, 0 for no auto-close
        Since:
        3.0.0.9
      • getHtml

        java.lang.String getHtml()
        Returns the HTML that will be displayed along with the prompt

        TODO: Create a boolean canHandleHTML()

        Returns:
        Since:
        3.0.0.9
      • getRememberID

        java.lang.String getRememberID()
        Retrieves the Remember ID associated with this prompt
        Returns:
        Remember ID
        Since:
        3.0.0.9
      • getRememberText

        java.lang.String getRememberText()
        Retrieves the text to be displayed by the "Remember this Action" checkbox
        Returns:
        Remember text
        Since:
        3.0.0.9
      • open

        void open​(UserPrompterResultListener l)
        Opens the prompt. returns when user has chosen an action, or auto-close
        Since:
        3.0.0.9
      • waitUntilClosed

        int waitUntilClosed()
      • setAutoCloseInMS

        void setAutoCloseInMS​(int autoCloseInMS)
        Sets the # of milliseconds before auto closing. Timer starts after the user is prompted (when #open() is called), and typically does not decrease while the user is viewing the prompt (certain implementations may operate differently)
        Parameters:
        autoCloseInMS -
        Since:
        3.0.0.9
      • setHtml

        void setHtml​(java.lang.String html)
        Parameters:
        html -
        Since:
        3.0.0.9
      • setRemember

        void setRemember​(java.lang.String rememberID,
                         boolean rememberByDefault,
                         java.lang.String rememberText)
        Parameters:
        rememberID -
        rememberByDefault -
        Since:
        4.2.0.9
      • setRememberText

        void setRememberText​(java.lang.String rememberText)
        Parameters:
        rememberText -
        Since:
        3.0.0.9
      • setRememberOnlyIfButton

        void setRememberOnlyIfButton​(int button)
        Parameters:
        button -
        Since:
        5601
      • setUrl

        void setUrl​(java.lang.String url)
        Parameters:
        url -
        Since:
        3.0.0.9
      • isAutoClosed

        boolean isAutoClosed()
        Determines if the prompt was auto closed after #open() was called, or if the user chose an option.
        Returns:
        true: auto-closed after timeout
        false: user chose an option
        Since:
        3.0.0.9
      • setIconResource

        void setIconResource​(java.lang.String resource)
        Parameters:
        resource - image repository resource name (e.g. "error", "warning", "info")
        Since:
        3.0.4.3
      • setRelatedObjects

        void setRelatedObjects​(java.lang.Object[] relatedObjects)
      • setRelatedObject

        void setRelatedObject​(java.lang.Object relatedObject)
        Parameters:
        relatedObject -
        Since:
        3.0.0.9
      • setOneInstanceOf

        void setOneInstanceOf​(java.lang.String instanceID)
        Prevent more than one dialog of instanceID from showing up at once
        Parameters:
        instanceID -