001: //** Copyright Statement ***************************************************
002: //The Salmon Open Framework for Internet Applications (SOFIA)
003: // Copyright (C) 1999 - 2002, Salmon LLC
004: //
005: // This program is free software; you can redistribute it and/or
006: // modify it under the terms of the GNU General Public License version 2
007: // as published by the Free Software Foundation;
008: //
009: // This program is distributed in the hope that it will be useful,
010: // but WITHOUT ANY WARRANTY; without even the implied warranty of
011: // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
012: // GNU General Public License for more details.
013: //
014: // You should have received a copy of the GNU General Public License
015: // along with this program; if not, write to the Free Software
016: // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
017: //
018: // For more information please visit http://www.salmonllc.com
019: //** End Copyright Statement ***************************************************
020: package com.salmonllc.html.events;
021:
022: /////////////////////////
023: //$Archive: /SOFIA/SourceCode/com/salmonllc/html/events/ValueChangedEvent.java $
024: //$Author: Dan $
025: //$Revision: 12 $
026: //$Modtime: 11/03/04 7:04a $
027: /////////////////////////
028:
029: import com.salmonllc.html.*;
030: import com.salmonllc.sql.*;
031:
032: /**
033: * This object will be created and passed to every value changed event method.
034: * @see ValueChangedListener
035: */
036:
037: public class ValueChangedEvent extends java.awt.AWTEvent {
038: HtmlPage _page;
039: HtmlComponent _comp;
040: String _name;
041: String _fullName;
042: String _oldValue;
043: String _newValue;
044: int _row;
045: int _column;
046: DataStoreBuffer _ds;
047: boolean _acceptValue = true;
048:
049: public static final int PROCESSING_NOTENTERED = -1;
050: public static final int PROCESSING_DISCARD_CHANGE = 1;
051: public static final int PROCESSING_KEEP_CHANGE_IN_QUEUE = 2;
052: public static final int PROCESSING_COMMIT_CHANGE = 3;
053: public static final int PROCESSING_MOVE_CHANGE_TO_TEMP = 4;
054:
055: int _processingInstruction = PROCESSING_NOTENTERED;
056:
057: /**
058: * This method was created in VisualAge.
059: * @param page com.salmonllc.html.HtmlPage
060: * @param comp com.salmonllc.html.HtmlComponent
061: * @param name java.lang.String
062: * @param fullName java.lang.String
063: */
064: public ValueChangedEvent(HtmlPage page, HtmlComponent comp,
065: String name, String fullName, String oldValue,
066: String newValue, int row, int column, DataStoreBuffer ds) {
067: super (comp, 0);
068: _page = page;
069: _comp = comp;
070: _name = name;
071: _fullName = fullName;
072: _oldValue = oldValue;
073: _newValue = newValue;
074: _row = row;
075: _column = column;
076: _ds = ds;
077: }
078:
079: /**
080: * Returns whether or not the changes to the column will be accepted.
081: */
082: public boolean getAcceptValue() {
083: return _acceptValue;
084: }
085:
086: /**
087: * Set this value to false to reject the data value and true to accept it.
088: * @deprecated you should now use the {@link #setAcceptValue(int inst)} method instead
089: */
090: public void setAcceptValue(boolean accept) {
091: _acceptValue = accept;
092: }
093:
094: /**
095: * Use this method to inform the framework how to treat the change
096: * @param inst Valid values are:
097: * PROCESSING_DISCARD_CHANGE - discard the change
098: * PROCESSING_KEEP_CHANGE_IN_QUEUE - don't copy the change to the datastore, but keep it temporarily so it appears on the next page request
099: * PROCESSING_COMMIT_CHANGE - copy the change to the datastore
100: */
101: public void setAcceptValue(int inst) {
102: _processingInstruction = inst;
103: }
104:
105: /**
106: * Returns the accept value as an integer
107: * @see #setAcceptValue(int inst)
108: */
109: public int getAcceptValueInt() {
110: return _processingInstruction;
111: }
112:
113: /**
114: * This method returns the column number in the data store that had a value changed.
115: */
116: public int getColumn() {
117: return _column;
118: }
119:
120: /**
121: * This method returns the component that the value was changed for.
122: */
123: public HtmlComponent getComponent() {
124: return _comp;
125: }
126:
127: /**
128: * This method returns the data store buffer that had a value changed.
129: */
130: public DataStoreBuffer getDataStore() {
131: return _ds;
132: }
133:
134: /**
135: * This method returns the full name (name of component appended to the name of its containers) of the component that submitted the page.
136: */
137: public String getFullName() {
138: return _fullName;
139: }
140:
141: /**
142: * This method returns the name of the component that submitted the page.
143: */
144: public String getName() {
145: return _name;
146: }
147:
148: /**
149: * This method returns the new value for the component
150: */
151: public String getNewValue() {
152: return _newValue;
153: }
154:
155: /**
156: * This method sets the new value for the component
157: */
158: public void setNewValue(String newValue) {
159: _newValue = newValue;
160: }
161:
162: /**
163: * This method returns the old value for the component
164: */
165: public String getOldValue() {
166: return _oldValue;
167: }
168:
169: /**
170: * This method returns the page for which the submit was performed.
171: */
172: public HtmlPage getPage() {
173: return _page;
174: }
175:
176: /**
177: * This method returns the row number in the data store that had a value changed.
178: */
179: public int getRow() {
180: return _row;
181: }
182:
183: /**
184: * Returns the component that submitted the page
185: */
186: public HtmlComponent getSubmitComponent() {
187: return _page.getSubmitComponent();
188: }
189: }
|