Source code: org/progeeks/meta/swing/editor/AbstractSpinnerEditor.java
1 /*
2 * $Id: AbstractSpinnerEditor.java,v 1.7 2003/09/01 03:52:20 pspeed Exp $
3 *
4 * Copyright (c) 2001-2002, Paul Speed
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1) Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
13 * 2) Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3) Neither the names "Progeeks", "Meta-JB", nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 package org.progeeks.meta.swing.editor;
34
35 import java.awt.*;
36 import java.awt.event.*;
37 import java.beans.*;
38 import javax.swing.*;
39 import javax.swing.event.*;
40
41 import org.progeeks.meta.*;
42 import org.progeeks.meta.format.*;
43 import org.progeeks.meta.swing.*;
44
45 /**
46 * Basic spinner control editor implementation.
47 *
48 * @version $Revision: 1.7 $
49 * @author Paul Speed
50 */
51 public abstract class AbstractSpinnerEditor extends AbstractPropertyEditor
52 {
53 private JSpinner component;
54 private Object spinnerValue;
55 private EditorListener editListener = new EditorListener();
56
57 protected AbstractSpinnerEditor()
58 {
59 component = createSpinner();
60
61 component.addChangeListener( editListener );
62 }
63
64 /**
65 * Returns the component that allows modification of the
66 * associated property mutator.
67 */
68 public Component getUIComponent()
69 {
70 return( component );
71 }
72
73 /**
74 * Implemented by subclasses to release any component-related
75 * resources.
76 */
77 protected void releaseComponent()
78 {
79 component.removeChangeListener( editListener );
80 }
81
82 protected abstract JSpinner createSpinner();
83
84 protected abstract Object getEmptyValue();
85
86 /**
87 * Called to set the component value to a default state.
88 * The default implementation calls setComponentValue(null).
89 */
90 protected void resetComponentValue()
91 {
92 spinnerValue = getEmptyValue();
93 component.setValue( spinnerValue );
94 }
95
96 /**
97 * Called to set the current value displayed in the component.
98 */
99 protected void setComponentValue( Object value )
100 {
101 if( value == null )
102 value = getEmptyValue();
103 component.setValue( value );
104 }
105
106 protected void componentChanged()
107 {
108 // A quick short-circuit if the value of the spinner
109 // hasn't changed.
110 Object val = component.getValue();
111 if( val == spinnerValue || (val != null && val.equals( spinnerValue )) )
112 return;
113
114 spinnerValue = val;
115 setPropertyValue( val );
116 }
117
118 private class EditorListener implements ChangeListener
119 {
120 public void stateChanged( ChangeEvent event )
121 {
122 componentChanged();
123 }
124 }
125 }