edu.utexas.its.eis.tools.qwicap.servlet
Class PromptModifiers

java.lang.Object
  edu.utexas.its.eis.tools.qwicap.servlet.PromptModifiers

public class PromptModifiers
extends Object

See Qwicap.prompt() for an explanation, and examples, of the use of this class.

Author:

Chris W. Johnson

Method Summary

PromptModifiers	modally() Instructs Qwicap to prompt in a modal manner.
PromptModifiers	modelessly() Instructs Qwicap to prompt in a modeless manner.
PromptModifiers	rejectingWithFormData() Instructs Qwicap to embed the form control values submitted by the user into the relevant page when any of the Qwicap.rejectInput methods are invoked.
PromptModifiers	rejectingWithoutFormData() Instructs Qwicap not to embed the form control values submitted by the user into the relevant page when any of the Qwicap.rejectInput methods are invoked.
String	toString()
Qwicap	usingPage(MutableMarkup XHTMLPage) Prompts the user with the specified page, in a manner consistent with the previously specified modifiers.
PromptModifiers	withFormData() Instructs Qwicap to embed the form control values submitted by the user into the relevant page before it is sent to the client.
PromptModifiers	withoutFormData() Instructs Qwicap not to embed the form control values submitted by the user into the relevant page.

Methods inherited from class java.lang.Object

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

Method Detail

modally

public PromptModifiers modally()

Instructs Qwicap to prompt in a modal manner.

Returns:

A reference to this PromptModifiers instance.

See Also:

modelessly()

modelessly

public PromptModifiers modelessly()

Instructs Qwicap to prompt in a modeless manner. This is the default setting, so you never have to invoke it. It is only included for clarity.

Returns:

A reference to this PromptModifiers instance.

See Also:

modally()

withFormData

public PromptModifiers withFormData()

Instructs Qwicap to embed the form control values submitted by the user into the relevant page before it is sent to the client. This is the default setting, so you never have to invoke it. It is only included for clarity.

Returns:

A reference to this PromptModifiers instance.

See Also:

withoutFormData()

withoutFormData

public PromptModifiers withoutFormData()

Instructs Qwicap not to embed the form control values submitted by the user into the relevant page.

Returns:

A reference to this PromptModifiers instance.

See Also:

withFormData()

rejectingWithFormData

public PromptModifiers rejectingWithFormData()

Instructs Qwicap to embed the form control values submitted by the user into the relevant page when any of the Qwicap.rejectInput methods are invoked. If withoutFormData() has been invoked, this embedding is temporary, and the page is restored to its original state when rejectInput is complete. This is the default setting, so you never have to invoke it. It is only included for clarity.

Returns:

A reference to this PromptModifiers instance.

See Also:

rejectingWithoutFormData()

rejectingWithoutFormData

public PromptModifiers rejectingWithoutFormData()

Instructs Qwicap not to embed the form control values submitted by the user into the relevant page when any of the Qwicap.rejectInput methods are invoked. Note that this setting is relevant even when withoutFormData() has been invoked.

Returns:

A reference to this PromptModifiers instance.

See Also:

rejectingWithFormData()

usingPage

public Qwicap usingPage(MutableMarkup XHTMLPage)
                 throws QwicapException

Prompts the user with the specified page, in a manner consistent with the previously specified modifiers. Unless this method is invoked, no prompting will take place.

Parameters:

XHTMLPage - XHTML page to be sent to the user.

Returns:

A reference to the current Qwicap object, just in case it's convenient.

Throws:

QwicapException - If anything goes wrong, or if the page is abandoned.

toString

public String toString()

Overrides:

toString in class Object