Merge pull request #1733 from JohnMcGuinness/remove-usage-of-WBeanContainer

Remove usage of WBeanContainer from framework and examples

Author: JohnMcGuinness

CHANGELOG.md

@@ -5,6 +5,11 @@
 ### API Changes
 
 ### Enhancements
+* Removed usage of deprecated APIs from the framework and examples. Including the following:
+    - Replaced usage of `WBeanContainer` with `WContainer`. #1733
+    - Replaced usage of `int` heading levels with `HeadingLevel` values. #1734
+    - Replaced usage of `int` spacing for `FlowLayout` with `Size` based spacing, #1735
+    - Replaced usage of `int` spacing for `ColumnLayout` with `Size` based spacing. #1736
 
 ### Bug Fixes
 

wcomponents-core/src/main/java/com/github/bordertech/wcomponents/WDataTableRowRenderer.java

@@ -171,7 +171,7 @@ private Class<? extends WComponent> getRowRendererClass() {
 	 * The renderer wrapper is responsible for ensuring that the renderer is only used when needed (ie. it is only
 	 * involved in processing of certain rows), and ensuring that data is passed to / from the renderer when required.
 	 */
-	private static final class RendererWrapper extends WBeanContainer implements BeanProvider {
+	private static final class RendererWrapper extends WContainer implements BeanProvider {
 
 		/**
 		 * The table that this wrapper belongs to.

wcomponents-core/src/main/java/com/github/bordertech/wcomponents/WTableRowRenderer.java

@@ -153,7 +153,7 @@ public RowIdWrapper getCurrentRowIdWrapper() {
 	 * The renderer wrapper is responsible for ensuring that the renderer is only used when needed (ie. it is only
 	 * involved in processing of certain rows), and ensuring that data is passed to / from the renderer when required.
 	 */
-	private static final class RendererWrapper extends WBeanContainer implements BeanProvider {
+	private static final class RendererWrapper extends WContainer implements BeanProvider {
 
 		/**
 		 * The table that this wrapper belongs to.

wcomponents-core/src/test/java/com/github/bordertech/wcomponents/AbstractWMultiSelectList_Test.java

@@ -1029,15 +1029,15 @@ public void testDoHandleRequestBeanBound() {
 		// Set Bean Property
 		multi.setBeanProperty("myOptions");
 
-		WBeanContainer beanContainer = new WBeanContainer();
-		beanContainer.add(multi);
+		WContainer container = new WContainer();
+		container.add(multi);
 
 		multi.setLocked(true);
 		setActiveContext(createUIContext());
 
 		// Set a Bean that has no selections
 		MyBean bean = new MyBean();
-		beanContainer.setBean(bean);
+		container.setBean(bean);
 
 		// Test Nothing Selected and Empty Request (No Change)
 		MockRequest request = setupNothingSelectedRequest(multi);

wcomponents-core/src/test/java/com/github/bordertech/wcomponents/AbstractWSingleSelectList_Test.java

@@ -776,15 +776,15 @@ public void testDoHandleRequestBeanBound() {
 		// Set Bean Property
 		single.setBeanProperty("myOption");
 
-		WBeanContainer beanContainer = new WBeanContainer();
-		beanContainer.add(single);
+		WContainer container = new WContainer();
+		container.add(single);
 
 		single.setLocked(true);
 		setActiveContext(createUIContext());
 
 		// Set a Bean that has no selections
 		MyBean bean = new MyBean();
-		beanContainer.setBean(bean);
+		container.setBean(bean);
 
 		// Test Nothing Selected and Empty Request (No Change)
 		MockRequest request = setupNothingSelectedRequest(single);

wcomponents-core/src/test/java/com/github/bordertech/wcomponents/UIContextImpl_Test.java

@@ -416,7 +416,7 @@ public void handleRequest(final Request request) {
 
 		// Setup the top level repeater
 		WRepeater repeater = new WRepeater();
-		WBeanContainer content = new WBeanContainer() {
+		WContainer content = new WContainer() {
 			@Override
 			public void handleRequest(final Request request) {
 				super.handleRequest(request);
@@ -513,7 +513,7 @@ public void handleRequest(final Request request) {
 
 		// Setup the top level repeater
 		WRepeater repeater = new WRepeater();
-		WBeanContainer content = new WBeanContainer();
+		WContainer content = new WContainer();
 		content.add(repeater2);
 		repeater.setRepeatedComponent(content);
 

wcomponents-core/src/test/java/com/github/bordertech/wcomponents/WComponentsPerformance_Test.java

@@ -47,9 +47,9 @@ public void testWComponentAppCorrectness() throws Exception {
 
 		setActiveContext(uic);
 		Assert.assertEquals("Incorrect property1 value", "p1_1",
-				((SimpleFormBean) app.beanContainer.getBean()).getProperty1());
+				((SimpleFormBean) app.container.getBean()).getProperty1());
 		Assert.assertEquals("Incorrect property2 value", "p2_1",
-				((SimpleFormBean) app.beanContainer.getBean()).getProperty2());
+				((SimpleFormBean) app.container.getBean()).getProperty2());
 	}
 
 	/**
@@ -181,13 +181,13 @@ private void sendSimpleRequest(final HttpSession session, final int step) {
 	 */
 	public static final class SimpleApp extends WApplication {
 
-		private final WBeanContainer beanContainer = new WBeanContainer();
+		private final WContainer container = new WContainer();
 
 		/**
 		 * Creates a SimpleApp.
 		 */
 		public SimpleApp() {
-			add(beanContainer);
+			add(container);
 
 			WTextField property1 = new WTextField();
 			WTextField property2 = new WTextField();
@@ -198,30 +198,30 @@ public SimpleApp() {
 			property1.setIdName("txt1");
 			property2.setIdName("txt2");
 
-			beanContainer.add(new WLabel("Property 1:", property1));
-			beanContainer.add(property1);
-			beanContainer.add(new WLabel("Property 2:", property2));
-			beanContainer.add(property2);
+			container.add(new WLabel("Property 1:", property1));
+			container.add(property1);
+			container.add(new WLabel("Property 2:", property2));
+			container.add(property2);
 
 			WButton submit = new WButton("Submit");
 			submit.setIdName("btn");
 
 			submit.setAction(new Action() {
 				@Override
 				public void execute(final ActionEvent event) {
-					WebUtilities.updateBeanValue(beanContainer);
+					WebUtilities.updateBeanValue(container);
 				}
 			});
 
-			beanContainer.add(submit);
+			container.add(submit);
 		}
 
 		@Override
 		protected void preparePaintComponent(final Request request) {
 			super.preparePaintComponent(request);
 
 			if (!isInitialised()) {
-				beanContainer.setBean(new SimpleFormBean());
+				container.setBean(new SimpleFormBean());
 				setInitialised(true);
 			}
 		}

wcomponents-core/src/test/java/com/github/bordertech/wcomponents/WContainer_Test.java

@@ -0,0 +1,64 @@
+package com.github.bordertech.wcomponents;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+/**
+ * Unit tests for {@link WContainer}.
+ *
+ * @author John McGuinness
+ * @since 1.5.20
+ */
+public class WContainer_Test extends AbstractWComponentTestCase {
+
+	@Test
+	public void testChildAccessors() {
+		WContainer container = new WContainer();
+
+		// Check no children
+		Assert.assertEquals("Should have no child count", 0, container.getChildCount());
+
+		// Add child
+		WComponent child = new DefaultWComponent();
+		container.add(child);
+
+		// Check child
+		Assert.assertEquals("Incorrect child count", 1, container.getChildCount());
+		Assert.assertEquals("Incorrect child index", 0, container.getIndexOfChild(child));
+		Assert.assertEquals("Incorrect child returned", child, container.getChildAt(0));
+
+		// Remove child
+		container.remove(child);
+
+		// Check no children
+		Assert.assertEquals("Should have no child count after removing", 0, container.getChildCount());
+
+		// Check getChildren
+		container.add(child);
+		Assert.assertEquals("Incorrect child count", 1, container.getChildren().size());
+		Assert.assertEquals("Incorrect child index", 0, container.getChildren().indexOf(child));
+		Assert.assertEquals("Incorrect child returned", child, container.getChildren().get(0));
+
+		try {
+			container.getChildren().add(new DefaultWComponent());
+			Assert.fail("Expected getChildren() to return unmodifiable List.");
+		} catch (UnsupportedOperationException e) {
+			Assert.assertEquals("Incorrect child count", 1, container.getChildren().size());
+		}
+	}
+
+	@Test
+	public void testNamingContextAccessors() {
+		assertAccessorsCorrect(new WContainer(), WContainer::isNamingContext, WContainer::setNamingContext, false, true, false);
+	}
+
+	@Test
+	public void testNamingContextIdAccessor() {
+		String id = "test";
+		NamingContextable naming = new WContainer();
+		naming.setIdName(id);
+		Assert.assertEquals("Incorrect component id", id, naming.getId());
+		Assert.assertEquals("Naming context should match component id", id, naming.
+				getNamingContextId());
+	}
+}

wcomponents-core/src/test/java/com/github/bordertech/wcomponents/WRadioButton_Test.java

@@ -250,7 +250,7 @@ public void testReadOnlyGroup() {
 	public void testRadioButtonInRepeater() {
 		RadioButtonGroup group = new RadioButtonGroup();
 
-		WBeanContainer repeated = new WBeanContainer();
+		WContainer repeated = new WContainer();
 		repeated.add(group.addRadioButton());
 
 		WRepeater repeater = new WRepeater(repeated);

wcomponents-core/src/test/java/com/github/bordertech/wcomponents/servlet/WServletPerformance_Test.java

@@ -8,7 +8,7 @@
 import com.github.bordertech.wcomponents.Request;
 import com.github.bordertech.wcomponents.UIContext;
 import com.github.bordertech.wcomponents.WApplication;
-import com.github.bordertech.wcomponents.WBeanContainer;
+import com.github.bordertech.wcomponents.WContainer;
 import com.github.bordertech.wcomponents.WButton;
 import com.github.bordertech.wcomponents.WComponent;
 import com.github.bordertech.wcomponents.WLabel;
@@ -76,9 +76,9 @@ public void testWServletAppCorrectness() throws Exception {
 		setActiveContext(uic);
 		Assert.assertEquals("Incorrect step", 2, uic.getEnvironment().getStep());
 		Assert.assertEquals("Incorrect property1 value", "p1_1",
-				((SimpleFormBean) app.beanContainer.getBean()).getProperty1());
+				((SimpleFormBean) app.container.getBean()).getProperty1());
 		Assert.assertEquals("Incorrect property2 value", "p2_1",
-				((SimpleFormBean) app.beanContainer.getBean()).getProperty2());
+				((SimpleFormBean) app.container.getBean()).getProperty2());
 	}
 
 	/**
@@ -275,42 +275,42 @@ public WComponent getUI(final Object httpServletRequest) {
 	 */
 	public static final class SimpleApp extends WApplication {
 
-		private final WBeanContainer beanContainer = new WBeanContainer();
+		private final WContainer container = new WContainer();
 
 		/**
 		 * Creates a SimpleApp.
 		 */
 		public SimpleApp() {
-			add(beanContainer);
+			add(container);
 
 			WTextField property1 = new WTextField();
 			property1.setBeanProperty("property1");
 			WTextField property2 = new WTextField();
 			property2.setBeanProperty("property2");
 
-			beanContainer.add(new WLabel("Property 1:", property1));
-			beanContainer.add(property1);
-			beanContainer.add(new WLabel("Property 2:", property2));
-			beanContainer.add(property2);
+			container.add(new WLabel("Property 1:", property1));
+			container.add(property1);
+			container.add(new WLabel("Property 2:", property2));
+			container.add(property2);
 
 			WButton submit = new WButton("Submit");
 
 			submit.setAction(new Action() {
 				@Override
 				public void execute(final ActionEvent event) {
-					WebUtilities.updateBeanValue(beanContainer);
+					WebUtilities.updateBeanValue(container);
 				}
 			});
 
-			beanContainer.add(submit);
+			container.add(submit);
 		}
 
 		@Override
 		protected void preparePaintComponent(final Request request) {
 			super.preparePaintComponent(request);
 
 			if (!isInitialised()) {
-				beanContainer.setBean(new SimpleFormBean());
+				container.setBean(new SimpleFormBean());
 				setInitialised(true);
 			}
 		}

wcomponents-examples/src/main/java/com/github/bordertech/wcomponents/examples/InputBeanBindingExample.java

@@ -9,7 +9,6 @@
 import com.github.bordertech.wcomponents.SubordinateTarget;
 import com.github.bordertech.wcomponents.WAjaxControl;
 import com.github.bordertech.wcomponents.WBeanComponent;
-import com.github.bordertech.wcomponents.WBeanContainer;
 import com.github.bordertech.wcomponents.WButton;
 import com.github.bordertech.wcomponents.WCheckBox;
 import com.github.bordertech.wcomponents.WCheckBoxSelect;
@@ -66,7 +65,7 @@
  * @author Jonathan Austin
  * @since 1.0.0
  */
-public class InputBeanBindingExample extends WBeanContainer {
+public class InputBeanBindingExample extends WContainer {
 
 	/**
 	 * Example options.

wcomponents-examples/src/main/java/com/github/bordertech/wcomponents/examples/WRadioButtonInRepeater.java

@@ -8,7 +8,6 @@
 import com.github.bordertech.wcomponents.Request;
 import com.github.bordertech.wcomponents.Size;
 import com.github.bordertech.wcomponents.WAjaxControl;
-import com.github.bordertech.wcomponents.WBeanContainer;
 import com.github.bordertech.wcomponents.WButton;
 import com.github.bordertech.wcomponents.WContainer;
 import com.github.bordertech.wcomponents.WFieldLayout;
@@ -126,7 +125,7 @@ protected void preparePaintComponent(final Request request) {
 	/**
 	 * A Class that has a radio button that is repeated.
 	 */
-	public static class MyComponent extends WBeanContainer {
+	public static class MyComponent extends WContainer {
 
 		/**
 		 * Label for the radio button.

wcomponents-examples/src/main/java/com/github/bordertech/wcomponents/examples/datatable/DataTableBeanProviderExample.java

@@ -3,7 +3,7 @@
 import com.github.bordertech.wcomponents.AbstractBeanTableDataModel;
 import com.github.bordertech.wcomponents.BeanProvider;
 import com.github.bordertech.wcomponents.BeanProviderBound;
-import com.github.bordertech.wcomponents.WBeanContainer;
+import com.github.bordertech.wcomponents.WContainer;
 import com.github.bordertech.wcomponents.WButton;
 import com.github.bordertech.wcomponents.WDataTable;
 import com.github.bordertech.wcomponents.WTableColumn;
@@ -22,7 +22,7 @@
  * @author Yiannis Paschalidis
  * @since 1.0.0
  */
-public class DataTableBeanProviderExample extends WBeanContainer {
+public class DataTableBeanProviderExample extends WContainer {
 
 	/**
 	 * A fake "application cache", that holds the data which is displayed by the table.

wcomponents-examples/src/main/java/com/github/bordertech/wcomponents/examples/datatable/DataTableOptionsExample.java

@@ -10,7 +10,6 @@
 import com.github.bordertech.wcomponents.TableDataModel;
 import com.github.bordertech.wcomponents.TableTreeNode;
 import com.github.bordertech.wcomponents.TreeTableDataModel;
-import com.github.bordertech.wcomponents.WBeanContainer;
 import com.github.bordertech.wcomponents.WButton;
 import com.github.bordertech.wcomponents.WCheckBox;
 import com.github.bordertech.wcomponents.WContainer;
@@ -854,7 +853,7 @@ public void setColumnC(final String columnC) {
 	 *
 	 * @since 1.0.0
 	 */
-	public static final class ExtraDetailsPanel extends WBeanContainer {
+	public static final class ExtraDetailsPanel extends WContainer {
 
 		/**
 		 * Construct the component.

wcomponents-examples/src/main/java/com/github/bordertech/wcomponents/examples/datatable/TreeTableExample.java

@@ -3,7 +3,7 @@
 import com.github.bordertech.wcomponents.AbstractTreeTableDataModel;
 import com.github.bordertech.wcomponents.Request;
 import com.github.bordertech.wcomponents.TableTreeNode;
-import com.github.bordertech.wcomponents.WBeanContainer;
+import com.github.bordertech.wcomponents.WContainer;
 import com.github.bordertech.wcomponents.WButton;
 import com.github.bordertech.wcomponents.WDataTable;
 import com.github.bordertech.wcomponents.WDataTable.ExpandMode;
@@ -379,7 +379,7 @@ public void setExpiryDate(final Date expiryDate) {
 	 *
 	 * @author Yiannis Paschalidis
 	 */
-	public static final class TravelDocPanel extends WBeanContainer {
+	public static final class TravelDocPanel extends WContainer {
 
 		/**
 		 * Creates a TravelDocPanel.