001: /*
002: * ====================================================================
003: * JAFFA - Java Application Framework For All
004: *
005: * Copyright (C) 2002 JAFFA Development Group
006: *
007: * This library is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU Lesser General Public
009: * License as published by the Free Software Foundation; either
010: * version 2.1 of the License, or (at your option) any later version.
011: *
012: * This library is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this library; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020: *
021: * Redistribution and use of this software and associated documentation ("Software"),
022: * with or without modification, are permitted provided that the following conditions are met:
023: * 1. Redistributions of source code must retain copyright statements and notices.
024: * Redistributions must also contain a copy of this document.
025: * 2. Redistributions in binary form must reproduce the above copyright notice,
026: * this list of conditions and the following disclaimer in the documentation
027: * and/or other materials provided with the distribution.
028: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
029: * this Software without prior written permission. For written permission,
030: * please contact mail to: jaffagroup@yahoo.com.
031: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
032: * appear in their names without prior written permission.
033: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
034: *
035: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
036: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046: * SUCH DAMAGE.
047: * ====================================================================
048: */
049:
050: package org.jaffa.presentation.portlet.widgets.model;
051:
052: import org.apache.log4j.*;
053: import java.util.*;
054: import org.jaffa.metadata.FieldMetaData;
055:
056: /** Model for the DropDown widget.
057: */
058: public class DropDownModel extends WidgetModel {
059: private static Logger log = Logger.getLogger(DropDownModel.class);
060:
061: private String m_value = "";
062: private boolean m_modelChanged = false;
063: private List m_options = new ArrayList();
064: private FieldMetaData m_meta = null;
065: private Boolean m_mandatory = null;
066:
067: /** Creates a model initialized to the input value.
068: * @param dropdownValue The initial value.
069: */
070: public DropDownModel(String dropdownValue) {
071: m_value = dropdownValue;
072: }
073:
074: public DropDownModel(String dropdownValue, FieldMetaData metaObject) {
075: m_value = dropdownValue;
076: m_meta = metaObject;
077:
078: }
079:
080: /** Getter for property value.
081: * @return Value of property value.
082: */
083: public String getValue() {
084: return m_value;
085: }
086:
087: /** Setter for property value.
088: * @param value New value of property value.
089: */
090: public void setValue(String value) {
091: // Only update it and flag it if changed
092: if ((value == null && m_value != null)
093: || (value != null && !value.equals(m_value))) {
094: m_value = value;
095: setModelChanged(true);
096: }
097: }
098:
099: /** Adds an Option to the DropDownModel.
100: * @param label The label of the option.
101: * @param value The value of the option.
102: */
103: public void addOption(String label, String value) {
104: Option option = new Option(label, value);
105: if (!m_options.contains(option)) {
106: m_options.add(option);
107: }
108: }
109:
110: /** Returns a List of DropDownModel.Option objects, for each of the option added to this model.
111: * @return a List of DropDownModel.Option objects, for each of the option added to this model.
112: */
113: public List getOptions() {
114: return m_options;
115: }
116:
117: /** Change the state of the model internally */
118: private void setModelChanged(boolean setState) {
119: m_modelChanged = setState;
120: }
121:
122: /** See if model has changed, in the process reset the changed flag.
123: * @return true if the model was changed.
124: */
125: public boolean isModelChanged() {
126: boolean modified = m_modelChanged;
127: m_modelChanged = false;
128: return modified;
129: }
130:
131: /** An instance of this class is created for each option added to the DropDownModel.
132: */
133: public class Option implements Comparable {
134:
135: /** Holds value of property label. */
136: private String label;
137:
138: /** Holds value of property value. */
139: private String value;
140:
141: private Option(String label, String value) {
142: this .label = label;
143: this .value = value;
144: }
145:
146: /** Getter for property label.
147: * @return Value of property label.
148: */
149: public String getLabel() {
150: return label;
151: }
152:
153: /** Getter for property value.
154: * @return Value of property value.
155: */
156: public String getValue() {
157: return value;
158: }
159:
160: /** Compares this object to another DropDownModel.Option object.
161: * Returns a true if the two objects have the same value.
162: * @param obj The other DropDownModel.Option object.
163: * @return true if the two objects have the same value.
164: */
165: public boolean equals(Object obj) {
166: Option anotheOption = (Option) obj;
167: if (anotheOption == null)
168: return false;
169: else
170: return value != null ? value.equals(anotheOption.value)
171: : anotheOption.value == null;
172: }
173:
174: /** Compares this object with another DropDownModel.Option object.
175: * @param obj the other DropDownModel.Option object.
176: * @return a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
177: */
178: public int compareTo(java.lang.Object obj) {
179: Option anotherOption = (Option) obj;
180: return value.compareTo(anotherOption.value);
181: }
182: }
183:
184: /** Getter for property mandatory.
185: * @return Value of property mandatory.
186: */
187: public boolean isMandatory() {
188: if (m_mandatory != null)
189: return m_mandatory.booleanValue();
190: else if (m_meta != null && m_meta.isMandatory() != null)
191: return m_meta.isMandatory().booleanValue();
192: else
193: return false;
194: }
195:
196: /** Setter for property mandatory.
197: * @param meta New value of property mandatory.
198: */
199: public void setMandatory(boolean mandatory) {
200: m_mandatory = new Boolean(mandatory);
201: }
202:
203: }
|