FileDocCategorySizeDatePackage
UIFunctionsUserPrompter.javaAPI DocAzureus 3.0.3.43310Mon Mar 19 13:12:20 GMT 2007com.aelitis.azureus.ui

UIFunctionsUserPrompter

public interface UIFunctionsUserPrompter
author
TuxPaper
created
Mar 18, 2007

Fields Summary
Constructors Summary
Methods Summary
public intgetAutoCloseInMS()
Returns the number milliseconds the prompt will wait around until it auto closes. Timer starts after the user is prompted (when {@link #open()} is called), and typically does not decrease while the user is viewing the prompt (certain implementations may operate differently)

return
MS before prompt auto-closes, 0 for no auto-close
since
3.0.0.9

public java.lang.StringgetHtml()
Returns the HTML that will be displayed along with the prompt

TODO: Create a boolean canHandleHTML()

return
since
3.0.0.9

public java.lang.StringgetRememberID()
Retrieves the Remember ID associated with this prompt

return
Remember ID
since
3.0.0.9

public java.lang.StringgetRememberText()
Retrieves the text to be displayed by the "Remember this Action" checkbox

return
Remember text
since
3.0.0.9

public booleanisAutoClosed()
Determines if the prompt was auto closed after {@link #open()} was called, or if the user chose an option.

return
true: auto-closed after timeout
false: user chose an option
since
3.0.0.9

public intopen()
Opens the prompt. returns when user has chosen an action, or auto-close

return
Button number the user pressed
since
3.0.0.9

public voidsetAutoCloseInMS(int autoCloseInMS)
Sets the # of milliseconds before auto closing. Timer starts after the user is prompted (when {@link #open()} is called), and typically does not decrease while the user is viewing the prompt (certain implementations may operate differently)

param
autoCloseInMS
since
3.0.0.9

public voidsetHtml(java.lang.String html)

param
html
since
3.0.0.9

public voidsetRelatedObject(java.lang.Object relatedObject)

param
relatedObject
since
3.0.0.9

public voidsetRelatedObjects(java.lang.Object[] relatedObjects)

public voidsetRememberID(java.lang.String rememberID, boolean rememberByDefault)

param
rememberID
param
rememberByDefault
since
3.0.0.9

public voidsetRememberText(java.lang.String rememberText)

param
rememberText
since
3.0.0.9

public voidsetUrl(java.lang.String url)

param
url
since
3.0.0.9