public class

FormDialog

extends JiraDialog
java.lang.Object
   ↳ com.atlassian.jira.pageobjects.dialogs.JiraDialog
     ↳ com.atlassian.jira.pageobjects.dialogs.FormDialog
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Represents a JIRA from dialog. These type of Dialogs basically slurp HTML from the server and display it on the client side. Input is submitted to a back end action. This action will either indicate that the action was a success or will return HTML with errors in it for display to the user.

Summary

Constants
String FORM_SUBMITTING_CLASS
[Expand]
Inherited Constants
From class com.atlassian.jira.pageobjects.dialogs.JiraDialog
Fields
protected PageElement form
protected PageElement header
protected PageElement loading
protected FormMessages messages
[Expand]
Inherited Fields
From class com.atlassian.jira.pageobjects.dialogs.JiraDialog
Public Constructors
FormDialog(String id)
FormDialog()
Public Methods
void close()
Close the dialog by clicking on the kindly ever-present cancel button.
void escape()
Closes the dialog by hitting ESC
AuiMessage getAuiMessage()
TimedQuery<Iterable<PageElement>> getFormErrorElements()
List<String> getFormErrorList()
Return a list of the form errors currently on the dialog.
Map<String, String> getFormErrors()
Return a mapping of the errors currently on the form.
TimedQuery<String> getTimedTitle()
String getTitle()
boolean hasFormErrors()
Return true iff the dialog has error messages contained in its associated form.
final void initAbstractDialog()
FormMessages messages()
final void ready()
Called when the dialog is first displayed.
FormDialog waitForFormErrors()
Waits for at least one error to be visible
Protected Methods
void assertDialogClosed()
void assertDialogOpen()
PageElement getDialogElement()
static void setElement(PageElement element, String value)
boolean submit(String name)
Do a submit on the passed the form element with the passed name.
boolean submit(By locator)
Do a submit on the passed element found using the passed locator.
boolean submit(PageElement pageElement)
Do a submit on the passed element.
void waitUntilClosed()
void waitUntilHidden()
void waitWhileSubmitting()
[Expand]
Inherited Methods
From class com.atlassian.jira.pageobjects.dialogs.JiraDialog
From class java.lang.Object

Constants

public static final String FORM_SUBMITTING_CLASS

Constant Value: "submitting"

Fields

protected PageElement form

protected PageElement header

protected PageElement loading

protected FormMessages messages

Public Constructors

public FormDialog (String id)

public FormDialog ()

Public Methods

public void close ()

Close the dialog by clicking on the kindly ever-present cancel button.

public void escape ()

Closes the dialog by hitting ESC

public AuiMessage getAuiMessage ()

public TimedQuery<Iterable<PageElement>> getFormErrorElements ()

public List<String> getFormErrorList ()

Return a list of the form errors currently on the dialog.

Returns
  • a list of form errors currently on the dialog.

public Map<String, String> getFormErrors ()

Return a mapping of the errors currently on the form. The mapping if from parameterName -> error.

Returns
  • a mapping from parameterName -> error of all the errors currently on the form.

public TimedQuery<String> getTimedTitle ()

public String getTitle ()

public boolean hasFormErrors ()

Return true iff the dialog has error messages contained in its associated form.

Returns
  • true iff the dialog has error messages contained in its associated form.

public final void initAbstractDialog ()

public FormMessages messages ()

public final void ready ()

Called when the dialog is first displayed. Waits util the dialog is ready to work with before exiting.

public FormDialog waitForFormErrors ()

Waits for at least one error to be visible

Returns
  • this

Protected Methods

protected void assertDialogClosed ()

protected void assertDialogOpen ()

protected PageElement getDialogElement ()

protected static void setElement (PageElement element, String value)

protected boolean submit (String name)

Do a submit on the passed the form element with the passed name. The method will then wait for the response from the server before returning.

Parameters
name the name of the element to submit.
Returns
  • true if the dialog is still open.

protected boolean submit (By locator)

Do a submit on the passed element found using the passed locator. The method will then wait for the response from the server before returning.

Parameters
locator for the element to select.
Returns
  • true if the dialog is still open.

protected boolean submit (PageElement pageElement)

Do a submit on the passed element. The method will then wait for the response from the server before returning.

Parameters
pageElement the page element to submit.
Returns
  • true if the dialog is still open.

protected void waitUntilClosed ()

protected void waitUntilHidden ()

protected void waitWhileSubmitting ()