// (even though both can never be given at the same time)
templateContents = getConnection().getResource(
"layouts/" + templateName + ".html");
- if (templateContents == null) {
- // Template missing -> show debug notice and render components
- // in order.
- getWidget()
- .getElement()
- .setInnerHTML(
- "<em>Layout file layouts/"
- + templateName
- + ".html is missing. Components will be drawn for debug purposes.</em>");
- }
}
if (templateContents != null) {
// Template ok -> initialize.
getWidget().initializeHTML(templateContents,
getConnection().getThemeUri());
+ } else {
+ // Template missing -> show debug notice and render components in
+ // order.
+ String warning = templateName != null ? "Layout file layouts/"
+ + templateName + ".html is missing."
+ : "Layout file not specified.";
+ getWidget()
+ .getElement()
+ .setInnerHTML(
+ "<em>"
+ + warning
+ + " Components will be drawn for debug purposes.</em>");
}
templateUpdated = true;
}
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
+import java.util.Map.Entry;
import java.util.Set;
+import org.jsoup.nodes.Element;
+
import com.vaadin.server.JsonPaintTarget;
import com.vaadin.server.PaintException;
import com.vaadin.server.PaintTarget;
import com.vaadin.shared.ui.customlayout.CustomLayoutState;
+import com.vaadin.ui.declarative.DesignContext;
/**
* <p>
* {@link #setTemplateName(String)}, that makes layout fetch the template
* from theme, or {@link #setTemplateContents(String)}.
*/
- protected CustomLayout() {
- setWidth(100, UNITS_PERCENTAGE);
+ public CustomLayout() {
+ setWidth(100, Unit.PERCENTAGE);
}
/**
}
}
+ @Override
+ public void readDesign(Element design, DesignContext designContext) {
+ super.readDesign(design, designContext);
+
+ for (Element child : design.children()) {
+
+ Component childComponent = designContext.readDesign(child);
+
+ if (child.hasAttr(":location")) {
+ addComponent(childComponent, child.attr(":location"));
+ } else {
+ addComponent(childComponent);
+ }
+ }
+ }
+
+ @Override
+ public void writeDesign(Element design, DesignContext designContext) {
+ super.writeDesign(design, designContext);
+
+ for (Entry<String, Component> slot : slots.entrySet()) {
+ Element child = designContext.createElement(slot.getValue());
+ if (slots.size() > 1 || !"".equals(slot.getKey())) {
+ child.attr(":location", slot.getKey());
+ }
+ design.appendChild(child);
+ }
+ }
}
--- /dev/null
+/*
+ * Copyright 2000-2014 Vaadin Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.vaadin.tests.server.component.customlayout;
+
+import org.junit.Test;
+
+import com.vaadin.tests.design.DeclarativeTestBase;
+import com.vaadin.ui.Button;
+import com.vaadin.ui.CustomLayout;
+import com.vaadin.ui.Label;
+
+/**
+ * Tests declarative support for {@link CustomLayout}.
+ *
+ * @since
+ * @author Vaadin Ltd
+ */
+public class CustomLayoutDeclarativeTest extends
+ DeclarativeTestBase<CustomLayout> {
+
+ @Test
+ public void testEmpty() {
+ String design = "<v-custom-layout>";
+ CustomLayout expected = new CustomLayout();
+ test(design, expected);
+ }
+
+ @Test
+ public void testWithChildren() {
+ String design = "<v-custom-layout>" + //
+ "<v-button plain-text :location='b'></v-button>" + //
+ "<v-label plain-text :location='l'></v-label>" + //
+ "</v-custom-layout>";
+
+ CustomLayout expected = new CustomLayout();
+ expected.addComponent(new Button(), "b");
+ expected.addComponent(new Label(), "l");
+
+ test(design, expected);
+ }
+
+ @Test
+ public void testWithOneChild() {
+ String design = "<v-custom-layout><v-button plain-text></v-button></v-custom-layout>";
+
+ CustomLayout expected = new CustomLayout();
+ expected.addComponent(new Button());
+
+ test(design, expected);
+ }
+
+ @Test
+ public void testWithTemplate() {
+ String design = "<v-custom-layout template-name='template.html'></v-custom-layout>";
+ CustomLayout expected = new CustomLayout("template.html");
+ test(design, expected);
+ }
+
+ @Test
+ public void testWithDuplicateLocations() {
+ String design = "<v-custom-layout>" + //
+ "<v-button plain-text :location='foo'></v-button>" + //
+ "<v-label plain-text :location='foo'></v-label>" + //
+ "</v-custom-layout>";
+
+ CustomLayout expected = new CustomLayout();
+ expected.addComponent(new Button(), "foo");
+ expected.addComponent(new Label(), "foo");
+
+ testRead(design, expected);
+
+ String written = "<v-custom-layout>" + //
+ "<v-label plain-text :location='foo'></v-label>" + //
+ "</v-custom-layout>";
+
+ testWrite(written, expected);
+ }
+
+ protected void test(String design, CustomLayout expected) {
+ testRead(design, expected);
+ testWrite(design, expected);
+ }
+}
--- /dev/null
+/*
+ * Copyright 2000-2014 Vaadin Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.vaadin.tests.components.customlayout;
+
+import com.vaadin.server.VaadinRequest;
+import com.vaadin.tests.components.AbstractTestUI;
+import com.vaadin.ui.Button;
+import com.vaadin.ui.CustomLayout;
+import com.vaadin.ui.Label;
+
+public class CustomLayoutWithNullTemplate extends AbstractTestUI {
+
+ @Override
+ protected void setup(VaadinRequest request) {
+ CustomLayout cl = new CustomLayout();
+ cl.addComponent(new Label("This Label should be visible."), "foo");
+ cl.addComponent(new Button("This Button too."), "bar");
+
+ addComponent(cl);
+ }
+
+ @Override
+ protected String getTestDescription() {
+ return "Verify that a default-constructed CustomLayout renders child components";
+ }
+
+ @Override
+ protected Integer getTicketNumber() {
+ return 17210;
+ }
+}
--- /dev/null
+/*
+ * Copyright 2000-2014 Vaadin Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.vaadin.tests.components.customlayout;
+
+import static org.junit.Assert.assertTrue;
+
+import org.junit.Test;
+
+import com.vaadin.testbench.ElementQuery;
+import com.vaadin.testbench.elements.ButtonElement;
+import com.vaadin.testbench.elements.CustomLayoutElement;
+import com.vaadin.testbench.elements.LabelElement;
+import com.vaadin.tests.tb3.SingleBrowserTest;
+
+public class CustomLayoutWithNullTemplateTest extends SingleBrowserTest {
+
+ @Test
+ public void testChildComponents() {
+ openTestURL();
+
+ ElementQuery<CustomLayoutElement> customLayout = $(CustomLayoutElement.class);
+
+ // Verify the Button and Label are rendered inside the CustomLayout.
+ assertTrue("Button was not rendered.",
+ customLayout.$(ButtonElement.class).exists());
+ assertTrue("Label was not rendered.", customLayout
+ .$(LabelElement.class).exists());
+ }
+
+}