Package com.biglybt.ui
Interface UIFunctionsUserPrompter
- All Known Implementing Classes:
MessageBoxShell
,VuzeMessageBox
public interface UIFunctionsUserPrompter
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number milliseconds the prompt will wait around until it auto closes.getHtml()
Returns the HTML that will be displayed along with the promptRetrieves the Remember ID associated with this promptRetrieves the text to be displayed by the "Remember this Action" checkboxboolean
Determines if the prompt was auto closed after#open()
was called, or if the user chose an option.void
Opens the prompt.void
setAutoCloseInMS
(int autoCloseInMS) Sets the # of milliseconds before auto closing.void
void
setIconResource
(String resource) void
setOneInstanceOf
(String instanceID) Prevent more than one dialog of instanceID from showing up at oncevoid
setRelatedObject
(Object relatedObject) void
setRelatedObjects
(Object[] relatedObjects) void
setRemember
(String rememberID, boolean rememberByDefault, String rememberText) void
setRememberOnlyIfButton
(int button) void
setRememberText
(String rememberText) void
int
-
Field Details
-
ICON_WARNING
- See Also:
-
ICON_INFO
- See Also:
-
ICON_ERROR
- See Also:
-
-
Method Details
-
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
String getHtml()Returns the HTML that will be displayed along with the promptTODO: Create a boolean canHandleHTML()
- Returns:
- Since:
- 3.0.0.9
-
getRememberID
String getRememberID()Retrieves the Remember ID associated with this prompt- Returns:
- Remember ID
- Since:
- 3.0.0.9
-
getRememberText
String getRememberText()Retrieves the text to be displayed by the "Remember this Action" checkbox- Returns:
- Remember text
- Since:
- 3.0.0.9
-
open
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
- Parameters:
html
-- Since:
- 3.0.0.9
-
setRemember
- Parameters:
rememberID
-rememberByDefault
-- Since:
- 4.2.0.9
-
setRememberText
- Parameters:
rememberText
-- Since:
- 3.0.0.9
-
setRememberOnlyIfButton
void setRememberOnlyIfButton(int button) - Parameters:
button
-- Since:
- 5601
-
setUrl
- 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
- Parameters:
resource
- image repository resource name (e.g. "error", "warning", "info")- Since:
- 3.0.4.3
-
setRelatedObjects
-
setRelatedObject
- Parameters:
relatedObject
-- Since:
- 3.0.0.9
-
setOneInstanceOf
Prevent more than one dialog of instanceID from showing up at once- Parameters:
instanceID
-
-