diff options
Diffstat (limited to 'server/src/main/java/com/vaadin/ui/Label.java')
| -rw-r--r-- | server/src/main/java/com/vaadin/ui/Label.java | 502 |
1 files changed, 33 insertions, 469 deletions
diff --git a/server/src/main/java/com/vaadin/ui/Label.java b/server/src/main/java/com/vaadin/ui/Label.java index 21aa7bdcbe..161d4ddc73 100644 --- a/server/src/main/java/com/vaadin/ui/Label.java +++ b/server/src/main/java/com/vaadin/ui/Label.java @@ -16,91 +16,26 @@ package com.vaadin.ui; -import java.lang.reflect.Method; import java.util.Collection; -import java.util.Locale; import org.jsoup.nodes.Element; import com.vaadin.shared.ui.label.ContentMode; import com.vaadin.shared.ui.label.LabelState; -import com.vaadin.shared.util.SharedUtil; import com.vaadin.ui.declarative.DesignContext; import com.vaadin.ui.declarative.DesignFormatter; -import com.vaadin.v7.data.Property; -import com.vaadin.v7.data.util.converter.Converter; -import com.vaadin.v7.data.util.converter.ConverterUtil; /** * Label component for showing non-editable short texts. - * - * The label content can be set to the modes specified by {@link ContentMode} - * * <p> - * The contents of the label may contain simple formatting: - * <ul> - * <li><b><b></b> Bold - * <li><b><i></b> Italic - * <li><b><u></b> Underlined - * <li><b><br/></b> Linebreak - * <li><b><ul><li>item 1</li><li>item 2</li></ul></b> List of - * items - * </ul> - * The <b>b</b>,<b>i</b>,<b>u</b> and <b>li</b> tags can contain all the tags in - * the list recursively. - * </p> + * The label content can be set to the modes specified by {@link ContentMode}. + * If content mode is set to HTML, any HTML content is allowed. * * @author Vaadin Ltd. * @since 3.0 */ @SuppressWarnings("serial") -public class Label extends AbstractComponent implements Property<String>, - Property.Viewer, Property.ValueChangeListener, - Property.ValueChangeNotifier, Comparable<Label> { - - /** - * @deprecated As of 7.0, use {@link ContentMode#TEXT} instead - */ - @Deprecated - public static final ContentMode CONTENT_TEXT = ContentMode.TEXT; - - /** - * @deprecated As of 7.0, use {@link ContentMode#PREFORMATTED} instead - */ - @Deprecated - public static final ContentMode CONTENT_PREFORMATTED = ContentMode.PREFORMATTED; - - /** - * @deprecated As of 7.0, use {@link ContentMode#HTML} instead - */ - @Deprecated - public static final ContentMode CONTENT_XHTML = ContentMode.HTML; - - /** - * @deprecated As of 7.0, use {@link ContentMode#XML} instead - */ - @Deprecated - public static final ContentMode CONTENT_XML = ContentMode.XML; - - /** - * @deprecated As of 7.0, use {@link ContentMode#RAW} instead - */ - @Deprecated - public static final ContentMode CONTENT_RAW = ContentMode.RAW; - - /** - * @deprecated As of 7.0, use {@link ContentMode#TEXT} instead - */ - @Deprecated - public static final ContentMode CONTENT_DEFAULT = ContentMode.TEXT; - - /** - * A converter used to convert from the data model type to the field type - * and vice versa. Label type is always String. - */ - private Converter<String, Object> converter = null; - - private Property<String> dataSource = null; +public class Label extends AbstractComponent { /** * Creates an empty Label. @@ -110,47 +45,27 @@ public class Label extends AbstractComponent implements Property<String>, } /** - * Creates a new instance of Label with text-contents. - * - * @param content - */ - public Label(String content) { - this(content, ContentMode.TEXT); - } - - /** - * Creates a new instance of Label with text-contents read from given - * datasource. - * - * @param contentSource - */ - public Label(Property contentSource) { - this(contentSource, ContentMode.TEXT); - } - - /** - * Creates a new instance of Label with text-contents. + * Creates a new instance with text content mode and the given text. * - * @param content - * @param contentMode + * @param text + * the text to set */ - public Label(String content, ContentMode contentMode) { - setValue(content); - setContentMode(contentMode); - setWidth(100, Unit.PERCENTAGE); + public Label(String text) { + this(text, ContentMode.TEXT); } /** - * Creates a new instance of Label with text-contents read from given - * datasource. + * Creates a new instance with the given text and content mode. * - * @param contentSource + * @param text + * the text to set * @param contentMode + * the content mode to use */ - public Label(Property contentSource, ContentMode contentMode) { - setPropertyDataSource(contentSource); + public Label(String text, ContentMode contentMode) { + setValue(text); setContentMode(contentMode); - setWidth(100, Unit.PERCENTAGE); + setWidth("100%"); } @Override @@ -164,126 +79,9 @@ public class Label extends AbstractComponent implements Property<String>, } /** - * Gets the value of the label. - * <p> - * The value of the label is the text that is shown to the end user. - * Depending on the {@link ContentMode} it is plain text or markup. - * </p> - * - * @return the value of the label. - */ - @Override - public String getValue() { - if (getPropertyDataSource() == null) { - // Use internal value if we are running without a data source - return getState(false).text; - } - return getDataSourceValue(); - } - - /** - * Returns the current value of the data source converted using the current - * locale. + * Gets the content mode of the label. * - * @return - */ - private String getDataSourceValue() { - return ConverterUtil.convertFromModel( - getPropertyDataSource().getValue(), String.class, - getConverter(), getLocale()); - } - - /** - * Set the value of the label. Value of the label is the XML contents of the - * label. Since Vaadin 7.2, changing the value of Label instance with that - * method will fire ValueChangeEvent. - * - * @param newStringValue - * the New value of the label. - */ - @Override - public void setValue(String newStringValue) { - if (getPropertyDataSource() == null) { - - LabelState state = getState(false); - String oldTextValue = state.text; - if (!SharedUtil.equals(oldTextValue, newStringValue)) { - getState().text = newStringValue; - fireValueChange(); - } - } else { - throw new IllegalStateException( - "Label is only a Property.Viewer and cannot update its data source"); - } - } - - /** - * Gets the type of the Property. - * - * @see com.vaadin.v7.data.Property#getType() - */ - @Override - public Class<String> getType() { - return String.class; - } - - /** - * Gets the viewing data-source property. - * - * @return the data source property. - * @see com.vaadin.v7.data.Property.Viewer#getPropertyDataSource() - */ - @Override - public Property getPropertyDataSource() { - return dataSource; - } - - /** - * Sets the property as data-source for viewing. Since Vaadin 7.2 a - * ValueChangeEvent is fired if the new value is different from previous. - * - * @param newDataSource - * the new data source Property - * @see com.vaadin.v7.data.Property.Viewer#setPropertyDataSource(com.vaadin.v7.data.Property) - */ - @Override - public void setPropertyDataSource(Property newDataSource) { - // Stops listening the old data source changes - if (dataSource != null && Property.ValueChangeNotifier.class - .isAssignableFrom(dataSource.getClass())) { - ((Property.ValueChangeNotifier) dataSource).removeListener(this); - } - - // Check if the current converter is compatible. - if (newDataSource != null - && !ConverterUtil.canConverterPossiblyHandle( - getConverter(), getType(), newDataSource.getType())) { - // There is no converter set or there is no way the current - // converter can be compatible. - Converter<String, ?> c = ConverterUtil.getConverter( - String.class, newDataSource.getType(), getSession()); - setConverter(c); - } - - dataSource = newDataSource; - if (dataSource != null) { - // Update the value from the data source. If data source was set to - // null, retain the old value - updateValueFromDataSource(); - } - - // Listens the new data source if possible - if (dataSource != null && Property.ValueChangeNotifier.class - .isAssignableFrom(dataSource.getClass())) { - ((Property.ValueChangeNotifier) dataSource).addListener(this); - } - markAsDirty(); - } - - /** - * Gets the content mode of the Label. - * - * @return the Content mode of the label. + * @return the content mode of the label * * @see ContentMode */ @@ -292,10 +90,10 @@ public class Label extends AbstractComponent implements Property<String>, } /** - * Sets the content mode of the Label. + * Sets the content mode of the label. * * @param contentMode - * the New content mode of the label. + * the content mode to set * * @see ContentMode */ @@ -307,248 +105,30 @@ public class Label extends AbstractComponent implements Property<String>, getState().contentMode = contentMode; } - /* Value change events */ - - private static final Method VALUE_CHANGE_METHOD; - - static { - try { - VALUE_CHANGE_METHOD = Property.ValueChangeListener.class - .getDeclaredMethod("valueChange", - new Class[] { Property.ValueChangeEvent.class }); - } catch (final java.lang.NoSuchMethodException e) { - // This should never happen - throw new java.lang.RuntimeException( - "Internal error finding methods in Label"); - } - } - - /** - * Value change event - * - * @author Vaadin Ltd. - * @since 3.0 - */ - public static class ValueChangeEvent extends Component.Event - implements Property.ValueChangeEvent { - - /** - * New instance of text change event - * - * @param source - * the Source of the event. - */ - public ValueChangeEvent(Label source) { - super(source); - } - - /** - * Gets the Property that has been modified. - * - * @see com.vaadin.v7.data.Property.ValueChangeEvent#getProperty() - */ - @Override - public Property getProperty() { - return (Property) getSource(); - } - } - - /** - * Adds the value change listener. - * - * @param listener - * the Listener to be added. - * @see com.vaadin.v7.data.Property.ValueChangeNotifier#addListener(com.vaadin.v7.data.Property.ValueChangeListener) - */ - @Override - public void addValueChangeListener(Property.ValueChangeListener listener) { - addListener(Label.ValueChangeEvent.class, listener, - VALUE_CHANGE_METHOD); - } - - /** - * @deprecated As of 7.0, replaced by - * {@link #addValueChangeListener(com.vaadin.v7.data.Property.ValueChangeListener)} - **/ - @Override - @Deprecated - public void addListener(Property.ValueChangeListener listener) { - addValueChangeListener(listener); - } - - /** - * Removes the value change listener. - * - * @param listener - * the Listener to be removed. - * @see com.vaadin.v7.data.Property.ValueChangeNotifier#removeListener(com.vaadin.v7.data.Property.ValueChangeListener) - */ - @Override - public void removeValueChangeListener( - Property.ValueChangeListener listener) { - removeListener(Label.ValueChangeEvent.class, listener, - VALUE_CHANGE_METHOD); - } - - /** - * @deprecated As of 7.0, replaced by - * {@link #removeValueChangeListener(com.vaadin.v7.data.Property.ValueChangeListener)} - **/ - @Override - @Deprecated - public void removeListener(Property.ValueChangeListener listener) { - removeValueChangeListener(listener); - } - - /** - * Emits the options change event. - */ - protected void fireValueChange() { - // Set the error message - fireEvent(new Label.ValueChangeEvent(this)); - } - /** - * Listens the value change events from data source. + * Sets the text to be shown in the label. * - * @see com.vaadin.v7.data.Property.ValueChangeListener#valueChange(Property.ValueChangeEvent) + * @param value + * the text to show in the label, null is converted to an empty + * string */ - @Override - public void valueChange(Property.ValueChangeEvent event) { - updateValueFromDataSource(); - } - - private void updateValueFromDataSource() { - // Update the internal value from the data source - String newConvertedValue = getDataSourceValue(); - if (!SharedUtil.equals(newConvertedValue, getState(false).text)) { - getState().text = newConvertedValue; - fireValueChange(); - } - } - - @Override - public void attach() { - super.attach(); - localeMightHaveChanged(); - } - - @Override - public void setLocale(Locale locale) { - super.setLocale(locale); - localeMightHaveChanged(); - } - - private void localeMightHaveChanged() { - if (getPropertyDataSource() != null) { - updateValueFromDataSource(); - } - } - - private String getComparableValue() { - String stringValue = getValue(); - if (stringValue == null) { - stringValue = ""; - } - - if (getContentMode() == ContentMode.HTML - || getContentMode() == ContentMode.XML) { - return stripTags(stringValue); + public void setValue(String value) { + if (value == null) { + getState().text = ""; } else { - return stringValue; + getState().text = value; } - - } - - /** - * Compares the Label to other objects. - * - * <p> - * Labels can be compared to other labels for sorting label contents. This - * is especially handy for sorting table columns. - * </p> - * - * <p> - * In RAW, PREFORMATTED and TEXT modes, the label contents are compared as - * is. In XML, UIDL and HTML modes, only CDATA is compared and tags ignored. - * If the other object is not a Label, its toString() return value is used - * in comparison. - * </p> - * - * @param other - * the Other object to compare to. - * @return a negative integer, zero, or a positive integer as this object is - * less than, equal to, or greater than the specified object. - * @see java.lang.Comparable#compareTo(java.lang.Object) - */ - @Override - public int compareTo(Label other) { - - String thisValue = getComparableValue(); - String otherValue = other.getComparableValue(); - - return thisValue.compareTo(otherValue); } /** - * Strips the tags from the XML. + * Gets the text shown in the label. * - * @param xml - * the String containing a XML snippet. - * @return the original XML without tags. + * @return the text shown in the label, not null */ - private String stripTags(String xml) { - - final StringBuffer res = new StringBuffer(); - - int processed = 0; - final int xmlLen = xml.length(); - while (processed < xmlLen) { - int next = xml.indexOf('<', processed); - if (next < 0) { - next = xmlLen; - } - res.append(xml.substring(processed, next)); - if (processed < xmlLen) { - next = xml.indexOf('>', processed); - if (next < 0) { - next = xmlLen; - } - processed = next + 1; - } - } - - return res.toString(); - } - - /** - * Gets the converter used to convert the property data source value to the - * label value. - * - * @return The converter or null if none is set. - */ - public Converter<String, Object> getConverter() { - return converter; - } - - /** - * Sets the converter used to convert the label value to the property data - * source type. The converter must have a presentation type of String. - * - * @param converter - * The new converter to use. - */ - public void setConverter(Converter<String, ?> converter) { - this.converter = (Converter<String, Object>) converter; - markAsDirty(); + public String getValue() { + return getState(false).text; } - /* - * (non-Javadoc) - * - * @see com.vaadin.ui.AbstractComponent#readDesign(org.jsoup.nodes .Element, - * com.vaadin.ui.declarative.DesignContext) - */ @Override public void readDesign(Element design, DesignContext designContext) { super.readDesign(design, designContext); @@ -567,11 +147,6 @@ public class Label extends AbstractComponent implements Property<String>, } } - /* - * (non-Javadoc) - * - * @see com.vaadin.ui.AbstractComponent#getCustomAttributes() - */ @Override protected Collection<String> getCustomAttributes() { Collection<String> result = super.getCustomAttributes(); @@ -581,12 +156,6 @@ public class Label extends AbstractComponent implements Property<String>, return result; } - /* - * (non-Javadoc) - * - * @see com.vaadin.ui.AbstractComponent#writeDesign(org.jsoup.nodes.Element - * , com.vaadin.ui.declarative.DesignContext) - */ @Override public void writeDesign(Element design, DesignContext designContext) { super.writeDesign(design, designContext); @@ -594,9 +163,7 @@ public class Label extends AbstractComponent implements Property<String>, if (content != null) { switch (getContentMode()) { case TEXT: - case PREFORMATTED: - case XML: - case RAW: { + case PREFORMATTED: { // FIXME This attribute is not enough to be able to restore the // content mode in readDesign. The content mode should instead // be written directly in the attribute and restored in @@ -612,11 +179,8 @@ public class Label extends AbstractComponent implements Property<String>, case HTML: design.html(content); break; - default: - throw new IllegalStateException( - "ContentMode " + getContentMode() - + " is not supported by writeDesign"); } } } + } |