Refactoring: Enably -> IT Mill Toolkit

svn changeset:92/svn branch:toolkit

1 files changed, 394 insertions, 0 deletions

diff --git a/src/com/itmill/toolkit/ui/TextField.java b/src/com/itmill/toolkit/ui/TextField.java
new file mode 100644
index 0000000000..86e3f14d50
--- /dev/null
+++ b/src/com/itmill/toolkit/ui/TextField.java
@@ -0,0 +1,394 @@
+/* *************************************************************************
+ 
+                               IT Mill Toolkit 
+
+               Development of Browser User Intarfaces Made Easy
+
+                    Copyright (C) 2000-2006 IT Mill Ltd
+                     
+   *************************************************************************
+
+   This product is distributed under commercial license that can be found
+   from the product package on license/license.txt. Use of this product might 
+   require purchasing a commercial license from IT Mill Ltd. For guidelines 
+   on usage, see license/licensing-guidelines.html
+
+   *************************************************************************
+   
+   For more information, contact:
+   
+   IT Mill Ltd                           phone: +358 2 4802 7180
+   Ruukinkatu 2-4                        fax:   +358 2 4802 7181
+   20540, Turku                          email:  info@itmill.com
+   Finland                               company www: www.itmill.com
+   
+   Primary source for information and releases: www.itmill.com
+
+   ********************************************************************** */
+
+package com.itmill.toolkit.ui;
+
+import java.text.Format;
+import java.util.Map;
+
+import com.itmill.toolkit.data.Property;
+import com.itmill.toolkit.terminal.PaintException;
+import com.itmill.toolkit.terminal.PaintTarget;
+
+/** <p>A text editor component that can be bound to any bindable Property.
+ * The text editor supports both multiline and single line modes, default
+ * is one-line mode.</p>
+ *
+ * <p>Since <code>TextField</code> extends <code>AbstractField</code> it
+ * implements the {@link com.itmill.toolkit.data.Buffered} interface. A
+ * <code>TextField</code> is in write-through mode by default, so
+ * {@link com.itmill.toolkit.ui.AbstractField#setWriteThrough(boolean)}
+ * must be called to enable buffering.</p>
+ *
+ * @author IT Mill Ltd.
+ * @version @VERSION@
+ * @since 3.0
+ */
+public class TextField extends AbstractField {
+
+	/* Private members ************************************************* */
+
+	/** Value formatter used to format the string contents*/
+	private Format format;
+
+	/** Number of visible columns in the TextField. */
+	private int columns = 0;
+
+	/** Number of visible rows in a multiline TextField. Value 0 implies a
+	 * single-line text-editor.
+	 */
+	private int rows = 0;
+
+	/** Tells if word-wrapping should be used in multiline mode. */
+	private boolean wordwrap = true;
+
+	/** Tells if input is used to enter sensitive information that is
+	 *  not echoed to display. Typically passwords. 
+	 */
+	private boolean secret = false;
+
+	/** Null representation. */
+	private String nullRepresentation = "null";
+
+	/** Is setting to null from non-null value allowed by setting with 
+	 * null representation */
+	private boolean nullSettingAllowed = false;
+
+	/* Constructors **************************************************** */
+
+	/** Constructs an empty <code>TextField</code> with no caption. */
+	public TextField() {
+		setValue("");
+	}
+
+	/** Constructs an empty <code>TextField</code> with given caption. */
+	public TextField(String caption) {
+		setValue("");
+		setCaption(caption);
+	}
+
+	/** Constructs a new <code>TextField</code> that's bound to the
+	 * specified <code>Property</code> and has no caption.
+	 * 
+	 * @param dataSource the Property to be edited with this editor
+	 */
+	public TextField(Property dataSource) {
+		setPropertyDataSource(dataSource);
+	}
+
+	/** Constructs a new <code>TextField</code> that's bound to the
+	 * specified <code>Property</code> and has the given caption
+	 * <code>String</code>.
+	 * 
+	 * @param caption caption <code>String</code> for the editor
+	 * @param dataSource the Property to be edited with this editor
+	 */
+	public TextField(String caption, Property dataSource) {
+		this(dataSource);
+		setCaption(caption);
+	}
+
+	/** Constructs a new <code>TextField</code> with the given caption and
+	 * initial text contents. The editor constructed this way will not be
+	 * bound to a Property unless
+	 * {@link com.itmill.toolkit.data.Property.Viewer#setPropertyDataSource(Property)}
+	 * is called to bind it.
+	 * 
+	 * @param caption caption <code>String</code> for the editor
+	 * @param text initial text content of the editor
+	 */
+	public TextField(String caption, String value) {
+		setValue(value);
+		setCaption(caption);
+	}
+
+	/* Component basic features ********************************************* */
+
+	/* Paint this component.
+	 * Don't add a JavaDoc comment here, we use the default documentation
+	 * from implemented interface.
+	 */
+	public void paintContent(PaintTarget target) throws PaintException {
+		super.paintContent(target);
+
+		// Set secret attribute
+		if (this.isSecret())
+			target.addAttribute("secret", true);
+
+		// Add the number of column and rows
+		int c = getColumns();
+		int r = getRows();
+		if (c != 0)
+			target.addAttribute("cols", String.valueOf(c));
+		if (r != 0) {
+			target.addAttribute("rows", String.valueOf(r));
+			target.addAttribute("multiline", true);
+			if (!wordwrap)
+				target.addAttribute("wordwrap", false);
+		}
+
+		// Add content as variable
+		String value = getFormattedValue();
+		if (value == null)
+			value = getNullRepresentation();
+		if (value == null)
+			throw new IllegalStateException("Null values are not allowed if the null-representation is null");
+		target.addVariable(this, "text", value);
+	}
+
+	/** Get the formatted dtring value.
+	 *  Sets the field value by using the assigned Format.
+	 * @param value to be formatted
+	 * @return Formatted value
+	 * @see #setFormat(Format)
+	 * @see Format
+	 */
+	protected String getFormattedValue() {
+		Object value = getValue();
+		if (this.format != null && value != null)
+			try {
+				return this.format.format(value);
+			} catch (IllegalArgumentException ignored) {
+				// Ignored exception
+			}
+		if (value != null)
+			return value.toString();
+		return null;
+	}
+
+	/* Gets the components UIDL tag string.
+	 * Don't add a JavaDoc comment here, we use the default documentation
+	 * from implemented interface.
+	 */
+	public String getTag() {
+		return "textfield";
+	}
+
+	/* Invoked when a variable of the component changes.
+	 * Don't add a JavaDoc comment here, we use the default documentation
+	 * from implemented interface.
+	 */
+	public void changeVariables(Object source, Map variables) {
+
+		// Set the text
+		if (variables.containsKey("text") && !isReadOnly()) {
+
+			// Only do the setting if the string representation of the value
+			// has been updated
+			String newValue = (String) variables.get("text");
+			String oldValue = getFormattedValue();
+			if (newValue != null
+				&& (oldValue == null || isNullSettingAllowed())
+				&& newValue.equals(getNullRepresentation()))
+				newValue = null;
+			if (newValue != oldValue
+				&& (newValue == null || !newValue.equals(oldValue)))
+				setValue(newValue);
+		}
+
+	}
+
+	/* Text field configuration ********************************************* */
+
+	/** Gets the number of columns in the editor. If the number of columns
+	 * is set 0, the actual number of displayed columns is determined
+	 * implicitly by the adapter.
+	 * 
+	 * @param the number of columns for this editor
+	 */
+	public int getColumns() {
+		return this.columns;
+	}
+
+	/** Sets the number of columns in the editor. If the number of columns
+	 * is set 0, the actual number of displayed columns is determined
+	 * implicitly by the adapter.
+	 * 
+	 * @return number of explicitly set columns
+	 */
+	public void setColumns(int columns) {
+		if (columns < 0)
+			columns = 0;
+		this.columns = columns;
+		requestRepaint();
+	}
+
+	/** Gets the number of rows in the editor. If the number of rows is set
+	 * to 0, the actual number of displayed rows is determined implicitly by
+	 * the adapter.
+	 * 
+	 * @return number of explicitly set rows
+	 */
+	public int getRows() {
+		return this.rows;
+	}
+
+	/** Sets the number of rows in the editor. If the number of rows is set
+	 * to 0, the actual number of displayed rows is determined implicitly by
+	 * the adapter.
+	 * 
+	 * @param the number of rows for this editor
+	 */
+	public void setRows(int rows) {
+		if (rows < 0)
+			rows = 0;
+		this.rows = rows;
+		requestRepaint();
+	}
+
+	/** Tests if the editor is in word-wrap mode.
+	 * 
+	 * @return <code>true</code> if the component is in the word-wrap mode,
+	 * <code>false</code> if not
+	 */
+	public boolean isWordwrap() {
+		return this.wordwrap;
+	}
+
+	/** Sets the editor's word-wrap mode on or off. 
+	 * 
+	 * @param wordwrap boolean value specifying if the editor should be in
+	 * word-wrap mode after the call or not.
+	 */
+	public void setWordwrap(boolean wordwrap) {
+		this.wordwrap = wordwrap;
+	}
+
+	/* Property features **************************************************** */
+
+	/* Gets the edited property's type.
+	 * Don't add a JavaDoc comment here, we use the default documentation
+	 * from implemented interface.
+	 */
+	public Class getType() {
+		return String.class;
+	}
+	/** Get the secret property on and off.
+	 * If a field is used to enter secretinformation
+	 * the information is not echoed to display.
+	 * @return true if the field is used to enter secret information, false otherwise.
+	 */
+	public boolean isSecret() {
+		return secret;
+	}
+
+	/** Set the secret property on and off.
+	 * If a field is used to enter secretinformation
+	 * the information is not echoed to display.
+	 * @param secret value specifying if the field is used to enter secret information.
+	 */
+	public void setSecret(boolean secret) {
+		this.secret = secret;
+	}
+
+	/** Get the null-string representation.
+	 * 
+	 * <p>The null-valued strings are represented on the user interface by replacing the 
+	 * null value with this string. If the null representation is set null (not 'null' string),
+	 * painting null value throws exception.</p>
+	 * 
+	 * <p>The default value is string 'null'</p>
+	 * 
+	 * @see TextField#isNullSettingAllowed()
+	 * @return String Textual representation for null strings.
+	 */
+	public String getNullRepresentation() {
+		return nullRepresentation;
+	}
+
+	/** Is setting nulls with null-string representation allowed.
+	 * 
+	 * <p>If this property is true, writing null-representation string to text 
+	 * field allways sets the field value to real null. If this property is 
+	 * false, null setting is not made, but the null values are maintained. 
+	 * Maintenance of null-values is made by only converting the textfield
+	 * contents to real null, if the text field matches the null-string 
+	 * representation and the current value of the field is null.</p>
+	 * 
+	 * <p>By default this setting is false</p>
+	 * 
+	 * @return boolean Should the null-string represenation be allways
+	 * converted to null-values.
+	 * @see TextField#getNullRepresentation()
+	 */
+	public boolean isNullSettingAllowed() {
+		return nullSettingAllowed;
+	}
+
+	/** Sets the null-string representation.
+	 * 
+	 * <p>The null-valued strings are represented on the user interface by replacing the 
+	 * null value with this string. If the null representation is set null (not 'null' string),
+	 * painting null value throws exception.</p>
+	 * 
+	 * <p>The default value is string 'null'</p>
+	 * 
+	 * @see TextField#setNullSettingAllowed(boolean)
+	 * @param nullRepresentation Textual representation for null strings.
+	 */
+	public void setNullRepresentation(String nullRepresentation) {
+		this.nullRepresentation = nullRepresentation;
+	}
+
+	/** Set the null conversion mode.
+	 * 
+	 * <p>If this property is true, writing null-representation string to text 
+	 * field allways sets the field value to real null. If this property is 
+	 * false, null setting is not made, but the null values are maintained. 
+	 * Maintenance of null-values is made by only converting the textfield
+	 * contents to real null, if the text field matches the null-string 
+	 * representation and the current value of the field is null.</p>
+	 * 
+	 * <p>By default this setting is false</p>
+	 * 
+	 * @param nullSettingAllowed Should the null-string represenation be allways
+	 * converted to null-values.
+	 * @see TextField#getNullRepresentation()
+	 */
+	public void setNullSettingAllowed(boolean nullSettingAllowed) {
+		this.nullSettingAllowed = nullSettingAllowed;
+	}
+
+	/** Get the value formatter of TextField.
+	 * 
+	 * 
+	 * @return The Format used to format the value.
+	 */
+	public Format getFormat() {
+		return format;
+	}
+
+	/** Get the value formatter of TextField.
+	 * 
+	 * @param The Format used to format the value. Null disables the formatting.
+	 */
+	public void setFormat(Format format) {
+		this.format = format;
+	}
+
+}