KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > swt > events > TraverseListener


1 /*******************************************************************************
2  * Copyright (c) 2000, 2003 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.swt.events;
12
13
14 import org.eclipse.swt.internal.SWTEventListener;
15
16 /**
17  * Classes which implement this interface provide a method
18  * that deals with the events that are generated when a
19  * traverse event occurs in a control.
20  * <p>
21  * After creating an instance of a class that implements
22  * this interface it can be added to a control using the
23  * <code>addTraverseListener</code> method and removed using
24  * the <code>removeTraverseListener</code> method. When a
25  * traverse event occurs in a control, the keyTraversed method
26  * will be invoked.
27  * </p>
28  *
29  * @see TraverseEvent
30  */
31 public interface TraverseListener extends SWTEventListener {
32
33 /**
34  * Sent when a traverse event occurs in a control.
35  * <p>
36  * A traverse event occurs when the user presses a traversal
37  * key. Traversal keys are typically tab and arrow keys, along
38  * with certain other keys on some platforms. Traversal key
39  * constants beginning with <code>TRAVERSE_</code> are defined
40  * in the <code>SWT</code> class.
41  * </p>
42  *
43  * @param e an event containing information about the traverse
44  */
45 public void keyTraversed(TraverseEvent e);
46 }
47
Popular Tags