aboutsummaryrefslogtreecommitdiffstats
path: root/Java/com/phidgets/event/KeyChangeEvent.java
blob: fe86cdabb268cf5c4ed8106034a443dfb8a7c8b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/*
 * Copyright 2006 Dictionarys Inc.  All rights reserved.
 */

package com.phidgets.event;

import com.phidgets.Dictionary;

/**
 * This class represents the data for a KeyChangeEvent.
 * 
 * @author Dictionarys Inc.
 */
public class KeyChangeEvent
{
	Dictionary source;
	String value;
	String key;

	/**
	 * Class constructor. This is called internally by the Dictionary library when creating this event.
	 * 
	 * @param source the Dictionary object from which this event originated
	 */
	public KeyChangeEvent(Dictionary source, String key, String value)
	{
		this.source = source;
		this.value = value;
		this.key = key;
	}

	/**
	 * Returns the source Dictionary of this event. This is a reference to the Dictionary object from which this
	 * event was called. This object can be cast into a specific type of Dictionary object to call specific
	 * device calls on it.
	 * 
	 * @return the event caller
	 */
	public Dictionary getSource() {
		return source;
	}

	public String getKey()
	{
		return key;
	}

	public String getValue()
	{
		return value;
	}

	/**
	 * Returns a string containing information about the event.
	 * 
	 * @return an informative event string
	 */
	public String toString()
	{
		return source.toString() + " Key changed: "
		  + key + ":" + value;
	}
}