001: /*
002: * The contents of this file are subject to the terms of the Common Development
003: * and Distribution License (the License). You may not use this file except in
004: * compliance with the License.
005: *
006: * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
007: * or http://www.netbeans.org/cddl.txt.
008: *
009: * When distributing Covered Code, include this CDDL Header Notice in each file
010: * and include the License file at http://www.netbeans.org/cddl.txt.
011: * If applicable, add the following below the CDDL Header, with the fields
012: * enclosed by brackets [] replaced by your own identifying information:
013: * "Portions Copyrighted [year] [name of copyright owner]"
014: *
015: * The Original Software is NetBeans. The Initial Developer of the Original
016: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
017: * Microsystems, Inc. All Rights Reserved.
018: */
019:
020: package org.netbeans.modules.soa.mapper.basicmapper.canvas.jgo;
021:
022: import java.awt.Point;
023:
024: import java.util.ArrayList;
025: import java.util.Collection;
026:
027: import org.netbeans.modules.soa.mapper.common.gtk.ICanvas;
028: import org.netbeans.modules.soa.mapper.common.gtk.ICanvasMouseData;
029:
030: /**
031: * <p>
032: *
033: * Title: </p> BasicCanvasMouseData<p>
034: *
035: * Description: </p> BasicCanvasMouseData provides basic implemeation of
036: * ICanvasMouseData. <p>
037: *
038: * Copyright: Copyright (c) 2002 </p> <p>
039: *
040: * Company: </p>
041: *
042: * @author unascribed
043: * @created December 4, 2002
044: * @version 1.0
045: */
046: public class BasicCanvasMouseData implements ICanvasMouseData {
047: /**
048: * The position of the canvas object
049: */
050: public static final int CANVAS = 0;
051:
052: /**
053: * The position of the modifier
054: */
055: public static final int MODIFIER = 1;
056:
057: /**
058: * The position of the document location object(Point)
059: */
060: public static final int DOCUMENT_LOCATION = 2;
061:
062: /**
063: * The position of the view location object(Point)
064: */
065: public static final int VIEW_LOCATION = 3;
066:
067: /**
068: * Mouse modifier
069: */
070: protected int mModifier = 0;
071:
072: /**
073: * The document location
074: */
075: protected Point mDocLocation = null;
076:
077: /**
078: * The view location
079: */
080: protected Point mViewLocation = null;
081:
082: /**
083: * Event data collection
084: */
085: protected ArrayList mEventDataCollection = new ArrayList();
086:
087: /**
088: * The canvas
089: */
090: protected BasicCanvasView mCanvas;
091:
092: /**
093: * Instaniate an BasicCanvasMouseData with all the configuration data.
094: *
095: * @param canvas - the canvas
096: * @param modifier - the modifier
097: * @param docLocation - the document location
098: * @param viewLocation - the view location
099: */
100: public BasicCanvasMouseData(BasicCanvasView canvas, int modifier,
101: Point docLocation, Point viewLocation) {
102: mCanvas = canvas;
103: mModifier = modifier;
104: mDocLocation = docLocation;
105:
106: mViewLocation = viewLocation;
107:
108: //JL: why do we need this collection?
109: //JL: shouldn't they be retrieved with member methods
110: mEventDataCollection.add(CANVAS, mCanvas);
111: mEventDataCollection.add(MODIFIER, new Integer(mModifier));
112: mEventDataCollection.add(DOCUMENT_LOCATION, mDocLocation);
113: mEventDataCollection.add(VIEW_LOCATION, mViewLocation);
114: }
115:
116: /**
117: * Retrieves the canvas
118: *
119: * @return The canvas value
120: */
121: public ICanvas getCanvas() {
122: return mCanvas;
123: }
124:
125: /**
126: * Retrieves the data at specified index
127: *
128: * @param index - index of the indiviudal data object
129: * @return The data value
130: */
131: public Object getData(int index) {
132: return mEventDataCollection.get(index);
133: }
134:
135: /**
136: * Retrieves the data collection
137: *
138: * @return - collection
139: */
140: public Collection getDataCollection() {
141: return mEventDataCollection;
142: }
143:
144: /**
145: * Retrieves doc location
146: *
147: * @return The docLocation value
148: */
149: public Point getDocLocation() {
150: return mDocLocation;
151: }
152:
153: /**
154: * Retrieves doc location
155: *
156: * @return The modelLocation value
157: */
158: public Point getModelLocation() {
159: return mDocLocation;
160: }
161:
162: /**
163: * Retrieves the modifier
164: *
165: * @return The modifier value
166: */
167: public int getModifier() {
168: return mModifier;
169: }
170:
171: /**
172: * Retrieves the modifier
173: *
174: * @return The mouseModifier value
175: */
176: public int getMouseModifier() {
177: return mModifier;
178: }
179:
180: /**
181: * Retrieve the view locaiton
182: *
183: * @return The viewLocation value
184: */
185: public Point getViewLocation() {
186: return mViewLocation;
187: }
188:
189: /**
190: * Returns a string describing the object.
191: *
192: * @return a String
193: */
194: public String toString() {
195: return "doc location: " + mDocLocation + ", view location: "
196: + mViewLocation;
197: }
198: }
|