001: /*
002: * TextArea.java
003: *
004: * Version: $Revision: 1.2 $
005: *
006: * Date: $Date: 2006/07/06 17:02:03 $
007: *
008: * Copyright (c) 2002, Hewlett-Packard Company and Massachusetts
009: * Institute of Technology. All rights reserved.
010: *
011: * Redistribution and use in source and binary forms, with or without
012: * modification, are permitted provided that the following conditions are
013: * met:
014: *
015: * - Redistributions of source code must retain the above copyright
016: * notice, this list of conditions and the following disclaimer.
017: *
018: * - Redistributions in binary form must reproduce the above copyright
019: * notice, this list of conditions and the following disclaimer in the
020: * documentation and/or other materials provided with the distribution.
021: *
022: * - Neither the name of the Hewlett-Packard Company nor the name of the
023: * Massachusetts Institute of Technology nor the names of their
024: * contributors may be used to endorse or promote products derived from
025: * this software without specific prior written permission.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
028: * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
029: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
030: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
031: * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
032: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
033: * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
034: * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
035: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
036: * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
037: * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
038: * DAMAGE.
039: */
040:
041: package org.dspace.app.xmlui.wing.element;
042:
043: /**
044: * A class representing a text area input control. The text area control enables
045: * to user to entere muliple lines of text.
046: *
047: * @author Scott Phillips
048: */
049:
050: import org.dspace.app.xmlui.wing.Message;
051: import org.dspace.app.xmlui.wing.WingContext;
052: import org.dspace.app.xmlui.wing.WingException;
053:
054: public class TextArea extends Field {
055:
056: /**
057: * Construct a new field.
058: *
059: * @param context
060: * (Required) The context this element is contained in, such as
061: * where to route SAX events and what i18n catalogue to use.
062: *
063: * @param name
064: * (Required) a non-unique local identifier used to differentiate
065: * the element from its siblings within an interactive division.
066: * This is the name of the field use when data is submitted back
067: * to the server.
068: * @param rend
069: * (May be null) a rendering hint used to override the default
070: * display of the element.
071: */
072: protected TextArea(WingContext context, String name, String rend)
073: throws WingException {
074: super (context, name, Field.TYPE_TEXTAREA, rend);
075: this .params = new Params(context);
076: }
077:
078: /**
079: * Set the size of the text area.
080: *
081: * @param rows
082: * (May be zero for no defined value) The default number of rows
083: * that the text area should span.
084: * @param cols
085: * (May be zero for no defined value) The default number of
086: * columns that the text area should span.
087: */
088: public void setSize(int rows, int cols) {
089: this .params.setRows(rows);
090: this .params.setCols(cols);
091: }
092:
093: /**
094: * Set the maximum length of the field.
095: *
096: * @param maxlength
097: * (May be zero for no defined value) The maximum length that the
098: * theme should accept for form input.
099: */
100: public void setMaxLength(int maxLength) {
101: this .params.setMaxLength(maxLength);
102: }
103:
104: /**
105: * Enable the add operation for this field. When this is enabled the
106: * front end will add a button to add more items to the field.
107: *
108: */
109: public void enableAddOperation() throws WingException {
110: this .params.enableAddOperation();
111: }
112:
113: /**
114: * Enable the delete operation for this field. When this is enabled then
115: * the front end will provide a way for the user to select fields (probably
116: * checkboxes) along with a submit button to delete the selected fields.
117: *
118: */
119: public void enableDeleteOperation() throws WingException {
120: this .params.enableDeleteOperation();
121: }
122:
123: /** ******************************************************************** */
124: /** Raw Values * */
125: /** ******************************************************************** */
126:
127: /**
128: * Set the raw value of the field removing any previous raw values.
129: *
130: * @param characters
131: * (May be null) Field value as a string
132: */
133: public Value setValue() throws WingException {
134: removeValueOfType(Value.TYPE_RAW);
135: Value value = new Value(context, Value.TYPE_RAW);
136: values.add(value);
137: return value;
138: }
139:
140: /**
141: * Set the raw value of the field removing any previous raw values.
142: *
143: * @param characters
144: * (May be null) Field value as a string
145: */
146: public void setValue(String characters) throws WingException {
147: Value value = this .setValue();
148: value.addContent(characters);
149: }
150:
151: /**
152: * Set the raw value of the field removing any previous raw values.
153: *
154: * @param message
155: * (Required) A key into the i18n catalogue for translation into
156: * the user's preferred language.
157: */
158: public void setValue(Message message) throws WingException {
159: Value value = this .setValue();
160: value.addContent(message);
161: }
162:
163: /**
164: * Add a field instance
165: * @return instance
166: */
167: public Instance addInstance() throws WingException {
168: Instance instance = new Instance(context);
169: instances.add(instance);
170: return instance;
171: }
172: }
|