Interface UIFunctionsUserPrompter

All Known Implementing Classes:

MessageBoxShell, VuzeMessageBox

public interface UIFunctionsUserPrompter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ICON_ERROR
static final String	ICON_INFO
static final String	ICON_WARNING

Method Summary

Modifier and Type	Method	Description
int	getAutoCloseInMS()	Returns the number milliseconds the prompt will wait around until it auto closes.
String	getHtml()	Returns the HTML that will be displayed along with the prompt
String	getRememberID()	Retrieves the Remember ID associated with this prompt
String	getRememberText()	Retrieves the text to be displayed by the "Remember this Action" checkbox
boolean	isAutoClosed()	Determines if the prompt was auto closed after invalid reference #open() was called, or if the user chose an option.
void	open(UserPrompterResultListener l)	Opens the prompt.
void	setAutoCloseInMS(int autoCloseInMS)	Sets the # of milliseconds before auto closing.
void	setHtml(String html)
void	setIconResource(String resource)
void	setOneInstanceOf(String instanceID)	Prevent more than one dialog of instanceID from showing up at once
void	setRelatedObject(Object relatedObject)
void	setRelatedObjects(Object[] relatedObjects)
void	setRemember(String rememberID, boolean rememberByDefault, String rememberText)
void	setRememberOnlyIfButton(int button)
void	setRememberText(String rememberText)
void	setStyle(int style)
void	setUrl(String url)
int	waitUntilClosed()

Field Details

ICON_WARNING

static final String ICON_WARNING

See Also:

• Constant Field Values

ICON_INFO

static final String ICON_INFO

See Also:

• Constant Field Values

ICON_ERROR

static final String ICON_ERROR

See Also:

• Constant Field Values

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

invalid reference

#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 prompt

TODO: 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

setStyle

void setStyle(int style)

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

invalid reference

#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(String html)

Parameters:

html -

Since:

3.0.0.9

setRemember

void setRemember(String rememberID,
 boolean rememberByDefault,
 String rememberText)

Parameters:

rememberID -

rememberByDefault -

Since:

4.2.0.9

setRememberText

void setRememberText(String rememberText)

Parameters:

rememberText -

Since:

3.0.0.9

setRememberOnlyIfButton

void setRememberOnlyIfButton(int button)

Parameters:

button -

Since:

5601

setUrl

void setUrl(String url)

Parameters:

url -

Since:

3.0.0.9

isAutoClosed

boolean isAutoClosed()

Determines if the prompt was auto closed after

invalid reference

#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(String resource)

Parameters:

resource - image repository resource name (e.g. "error", "warning", "info")

Since:

3.0.4.3

setRelatedObjects

void setRelatedObjects(Object[] relatedObjects)

setRelatedObject

void setRelatedObject(Object relatedObject)

Parameters:

relatedObject -

Since:

3.0.0.9

setOneInstanceOf

void setOneInstanceOf(String instanceID)

Prevent more than one dialog of instanceID from showing up at once

Parameters:

instanceID -