com.extjs.gxt.ui.client.util
Class KeyNav<E extends ComponentEvent>

java.lang.Object
  com.extjs.gxt.ui.client.event.BaseObservable
      com.extjs.gxt.ui.client.util.KeyNav<E>

All Implemented Interfaces:

Listener<E>, Observable, java.util.EventListener

public class KeyNav<E extends ComponentEvent>
extends BaseObservable
implements Listener<E>

Convenient helper class to process a component's key events.

Constructor Summary

KeyNav()
Creates a new KeyNav without a target component.

KeyNav(Component target)
Creates a new key nav for the specified target.

Method Summary

void	addKeyNavListener(KeyNavListener listener)
void	bind(Component target) Binds the key nav to the component.
boolean	getCancelBubble() Returns the cancel bubble state.
Component	getComponent() Returns the target component.
boolean	getPreventDefault()
void	handleEvent(ComponentEvent ce) Sent when an event that the listener has registered for occurs.
void	onAlt(E ce)
void	onBackspace(E ce)
void	onControl(E ce)
void	onDelete(E ce)
void	onDown(E ce)
void	onEnd(E ce)
void	onEnter(E ce)
void	onEsc(E ce)
void	onHome(E ce)
void	onKeyPress(E ce)
void	onLeft(E ce)
void	onPageDown(E ce)
void	onPageUp(E ce)
void	onRight(E ce)
void	onShift(E ce)
void	onTab(E ce)
void	onUp(E ce)
void	removeKeyNavListener(KeyNavListener listener)
void	setCancelBubble(boolean cancelBubble) True to stop event bubbling (defaults to true).
void	setPreventDefault(boolean preventDefault)

Methods inherited from class com.extjs.gxt.ui.client.event.BaseObservable

addListener, fireEvent, fireEvent, getFiresEvents, hasListeners, hasListeners, removeAllListeners, removeListener, setFiresEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyNav

public KeyNav()

Creates a new KeyNav without a target component. Events must be passed to the Listener.handleEvent(BaseEvent) method.

KeyNav

public KeyNav(Component target)

Creates a new key nav for the specified target. The KeyNav will listen for the key events.

Parameters:

target - the target component

Method Detail

addKeyNavListener

public void addKeyNavListener(KeyNavListener listener)

bind

public void bind(Component target)

Binds the key nav to the component.

Parameters:

target - the target component

getCancelBubble

public boolean getCancelBubble()

Returns the cancel bubble state.

Returns:

true if bubbling is cancelled

getComponent

public Component getComponent()

Returns the target component.

Returns:

the target component

getPreventDefault

public boolean getPreventDefault()

handleEvent

public void handleEvent(ComponentEvent ce)

Description copied from interface: Listener

Sent when an event that the listener has registered for occurs.

Specified by:

handleEvent in interface Listener<E extends ComponentEvent>

Parameters:

ce - the event which occurred

onKeyPress

public void onKeyPress(E ce)

onAlt

public void onAlt(E ce)

onBackspace

public void onBackspace(E ce)

onControl

public void onControl(E ce)

onDelete

public void onDelete(E ce)

onDown

public void onDown(E ce)

onEnd

public void onEnd(E ce)

onEnter

public void onEnter(E ce)

onEsc

public void onEsc(E ce)

onHome

public void onHome(E ce)

onLeft

public void onLeft(E ce)

onPageDown

public void onPageDown(E ce)

onPageUp

public void onPageUp(E ce)

onRight

public void onRight(E ce)

onShift

public void onShift(E ce)

onTab

public void onTab(E ce)

onUp

public void onUp(E ce)

removeKeyNavListener

public void removeKeyNavListener(KeyNavListener listener)

setCancelBubble

public void setCancelBubble(boolean cancelBubble)

True to stop event bubbling (defaults to true).

Parameters:

cancelBubble - the cancel bubble state

setPreventDefault

public void setPreventDefault(boolean preventDefault)