123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536 |
- /*
- @ITMillApache2LicenseForJavaFiles@
- */
-
- package com.itmill.toolkit.ui;
-
- import java.lang.reflect.Method;
-
- import com.itmill.toolkit.data.Property;
- import com.itmill.toolkit.data.util.ObjectProperty;
- import com.itmill.toolkit.terminal.PaintException;
- import com.itmill.toolkit.terminal.PaintTarget;
-
- /**
- * Label component for showing non-editable short texts.
- *
- * The label content can be set to the modes specified by the final members
- * CONTENT_*
- *
- * <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>
- *
- * @author IT Mill Ltd.
- * @version
- * @VERSION@
- * @since 3.0
- */
- public class Label extends AbstractComponent implements Property,
- Property.Viewer, Property.ValueChangeListener,
- Property.ValueChangeNotifier, Comparable {
-
- /**
- * Content mode, where the label contains only plain text. The getValue()
- * result is coded to XML when painting.
- */
- public static final int CONTENT_TEXT = 0;
-
- /**
- * Content mode, where the label contains preformatted text.
- */
- public static final int CONTENT_PREFORMATTED = 1;
-
- /**
- * Formatted content mode, where the contents is XML restricted to the UIDL
- * 1.0 formatting markups.
- */
- public static final int CONTENT_UIDL = 2;
-
- /**
- * Content mode, where the label contains XHTML. Contents is then enclosed
- * in DIV elements having namespace of
- * "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd".
- */
- public static final int CONTENT_XHTML = 3;
-
- /**
- * Content mode, where the label contains well-formed or well-balanced XML.
- * Each of the root elements must have their default namespace specified.
- */
- public static final int CONTENT_XML = 4;
-
- /**
- * Content mode, where the label contains RAW output. Output is not required
- * to comply to with XML. In Web Adapter output is inserted inside the
- * resulting HTML document as-is. This is useful for some specific purposes
- * where possibly broken HTML content needs to be shown, but in most cases
- * XHTML mode should be preferred.
- */
- public static final int CONTENT_RAW = 5;
-
- /**
- * The default content mode is plain text.
- */
- public static final int CONTENT_DEFAULT = CONTENT_TEXT;
-
- /** Array of content mode names that are rendered in UIDL as mode attribute. */
- private static final String[] CONTENT_MODE_NAME = { "text", "pre", "uidl",
- "xhtml", "xml", "raw" };
-
- private Property dataSource;
-
- private int contentMode = CONTENT_DEFAULT;
-
- /**
- * Creates an empty Label.
- */
- public Label() {
- setPropertyDataSource(new ObjectProperty("", String.class));
- }
-
- /**
- * Creates a new instance of Label with text-contents.
- *
- * @param content
- */
- public Label(String content) {
- setPropertyDataSource(new ObjectProperty(content, String.class));
- }
-
- /**
- * Creates a new instance of Label with text-contents read from given
- * datasource.
- *
- * @param contentSource
- */
- public Label(Property contentSource) {
- setPropertyDataSource(contentSource);
- }
-
- /**
- * Creates a new instance of Label with text-contents.
- *
- * @param content
- * @param contentMode
- */
- public Label(String content, int contentMode) {
- setPropertyDataSource(new ObjectProperty(content, String.class));
- setContentMode(contentMode);
- }
-
- /**
- * Creates a new instance of Label with text-contents read from given
- * datasource.
- *
- * @param contentSource
- * @param contentMode
- */
- public Label(Property contentSource, int contentMode) {
- setPropertyDataSource(contentSource);
- setContentMode(contentMode);
- }
-
- /**
- * Get the component UIDL tag.
- *
- * @return the Component UIDL tag as string.
- */
- public String getTag() {
- return "label";
- }
-
- /**
- * Set the component to read-only. Readonly is not used in label.
- *
- * @param readOnly
- * True to enable read-only mode, False to disable it.
- */
- public void setReadOnly(boolean readOnly) {
- if (dataSource == null) {
- throw new IllegalStateException("Datasource must be se");
- }
- dataSource.setReadOnly(readOnly);
- }
-
- /**
- * Is the component read-only ? Readonly is not used in label - this returns
- * allways false.
- *
- * @return <code>true</code> if the component is in read only mode.
- */
- public boolean isReadOnly() {
- if (dataSource == null) {
- throw new IllegalStateException("Datasource must be se");
- }
- return dataSource.isReadOnly();
- }
-
- /**
- * Paints the content of this component.
- *
- * @param target
- * the Paint Event.
- * @throws PaintException
- * if the Paint Operation fails.
- */
- public void paintContent(PaintTarget target) throws PaintException {
- if (contentMode != CONTENT_TEXT) {
- target.addAttribute("mode", CONTENT_MODE_NAME[contentMode]);
- }
- if (contentMode == CONTENT_TEXT) {
- target.addText(toString());
- } else if (contentMode == CONTENT_UIDL) {
- target.addUIDL(toString());
- } else if (contentMode == CONTENT_XHTML) {
- target.startTag("data");
- target.addXMLSection("div", toString(),
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd");
- target.endTag("data");
- } else if (contentMode == CONTENT_PREFORMATTED) {
- target.startTag("pre");
- target.addText(toString());
- target.endTag("pre");
- } else if (contentMode == CONTENT_XML) {
- target.addXMLSection("data", toString(), null);
- } else if (contentMode == CONTENT_RAW) {
- target.startTag("data");
- target.addAttribute("escape", false);
- target.addText(toString());
- target.endTag("data");
- }
-
- }
-
- /**
- * 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 se");
- }
- 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 se");
- }
- dataSource.setValue(newValue);
- }
-
- /**
- * @see java.lang.Object#toString()
- */
- public String toString() {
- if (dataSource == null) {
- throw new IllegalStateException("Datasource must be se");
- }
- return dataSource.toString();
- }
-
- /**
- * Gets the type of the Property.
- *
- * @see com.itmill.toolkit.data.Property#getType()
- */
- public Class getType() {
- if (dataSource == null) {
- throw new IllegalStateException("Datasource must be se");
- }
- return dataSource.getType();
- }
-
- /**
- * Gets the viewing data-source property.
- *
- * @return the data source property.
- * @see com.itmill.toolkit.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.itmill.toolkit.data.Property.Viewer#setPropertyDataSource(com.itmill.toolkit.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);
- }
- }
-
- /**
- * Gets the content mode of the Label.
- *
- * <p>
- * Possible content modes include:
- * <ul>
- * <li><b>CONTENT_TEXT</b> Content mode, where the label contains only plain
- * text. The getValue() result is coded to XML when painting.</li>
- * <li><b>CONTENT_PREFORMATTED</b> Content mode, where the label contains
- * preformatted text.</li>
- * <li><b>CONTENT_UIDL</b> Formatted content mode, where the contents is XML
- * restricted to the UIDL 1.0 formatting markups.</li>
- * <li><b>CONTENT_XHTML</b> Content mode, where the label contains XHTML.
- * Contents is then enclosed in DIV elements having namespace of
- * "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd".</li>
- * <li><b>CONTENT_XML</b> Content mode, where the label contains well-formed
- * or well-balanced XML. Each of the root elements must have their default
- * namespace specified.</li>
- * <li><b>CONTENT_RAW</b> Content mode, where the label contains RAW output.
- * Output is not required to comply to with XML. In Web Adapter output is
- * inserted inside the resulting HTML document as-is. This is useful for
- * some specific purposes where possibly broken HTML content needs to be
- * shown, but in most cases XHTML mode should be preferred.</li>
- * </ul>
- * </p>
- *
- * @return the Content mode of the label.
- */
- public int getContentMode() {
- return contentMode;
- }
-
- /**
- * Sets the content mode of the Label.
- *
- * <p>
- * Possible content modes include:
- * <ul>
- * <li><b>CONTENT_TEXT</b> Content mode, where the label contains only plain
- * text. The getValue() result is coded to XML when painting.</li>
- * <li><b>CONTENT_PREFORMATTED</b> Content mode, where the label contains
- * preformatted text.</li>
- * <li><b>CONTENT_UIDL</b> Formatted content mode, where the contents is XML
- * restricted to the UIDL 1.0 formatting markups.</li>
- * <li><b>CONTENT_XHTML</b> Content mode, where the label contains XHTML.
- * Contents is then enclosed in DIV elements having namespace of
- * "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd".</li>
- * <li><b>CONTENT_XML</b> Content mode, where the label contains well-formed
- * or well-balanced XML. Each of the root elements must have their default
- * namespace specified.</li>
- * <li><b>CONTENT_RAW</b> Content mode, where the label contains RAW output.
- * Output is not required to comply to with XML. In Web Adapter output is
- * inserted inside the resulting HTML document as-is. This is useful for
- * some specific purposes where possibly broken HTML content needs to be
- * shown, but in most cases XHTML mode should be preferred.</li>
- * </ul>
- * </p>
- *
- * @param contentMode
- * the New content mode of the label.
- */
- public void setContentMode(int contentMode) {
- if (contentMode >= CONTENT_TEXT && contentMode <= CONTENT_RAW) {
- this.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 IT Mill Ltd.
- * @version
- * @VERSION@
- * @since 3.0
- */
- public class ValueChangeEvent extends Component.Event implements
- Property.ValueChangeEvent {
-
- /**
- * Serial generated by eclipse.
- */
- private static final long serialVersionUID = 3906084563938586935L;
-
- /**
- * 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.itmill.toolkit.data.Property.ValueChangeEvent#getProperty()
- */
- public Property getProperty() {
- return (Property) getSource();
- }
- }
-
- /**
- * Adds the value change listener.
- *
- * @param listener
- * the Listener to be added.
- * @see com.itmill.toolkit.data.Property.ValueChangeNotifier#addListener(com.itmill.toolkit.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.itmill.toolkit.data.Property.ValueChangeNotifier#removeListener(com.itmill.toolkit.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.itmill.toolkit.data.Property.ValueChangeListener#valueChange(Property.ValueChangeEvent)
- */
- public void valueChange(Property.ValueChangeEvent event) {
- fireValueChange();
- }
-
- /**
- * 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 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.
- * </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)
- */
- public int compareTo(Object other) {
-
- String thisValue;
- String otherValue;
-
- if (contentMode == CONTENT_XML || contentMode == CONTENT_UIDL
- || contentMode == CONTENT_XHTML) {
- thisValue = stripTags(toString());
- } else {
- thisValue = toString();
- }
-
- if (other instanceof Label
- && (((Label) other).getContentMode() == CONTENT_XML
- || ((Label) other).getContentMode() == CONTENT_UIDL || ((Label) other)
- .getContentMode() == CONTENT_XHTML)) {
- otherValue = stripTags(other.toString());
- } else {
- 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();
- }
-
- }
|