001: /*
002: * Copyright (c) 2004 JETA Software, Inc. All rights reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without modification,
005: * are permitted provided that the following conditions are met:
006: *
007: * o Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: *
010: * o Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: *
014: * o Neither the name of JETA Software nor the names of its contributors may
015: * be used to endorse or promote products derived from this software without
016: * specific prior written permission.
017: *
018: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
020: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
021: * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
022: * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
023: * INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
024: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
025: * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
026: * INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028: */
029:
030: package com.jeta.forms.store.properties;
031:
032: import java.awt.Component;
033: import java.io.IOException;
034: import java.util.Collection;
035: import java.util.Iterator;
036:
037: import javax.swing.DefaultListModel;
038: import javax.swing.JComboBox;
039: import javax.swing.JList;
040:
041: import com.jeta.forms.components.list.ListItemRenderer;
042: import com.jeta.forms.gui.beans.JETABean;
043: import com.jeta.forms.store.JETAObjectInput;
044: import com.jeta.forms.store.JETAObjectOutput;
045:
046: /**
047: * This property is used to represent a Collection of objects for those beans
048: * that support showing a group. For example: JComboBox and JList.
049: *
050: * @author Jeff Tassin
051: */
052: public class ItemsProperty extends JETAProperty {
053: static final long serialVersionUID = -382961445445803877L;
054:
055: /**
056: * The current version number of this class
057: */
058: public static final int VERSION = 1;
059:
060: /**
061: * The Collection of items in this property that will be added to the JList
062: * or JComboBox. This collection will normally contain String objects or
063: * more likely, ListItemProperty objects.
064: */
065: private Collection m_items;
066:
067: /**
068: * The name of this property
069: */
070: public static final String PROPERTY_ID = "items";
071:
072: /**
073: * Creates an unitialized <code>ItemsProperty</code> instance.
074: */
075: public ItemsProperty() {
076: super (PROPERTY_ID);
077: }
078:
079: /**
080: * Creates an <code>ItemsProperty</code> instance with the specified list
081: * items.
082: *
083: * @param items
084: * a collection of objects used to populate the Java bean.
085: */
086: public ItemsProperty(Collection items) {
087: super (PROPERTY_ID);
088: setItems(items);
089: }
090:
091: /**
092: * Returns the collection of objects used to populate the Java bean
093: * associated with this property. This collection will contain either
094: * Strings or ListItemProperty objects.
095: *
096: * @return the items in this property
097: */
098: public Collection getItems() {
099: return m_items;
100: }
101:
102: /**
103: * Sets the items of this property.
104: *
105: * @param items
106: * the items for this property. This collection will contain
107: * either Strings or ListItemProperty objects.
108: */
109: private void setItems(Collection items) {
110: if (items == null)
111: m_items = null;
112: else
113: m_items = new java.util.LinkedList(items);
114: }
115:
116: /**
117: * Sets the values of this property to that of another ItemsProperty.
118: *
119: * @param prop
120: * an ItemsProperty object.
121: */
122: public void setValue(Object prop) {
123: if (prop instanceof ItemsProperty) {
124: ItemsProperty ip = (ItemsProperty) prop;
125: setItems(ip.getItems());
126: } else {
127: assert (false);
128: }
129: }
130:
131: /**
132: * Updates the bean with the current items of this property. If the
133: * associated Java bean is a JComboBox or JList, the items of this property
134: * are added to the bean. Additionally, a ListItemRenderer is set as the
135: * renderer for the bean. This allows any icons associated with the list
136: * items to be correctly rendered.
137: */
138: public void updateBean(JETABean jbean) {
139: Component comp = null;
140: if (jbean != null)
141: comp = jbean.getDelegate();
142:
143: if (comp instanceof JComboBox) {
144: JComboBox jbox = (JComboBox) comp;
145: jbox.setRenderer(new ListItemRenderer());
146: jbox.removeAllItems();
147: if (m_items != null) {
148: Iterator iter = m_items.iterator();
149: while (iter.hasNext()) {
150: jbox.addItem(iter.next());
151: }
152: }
153: } else if (comp instanceof JList) {
154: JList list = (JList) comp;
155: Object lm = list.getModel();
156: if (lm instanceof DefaultListModel) {
157: list.setCellRenderer(new ListItemRenderer());
158: DefaultListModel lmodel = (DefaultListModel) lm;
159: lmodel.removeAllElements();
160: if (m_items != null) {
161: Iterator iter = m_items.iterator();
162: while (iter.hasNext()) {
163: lmodel.addElement(iter.next());
164: }
165: }
166: }
167: }
168: }
169:
170: /**
171: * JETAPersistable Implementation
172: */
173: public void read(JETAObjectInput in) throws ClassNotFoundException,
174: IOException {
175: super .read(in.getSuperClassInput());
176: int version = in.readVersion();
177: m_items = (Collection) in.readObject("items");
178: }
179:
180: /**
181: * JETAPersistable Implementation
182: */
183: public void write(JETAObjectOutput out) throws IOException {
184: super .write(out.getSuperClassOutput(JETAProperty.class));
185: out.writeVersion(VERSION);
186: out.writeObject("items", m_items);
187: }
188:
189: public String toString() {
190: if (m_items == null)
191: return "Items Property: null " + hashCode();
192: else
193: return "Items Property: size: " + m_items.size() + " "
194: + hashCode();
195: }
196: }
|