Package com.groiss.smartclient

Class ClientUtil.DialogConfiguration

java.lang.Object

com.groiss.smartclient.ClientUtil.DialogConfiguration

Enclosing class:

ClientUtil

public static final class ClientUtil.DialogConfiguration
extends Object

A configuration object that holds all the settings to be used for presenting the requested dialog on the clientside

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ClientUtil.DialogConfiguration.ChoiceType	for ClientUtil.DialogConfiguration.Type.CHOICE dialogs to specify the kind of input to be used for the options
static enum	ClientUtil.DialogConfiguration.Type	Type of dialog.

Constructor Summary

Constructors

Constructor	Description
DialogConfiguration()

Method Summary

Modifier and Type	Method	Description
boolean	getAllowHTML()	If true, the message may contain HTML text
ClientUtil.DialogConfiguration.ChoiceType	getChoiceType()
String	getConfirmValue()
String	getMessage()
Collection<Pair<String,String>>	getOptions()
String	getTitle()	get the title
ClientUtil.DialogConfiguration.Type	getType()	get the type of dialog
ClientUtil.DialogConfiguration	setAllowHTML(boolean allowHTML)	Set to true if the message contains HTML text.
ClientUtil.DialogConfiguration	setChoiceType(ClientUtil.DialogConfiguration.ChoiceType type)	define which kind of control to be used. default value: ClientUtil.DialogConfiguration.ChoiceType.RADIO
ClientUtil.DialogConfiguration	setConfirmValue(String confirmValue)	define what value will be submitted when confirming the ClientUtil.DialogConfiguration.Type.CONFIRM-dialog default value: "true"
ClientUtil.DialogConfiguration	setMessage(String message)	set the dialog message
ClientUtil.DialogConfiguration	setOptions(Collection<Pair<String,String>> options)	set the options to be used for ClientUtil.DialogConfiguration.Type.CHOICE
ClientUtil.DialogConfiguration	setTitle(String title)	set the dialog-title, default value: Question
ClientUtil.DialogConfiguration	setType(ClientUtil.DialogConfiguration.Type type)	set the type of dialog to be used, default value: ClientUtil.DialogConfiguration.Type.CONFIRM

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DialogConfiguration

public DialogConfiguration()

Method Details

setMessage

public ClientUtil.DialogConfiguration setMessage(String message)

set the dialog message

Parameters:

message -

Returns:

the current ClientUtil.DialogConfiguration for joining

getMessage

public String getMessage()

Returns:

the message

setAllowHTML

public ClientUtil.DialogConfiguration setAllowHTML(boolean allowHTML)

Set to true if the message contains HTML text.

getAllowHTML

public boolean getAllowHTML()

If true, the message may contain HTML text

setTitle

public ClientUtil.DialogConfiguration setTitle(String title)

set the dialog-title, default value: Question

Parameters:

title -

Returns:

the current ClientUtil.DialogConfiguration for joining

getTitle

public String getTitle()

get the title

Returns:

setType

public ClientUtil.DialogConfiguration setType(ClientUtil.DialogConfiguration.Type type)

set the type of dialog to be used, default value: ClientUtil.DialogConfiguration.Type.CONFIRM

Parameters:

type -

Returns:

the current ClientUtil.DialogConfiguration for joining

getType

public ClientUtil.DialogConfiguration.Type getType()

get the type of dialog

Returns:

setOptions

public ClientUtil.DialogConfiguration setOptions(Collection<Pair<String,String>> options)

set the options to be used for ClientUtil.DialogConfiguration.Type.CHOICE

Parameters:

options -

Returns:

getOptions

public Collection<Pair<String,String>> getOptions()

Returns:

the choices

getChoiceType

public ClientUtil.DialogConfiguration.ChoiceType getChoiceType()

Returns:

the choiceType

setChoiceType

public ClientUtil.DialogConfiguration setChoiceType(ClientUtil.DialogConfiguration.ChoiceType type)

define which kind of control to be used. default value: ClientUtil.DialogConfiguration.ChoiceType.RADIO

Parameters:

type -

Returns:

setConfirmValue

public ClientUtil.DialogConfiguration setConfirmValue(String confirmValue)

define what value will be submitted when confirming the ClientUtil.DialogConfiguration.Type.CONFIRM-dialog default value: "true"

Parameters:

confirmValue - the confirmValue to set

getConfirmValue

public String getConfirmValue()

Returns:

the confirmValue