}
}
}
+
+ @Override
+ public void writeDesign(Element design, DesignContext designContext) {
+ // Write default attributes
+ super.writeDesign(design, designContext);
+
+ // Write options if warranted
+ if (designContext.shouldWriteData(this)) {
+ for (Object itemId : getItemIds()) {
+ Element optionElement = design.appendElement("option");
+
+ optionElement.html(getItemCaption(itemId));
+
+ Resource icon = getItemIcon(itemId);
+ if (icon != null) {
+ DesignAttributeHandler.writeAttribute("icon",
+ optionElement.attributes(), icon, null,
+ Resource.class);
+ }
+
+ if (isSelected(itemId)) {
+ optionElement.attr("selected", "");
+ }
+ }
+ }
+ }
}
\ No newline at end of file
// component creation listeners
private List<ComponentCreationListener> listeners = new ArrayList<ComponentCreationListener>();
+ private ShouldWriteDataDelegate shouldWriteDataDelegate = ShouldWriteDataDelegate.DEFAULT;
+
public DesignContext(Document doc) {
this.doc = doc;
// Initialize the mapping between prefixes and package names.
return true;
}
+
+ /**
+ * Determines whether the container data of a component should be written
+ * out by delegating to a {@link ShouldWriteDataDelegate}. The default
+ * delegate assumes that all component data is provided by a data source
+ * connected to a back end system and that the data should thus not be
+ * written.
+ *
+ * @since
+ * @see #setShouldWriteDataDelegate(ShouldWriteDataDelegate)
+ * @param component
+ * the component to check
+ * @return <code>true</code> if container data should be written out for the
+ * provided component; otherwise <code>false</code>.
+ */
+ public boolean shouldWriteData(Component component) {
+ return getShouldWriteDataDelegate().shouldWriteData(component);
+ }
+
+ /**
+ * Sets the delegate that determines whether the container data of a
+ * component should be written out.
+ *
+ * @since
+ * @see #shouldWriteChildren(Component, Component)
+ * @see #getShouldWriteDataDelegate()
+ * @param shouldWriteDataDelegate
+ * the delegate to set, not <code>null</code>
+ * @throws IllegalArgumentException
+ * if the provided delegate is <code>null</code>
+ */
+ public void setShouldWriteDataDelegate(
+ ShouldWriteDataDelegate shouldWriteDataDelegate) {
+ if (shouldWriteDataDelegate == null) {
+ throw new IllegalArgumentException("Delegate cannot be null");
+ }
+ this.shouldWriteDataDelegate = shouldWriteDataDelegate;
+ }
+
+ /**
+ * Gets the delegate that determines whether the container data of a
+ * component should be written out.
+ *
+ * @since
+ * @see #setShouldWriteDataDelegate(ShouldWriteDataDelegate)
+ * @see #shouldWriteChildren(Component, Component)
+ * @return the shouldWriteDataDelegate the currently use delegate
+ */
+ public ShouldWriteDataDelegate getShouldWriteDataDelegate() {
+ return shouldWriteDataDelegate;
+ }
+
}
--- /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.ui.declarative;
+
+import java.io.Serializable;
+
+import com.vaadin.ui.Component;
+
+/**
+ * Delegate used by {@link DesignContext} to determine whether container data
+ * should be written out for a component.
+ *
+ * @see DesignContext#shouldWriteData(Component)
+ *
+ * @since
+ * @author Vaadin Ltd
+ */
+public interface ShouldWriteDataDelegate extends Serializable {
+
+ /**
+ * The default delegate implementation that assumes that all component data
+ * is provided by a data source connected to a back end system and that the
+ * data should thus not be written.
+ */
+ public static final ShouldWriteDataDelegate DEFAULT = new ShouldWriteDataDelegate() {
+ @Override
+ public boolean shouldWriteData(Component component) {
+ return false;
+ }
+ };
+
+ /**
+ * Determines whether the container data of a component should be written
+ * out.
+ *
+ * @param component
+ * the component to check
+ * @return <code>true</code> if container data should be written out for the
+ * provided component; otherwise <code>false</code>.
+ */
+ boolean shouldWriteData(Component component);
+}
import com.vaadin.ui.Component;
import com.vaadin.ui.declarative.Design;
+import com.vaadin.ui.declarative.DesignContext;
+import com.vaadin.ui.declarative.ShouldWriteDataDelegate;
public abstract class DeclarativeTestBaseBase<T extends Component> {
public interface EqualsAsserter<TT> {
}
}
- protected String write(T object) {
+ protected String write(T object, boolean writeData) {
try {
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
- Design.write(object, outputStream);
+
+ DesignContext dc = new DesignContext();
+ if (writeData) {
+ dc.setShouldWriteDataDelegate(new ShouldWriteDataDelegate() {
+ @Override
+ public boolean shouldWriteData(Component component) {
+ return true;
+ }
+ });
+ }
+ dc.setRootComponent(object);
+ Design.write(dc, outputStream);
return outputStream.toString("UTF-8");
} catch (Exception e) {
throw new RuntimeException(e);
}
public void testWrite(String design, T expected) {
- String written = write(expected);
+ testWrite(design, expected, false);
+ }
+
+ public void testWrite(String design, T expected, boolean writeData) {
+ String written = write(expected, writeData);
Element producedElem = Jsoup.parse(written).body().child(0);
Element comparableElem = Jsoup.parse(design).body().child(0);
}
@Test
- public void testWriteInlineData() {
+ public void testWriteInlineDataIgnored() {
// No data is written by default
testWrite(stripOptionTags(getDesignForInlineData()),
getExpectedComponentForInlineData());
}
+ @Test
+ public void testWriteInlineData() {
+ testWrite(getDesignForInlineData(),
+ getExpectedComponentForInlineData(), true);
+ }
+
private String getDesignForInlineData() {
return "<v-list-select>\n"
+ " <option icon='http://some.url/icon.png'>Value 1</option>\n" //
projects / vaadin-framework.git / commitdiff