KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > swing > BindingBuilder


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */

56 package org.objectstyle.cayenne.swing;
57
58 import java.util.HashMap JavaDoc;
59 import java.util.Map JavaDoc;
60
61 import javax.swing.AbstractButton JavaDoc;
62 import javax.swing.JComboBox JavaDoc;
63 import javax.swing.JTextArea JavaDoc;
64 import javax.swing.JTextField JavaDoc;
65
66 /**
67  * A builder for component bindings that delegates the creation of the binding to the
68  * underlying factory, and itself configures a number of binding parameters.
69  *
70  * @author Andrei Adamchik
71  */

72 public class BindingBuilder {
73
74     protected BindingFactory factory;
75     protected BindingDelegate delegate;
76     protected Object JavaDoc context;
77     protected Map JavaDoc actionsMap;
78
79     /**
80      * Constructs BindingBuilder with a BindingFactory and a root model object (or
81      * context) of the binding.
82      */

83     public BindingBuilder(BindingFactory factory, Object JavaDoc context) {
84         this.factory = factory;
85         this.context = context;
86     }
87
88     public BindingDelegate getDelegate() {
89         return delegate;
90     }
91
92     /**
93      * Sets BindingDelegate that will be assigned to all bindings created via this
94      * BindingBuilder.
95      */

96     public void setDelegate(BindingDelegate delegate) {
97         this.delegate = delegate;
98     }
99
100     public Object JavaDoc getContext() {
101         return context;
102     }
103
104     /**
105      * Sets the context object that will be used by all bindings created via this
106      * BindingBuilder. Context is a root of the domain model for the given binding.
107      */

108     public void setContext(Object JavaDoc context) {
109         this.context = context;
110     }
111
112     public BindingFactory getFactory() {
113         return factory;
114     }
115
116     /**
117      * Binds to an instance of BoundComponent.
118      *
119      * @since 1.2
120      */

121     public ObjectBinding bindToProperty(
122             BoundComponent component,
123             String JavaDoc property,
124             String JavaDoc boundProperty) {
125         ObjectBinding binding = factory
126                 .bindToProperty(component, property, boundProperty);
127         return initBinding(binding, delegate);
128     }
129
130     public ObjectBinding bindToStateChange(AbstractButton JavaDoc button, String JavaDoc property) {
131         ObjectBinding binding = factory.bindToStateChange(button, property);
132         return initBinding(binding, delegate);
133     }
134
135     public ObjectBinding bindToStateChangeAndAction(AbstractButton JavaDoc button, String JavaDoc property, String JavaDoc action) {
136         ObjectBinding binding = factory.bindToStateChange(button, property);
137         return initBinding(binding, getActionDelegate(action));
138     }
139
140     public ObjectBinding bindToAction(AbstractButton JavaDoc button, String JavaDoc action) {
141         ObjectBinding binding = factory.bindToAction(button, action);
142         return initBinding(binding, delegate);
143     }
144
145     public ObjectBinding bindToComboSelection(JComboBox JavaDoc component, String JavaDoc property) {
146         ObjectBinding binding = factory.bindToComboSelection(component, property, null);
147         return initBinding(binding, delegate);
148     }
149
150     public ObjectBinding bindToComboSelection(
151             JComboBox JavaDoc component,
152             String JavaDoc property,
153             String JavaDoc noSelectionValue) {
154         ObjectBinding binding = factory.bindToComboSelection(component,
155                 property,
156                 noSelectionValue);
157         return initBinding(binding, delegate);
158     }
159
160     public ObjectBinding bindToComboSelection(
161             JComboBox JavaDoc component,
162             String JavaDoc property,
163             String JavaDoc action,
164             String JavaDoc noSelectionValue) {
165         ObjectBinding binding = factory.bindToComboSelection(component,
166                 property,
167                 noSelectionValue);
168         return initBinding(binding, getActionDelegate(action));
169     }
170
171     public ObjectBinding bindToTextArea(JTextArea JavaDoc component, String JavaDoc property) {
172         ObjectBinding binding = factory.bindToTextArea(component, property);
173         return initBinding(binding, delegate);
174     }
175
176     public ObjectBinding bindToTextField(JTextField JavaDoc component, String JavaDoc property) {
177         ObjectBinding binding = factory.bindToTextField(component, property);
178         return initBinding(binding, delegate);
179     }
180
181     protected ObjectBinding initBinding(ObjectBinding binding, BindingDelegate delegate) {
182         binding.setDelegate(delegate);
183         binding.setContext(context);
184         return binding;
185     }
186
187     protected BindingDelegate getActionDelegate(String JavaDoc action) {
188         BindingDelegate delegate = null;
189
190         if (actionsMap == null) {
191             actionsMap = new HashMap JavaDoc();
192         }
193         else {
194             delegate = (BindingDelegate) actionsMap.get(action);
195         }
196
197         if (delegate == null) {
198             delegate = new ActionDelegate(action);
199             actionsMap.put(action, delegate);
200         }
201
202         return delegate;
203     }
204 }
Popular Tags