(content, String.class), contentMode);
}
/**
* Creates a new instance of Label with text-contents read from given
* datasource.
*
* @param contentSource
* @param contentMode
*/
public Label(Property contentSource, ContentMode contentMode) {
setPropertyDataSource(contentSource);
setContentMode(contentMode);
setWidth(100, UNITS_PERCENTAGE);
}
@Override
public void updateState() {
super.updateState();
// We don't know when the text is updated so update it here before
// sending the state to the client
getState().setText(getStringValue());
}
@Override
public LabelState getState() {
return (LabelState) super.getState();
}
/**
* Gets the value of the label. Value of the label is the XML contents of
* the label.
*
* @return the Value of the label.
*/
public Object getValue() {
if (dataSource == null) {
throw new IllegalStateException(DATASOURCE_MUST_BE_SET);
}
return dataSource.getValue();
}
/**
* Set the value of the label. Value of the label is the XML contents of the
* label.
*
* @param newValue
* the New value of the label.
*/
public void setValue(Object newValue) {
if (dataSource == null) {
throw new IllegalStateException(DATASOURCE_MUST_BE_SET);
}
dataSource.setValue(newValue);
}
/**
* @see java.lang.Object#toString()
* @deprecated use the data source value or {@link #getStringValue()}
* instead
*/
@Deprecated
@Override
public String toString() {
throw new UnsupportedOperationException(
"Use Property.getValue() instead of Label.toString()");
}
/**
* Returns the value of the Property in human readable textual
* format.
*
* This method exists to help migration from previous Vaadin versions by
* providing a simple replacement for {@link #toString()}. However, it is
* normally better to use the value of the label directly.
*
* @return String representation of the value stored in the Property
* @since 7.0
*/
public String getStringValue() {
if (dataSource == null) {
throw new IllegalStateException(DATASOURCE_MUST_BE_SET);
}
Object value = dataSource.getValue();
return (null != value) ? value.toString() : null;
}
/**
* Gets the type of the Property.
*
* @see com.vaadin.data.Property#getType()
*/
public Class getType() {
if (dataSource == null) {
throw new IllegalStateException(DATASOURCE_MUST_BE_SET);
}
return dataSource.getType();
}
/**
* Gets the viewing data-source property.
*
* @return the data source property.
* @see com.vaadin.data.Property.Viewer#getPropertyDataSource()
*/
public Property getPropertyDataSource() {
return dataSource;
}
/**
* Sets the property as data-source for viewing.
*
* @param newDataSource
* the new data source Property
* @see com.vaadin.data.Property.Viewer#setPropertyDataSource(com.vaadin.data.Property)
*/
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);
}
// Sets the new data source
dataSource = newDataSource;
// Listens the new data source if possible
if (dataSource != null
&& Property.ValueChangeNotifier.class
.isAssignableFrom(dataSource.getClass())) {
((Property.ValueChangeNotifier) dataSource).addListener(this);
}
requestRepaint();
}
/**
* Gets the content mode of the Label.
*
* @return the Content mode of the label.
*
* @see ContentMode
*/
public ContentMode getContentMode() {
return getState().getContentMode();
}
/**
* Sets the content mode of the Label.
*
* @param contentMode
* the New content mode of the label.
*
* @see ContentMode
*/
public void setContentMode(ContentMode contentMode) {
if (contentMode == null) {
throw new IllegalArgumentException("Content mode can not be null");
}
getState().setContentMode(contentMode);
requestRepaint();
}
/* 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.
* @version
* @VERSION@
* @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.data.Property.ValueChangeEvent#getProperty()
*/
public Property getProperty() {
return (Property) getSource();
}
}
/**
* Adds the value change listener.
*
* @param listener
* the Listener to be added.
* @see com.vaadin.data.Property.ValueChangeNotifier#addListener(com.vaadin.data.Property.ValueChangeListener)
*/
public void addListener(Property.ValueChangeListener listener) {
addListener(Label.ValueChangeEvent.class, listener, VALUE_CHANGE_METHOD);
}
/**
* Removes the value change listener.
*
* @param listener
* the Listener to be removed.
* @see com.vaadin.data.Property.ValueChangeNotifier#removeListener(com.vaadin.data.Property.ValueChangeListener)
*/
public void removeListener(Property.ValueChangeListener listener) {
removeListener(Label.ValueChangeEvent.class, listener,
VALUE_CHANGE_METHOD);
}
/**
* Emits the options change event.
*/
protected void fireValueChange() {
// Set the error message
fireEvent(new Label.ValueChangeEvent(this));
requestRepaint();
}
/**
* Listens the value change events from data source.
*
* @see com.vaadin.data.Property.ValueChangeListener#valueChange(Property.ValueChangeEvent)
*/
public void valueChange(Property.ValueChangeEvent event) {
fireValueChange();
}
/**
* Compares the Label to other objects.
*
*
* Labels can be compared to other labels for sorting label contents. This
* is especially handy for sorting table columns.
*
*
*
* In RAW, PREFORMATTED and TEXT modes, the label contents are compared as
* is. In XML, UIDL and XHTML modes, only CDATA is compared and tags
* ignored. If the other object is not a Label, its toString() return value
* is used in comparison.
*
*
* @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)
*/
public int compareTo(Object other) {
String thisValue;
String otherValue;
if (getContentMode() == ContentMode.XML
|| getContentMode() == ContentMode.XHTML) {
thisValue = stripTags(getStringValue());
} else {
thisValue = getStringValue();
}
if (other instanceof Label
&& (((Label) other).getContentMode() == ContentMode.XML || ((Label) other)
.getContentMode() == ContentMode.XHTML)) {
otherValue = stripTags(((Label) other).getStringValue());
} else {
// TODO not a good idea - and might assume that Field.toString()
// returns a string representation of the value
otherValue = other.toString();
}
return thisValue.compareTo(otherValue);
}
/**
* Strips the tags from the XML.
*
* @param xml
* the String containing a XML snippet.
* @return the original XML without tags.
*/
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();
}
}