Skip to content

Commit c0c4cde

Browse files
vmassolvmassol
committed
[Misc] Rename FormElement into FormContainerElement since it doesn't represent a form element but a container onto one or several form elements
1 parent 49ba258 commit c0c4cde

File tree

18 files changed

+73
-70
lines changed

18 files changed

+73
-70
lines changed

‎xwiki-platform-core/xwiki-platform-administration/xwiki-platform-administration-test/xwiki-platform-administration-test-pageobjects/src/main/java/org/xwiki/administration/test/po/AdministrationSectionPage.java‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import org.openqa.selenium.By;
2323
import org.openqa.selenium.WebElement;
2424
import org.openqa.selenium.support.FindBy;
25-
import org.xwiki.test.ui.po.FormElement;
25+
import org.xwiki.test.ui.po.FormContainerElement;
2626
import org.xwiki.test.ui.po.ViewPage;
2727

2828
/**
@@ -36,10 +36,12 @@ public class AdministrationSectionPage extends ViewPage
3636
@FindBy(xpath = "//input[@type='submit'][@name='formactionsac']")
3737
private WebElement saveButton;
3838

39-
// The admin-page-content div is being treated as a form since it may contain multiple forms and we want to be able
40-
// to access elements in them all.
39+
/**
40+
* The admin-page-content div is being treated as a form since it may contain multiple forms and we want to be able
41+
* to access elements in them all.
42+
*/
4143
@FindBy(xpath = "//div[@id='admin-page-content']")
42-
private WebElement form;
44+
private WebElement formContainer;
4345

4446
private final String section;
4547

@@ -75,9 +77,9 @@ public void clickSave()
7577
this.saveButton.click();
7678
}
7779

78-
public FormElement getForm()
80+
public FormContainerElement getFormContainerElement()
7981
{
80-
return new FormElement(form);
82+
return new FormContainerElement(this.formContainer);
8183
}
8284

8385
public boolean hasLink(String linkName)

‎xwiki-platform-core/xwiki-platform-appwithinminutes/xwiki-platform-appwithinminutes-test-pageobjects/src/main/java/org/xwiki/appwithinminutes/test/po/EntryEditPage.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import org.apache.commons.lang3.StringUtils;
2626
import org.openqa.selenium.By;
2727
import org.openqa.selenium.WebElement;
28-
import org.xwiki.test.ui.po.FormElement;
28+
import org.xwiki.test.ui.po.FormContainerElement;
2929
import org.xwiki.test.ui.po.InlinePage;
3030

3131
/**
@@ -79,7 +79,7 @@ public List<String> getFieldNames()
7979
*/
8080
public void setTitle(String title)
8181
{
82-
new FormElement(getForm()).setFieldValue(By.name("title"), title);
82+
new FormContainerElement(getForm()).setFieldValue(By.name("title"), title);
8383
}
8484

8585
/**
@@ -97,7 +97,7 @@ public String getTitle()
9797
*/
9898
public void setContent(String content)
9999
{
100-
new FormElement(getForm()).setFieldValue(By.name("content"), content);
100+
new FormContainerElement(getForm()).setFieldValue(By.name("content"), content);
101101
}
102102

103103
/**

‎xwiki-platform-core/xwiki-platform-invitation/xwiki-platform-invitation-test-pageobject/src/main/java/org/xwiki/invitation/test/po/InvitationSenderPage.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import org.openqa.selenium.WebElement;
2727
import org.openqa.selenium.support.FindBy;
2828
import org.xwiki.test.ui.po.BasePage;
29-
import org.xwiki.test.ui.po.FormElement;
29+
import org.xwiki.test.ui.po.FormContainerElement;
3030
import org.xwiki.test.ui.po.TableElement;
3131

3232
/**
@@ -40,7 +40,7 @@ public class InvitationSenderPage extends BasePage
4040
@FindBy(id = "invitation-sender-form")
4141
private WebElement form;
4242

43-
private FormElement formElement;
43+
private FormContainerElement formElement;
4444

4545
@FindBy(xpath = "//form[@id='invitation-sender-form']/div/div/span/input[@type='submit'][@name='preview']")
4646
private WebElement previewButton;
@@ -114,10 +114,10 @@ public InvitationMessageDisplayElement preview()
114114
return this.previewElement;
115115
}
116116

117-
public FormElement getForm()
117+
public FormContainerElement getForm()
118118
{
119119
if (this.formElement == null) {
120-
this.formElement = new FormElement(this.form);
120+
this.formElement = new FormContainerElement(this.form);
121121
}
122122
return this.formElement;
123123
}

‎xwiki-platform-core/xwiki-platform-test/xwiki-platform-test-ui/src/main/java/org/xwiki/test/ui/po/AbstractRegistrationPage.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public abstract class AbstractRegistrationPage extends BasePage
3939
@FindBy(id = "register")
4040
private WebElement registerFormElement;
4141

42-
private FormElement form;
42+
private FormContainerElement form;
4343

4444
public abstract void clickRegister();
4545

@@ -80,10 +80,10 @@ public void fillRegisterForm(final String firstName, final String lastName, fina
8080
}
8181
}
8282

83-
private FormElement getForm()
83+
private FormContainerElement getForm()
8484
{
8585
if (this.form == null) {
86-
this.form = new FormElement(this.registerFormElement);
86+
this.form = new FormContainerElement(this.registerFormElement);
8787
}
8888
return this.form;
8989
}

‎xwiki-platform-core/xwiki-platform-test/xwiki-platform-test-ui/src/main/java/org/xwiki/test/ui/po/FormElement.java‎ renamed to ‎xwiki-platform-core/xwiki-platform-test/xwiki-platform-test-ui/src/main/java/org/xwiki/test/ui/po/FormContainerElement.java‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,31 +31,32 @@
3131
import org.openqa.selenium.support.ui.Select;
3232

3333
/**
34-
* Represents a Form.
34+
* Represents a container element holding one or several forms and provide utility methods to get/set form data. This
35+
* container element can be a FORM element. It can also be some DIV element wrapping several FORM elements.
3536
*
3637
* @version $Id$
3738
* @since 3.2M3
3839
*/
39-
public class FormElement extends BaseElement
40+
public class FormContainerElement extends BaseElement
4041
{
41-
private final WebElement form;
42+
private final WebElement formContainer;
4243

43-
public FormElement(WebElement form)
44+
public FormContainerElement(WebElement formContainer)
4445
{
45-
this.form = form;
46+
this.formContainer = formContainer;
4647
}
4748

48-
protected WebElement getForm()
49+
protected WebElement getFormContainer()
4950
{
50-
return this.form;
51+
return this.formContainer;
5152
}
5253

5354
public void fillFieldsByName(Map<String, String> valuesByNames)
5455
{
55-
Map<WebElement, String> valuesByElements = new HashMap<WebElement, String>((int) (valuesByNames.size() / 0.75));
56+
Map<WebElement, String> valuesByElements = new HashMap<>((int) (valuesByNames.size() / 0.75));
5657

5758
for (String name : valuesByNames.keySet()) {
58-
valuesByElements.put(this.form.findElement(By.name(name)), valuesByNames.get(name));
59+
valuesByElements.put(getFormContainer().findElement(By.name(name)), valuesByNames.get(name));
5960
}
6061
fillFieldsByElements(valuesByElements);
6162
}
@@ -74,12 +75,12 @@ public void fillFieldsByElements(Map<WebElement, String> valuesByElements)
7475

7576
public String getFieldValue(By findElementBy)
7677
{
77-
return this.form.findElement(findElementBy).getAttribute("value");
78+
return getFormContainer().findElement(findElementBy).getAttribute("value");
7879
}
7980

8081
public void setFieldValue(By findElementBy, String value)
8182
{
82-
setFieldValue(this.form.findElement(findElementBy), value);
83+
setFieldValue(getFormContainer().findElement(findElementBy), value);
8384
}
8485

8586
public void setFieldValue(WebElement fieldElement, String value)
@@ -97,7 +98,7 @@ public void setFieldValue(WebElement fieldElement, String value)
9798

9899
public void setCheckBox(By findElementBy, boolean checked)
99100
{
100-
setCheckBox(form.findElement(findElementBy), checked);
101+
setCheckBox(getFormContainer().findElement(findElementBy), checked);
101102
}
102103

103104
public void setCheckBox(WebElement checkBoxElement, boolean checked)
@@ -116,7 +117,7 @@ public void setCheckBox(WebElement checkBoxElement, boolean checked)
116117

117118
public SelectElement getSelectElement(By by)
118119
{
119-
return this.new SelectElement(this.form.findElement(by));
120+
return this.new SelectElement(getFormContainer().findElement(by));
120121
}
121122

122123
public class SelectElement extends BaseElement
@@ -144,7 +145,7 @@ private Map<String, WebElement> getOptionsByValue()
144145
return this.optionsByValue;
145146
}
146147
List<WebElement> elements = this.select.findElements(By.tagName("option"));
147-
this.optionsByValue = new HashMap<String, WebElement>((int) (elements.size() / 0.75));
148+
this.optionsByValue = new HashMap<>((int) (elements.size() / 0.75));
148149
for (WebElement el : elements) {
149150
this.optionsByValue.put(el.getAttribute("value"), el);
150151
}

‎xwiki-platform-core/xwiki-platform-test/xwiki-platform-test-ui/src/main/java/org/xwiki/test/ui/po/InlinePage.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ public WebElement getForm()
167167
public String getValue(String fieldName)
168168
{
169169
String xpath = String.format(FIELD_XPATH_FORMAT, fieldName.length(), fieldName);
170-
return new FormElement(getForm()).getFieldValue(By.xpath(xpath));
170+
return new FormContainerElement(getForm()).getFieldValue(By.xpath(xpath));
171171
}
172172

173173
/**
@@ -182,10 +182,10 @@ public void setValue(String fieldName, String fieldValue)
182182
String xpath = String.format(FIELD_XPATH_FORMAT, fieldName.length(), fieldName);
183183
WebElement field = getForm().findElement(By.xpath(xpath));
184184
if (field.getAttribute("name").equals(field.getAttribute("id"))) {
185-
new FormElement(getForm()).setFieldValue(field, fieldValue);
185+
new FormContainerElement(getForm()).setFieldValue(field, fieldValue);
186186
} else {
187187
xpath = String.format("//*[@name = '%s' and @value = '%s']", field.getAttribute("name"), fieldValue);
188-
new FormElement(getForm()).setCheckBox(By.xpath(xpath), true);
188+
new FormContainerElement(getForm()).setCheckBox(By.xpath(xpath), true);
189189
}
190190
}
191191

‎xwiki-platform-core/xwiki-platform-test/xwiki-platform-test-ui/src/main/java/org/xwiki/test/ui/po/editor/ClassEditPage.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import org.openqa.selenium.By;
2323
import org.openqa.selenium.WebElement;
2424
import org.openqa.selenium.support.FindBy;
25-
import org.xwiki.test.ui.po.FormElement;
25+
import org.xwiki.test.ui.po.FormContainerElement;
2626

2727
/**
2828
* Represents the common actions possible on all Pages when using the "edit" action with the "class" editor.
@@ -47,7 +47,7 @@ public class ClassEditPage extends EditPage
4747
@FindBy(name = "action_propadd")
4848
private WebElement propertySubmit;
4949

50-
private FormElement form;
50+
private FormContainerElement form;
5151

5252
/**
5353
* Go to the passed page in object edit mode.
@@ -89,10 +89,10 @@ public void deleteProperty(String propertyName)
8989
getDriver().waitUntilElementDisappears(propertyLocator);
9090
}
9191

92-
private FormElement getForm()
92+
private FormContainerElement getForm()
9393
{
9494
if (this.form == null) {
95-
this.form = new FormElement(this.propertyForm);
95+
this.form = new FormContainerElement(this.propertyForm);
9696
}
9797
return this.form;
9898
}

‎xwiki-platform-core/xwiki-platform-test/xwiki-platform-test-ui/src/main/java/org/xwiki/test/ui/po/editor/ClassPropertyEditPane.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
import org.openqa.selenium.By;
2323
import org.xwiki.test.ui.po.BaseElement;
24-
import org.xwiki.test.ui.po.FormElement;
24+
import org.xwiki.test.ui.po.FormContainerElement;
2525

2626
/**
2727
* Represents the pane used to edit a class property.
@@ -34,7 +34,7 @@ public class ClassPropertyEditPane extends BaseElement
3434
/**
3535
* The class editor form.
3636
*/
37-
private final FormElement form;
37+
private final FormContainerElement form;
3838

3939
/**
4040
* The edited property.
@@ -47,7 +47,7 @@ public class ClassPropertyEditPane extends BaseElement
4747
* @param form the class editor form
4848
* @param propertyName the name of the edited property
4949
*/
50-
public ClassPropertyEditPane(FormElement form, String propertyName)
50+
public ClassPropertyEditPane(FormContainerElement form, String propertyName)
5151
{
5252
this.form = form;
5353
this.propertyName = propertyName;

‎xwiki-platform-core/xwiki-platform-test/xwiki-platform-test-ui/src/main/java/org/xwiki/test/ui/po/editor/DatabaseListClassEditElement.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
*/
2020
package org.xwiki.test.ui.po.editor;
2121

22-
import org.xwiki.test.ui.po.FormElement;
22+
import org.xwiki.test.ui.po.FormContainerElement;
2323

2424
/**
2525
* Represents a DatabaseListClass property form.
@@ -29,7 +29,7 @@
2929
*/
3030
public class DatabaseListClassEditElement extends ClassPropertyEditPane
3131
{
32-
public DatabaseListClassEditElement(FormElement form, String propertyName)
32+
public DatabaseListClassEditElement(FormContainerElement form, String propertyName)
3333
{
3434
super(form, propertyName);
3535
}

‎xwiki-platform-core/xwiki-platform-test/xwiki-platform-test-ui/src/main/java/org/xwiki/test/ui/po/editor/NumberClassEditElement.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
*/
2020
package org.xwiki.test.ui.po.editor;
2121

22-
import org.xwiki.test.ui.po.FormElement;
22+
import org.xwiki.test.ui.po.FormContainerElement;
2323

2424
/**
2525
* Represents a NumberClass property form.
@@ -29,7 +29,7 @@
2929
*/
3030
public class NumberClassEditElement extends ClassPropertyEditPane
3131
{
32-
public NumberClassEditElement(FormElement form, String propertyName)
32+
public NumberClassEditElement(FormContainerElement form, String propertyName)
3333
{
3434
super(form, propertyName);
3535
}

0 commit comments

Comments
 (0)