|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.extjs.gxt.ui.client.event.BaseObservable
com.extjs.gxt.ui.client.util.KeyNav<E>
public class KeyNav<E extends ComponentEvent>
Provides a convenient wrapper for normalized keyboard navigation. Provides an easy way to implement custom navigation schemes for any UI component.
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)
Adds a key nav 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. |
static EventType |
getKeyEvent()
Returns the key event type. |
boolean |
getPreventDefault()
Returns true if the default event action is being cancelled. |
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)
Removes a key nav listener. |
void |
setCancelBubble(boolean cancelBubble)
True to stop event bubbling when the key nav intercepts a key (defaults to false). |
void |
setPreventDefault(boolean preventDefault)
True to prevent the default action of the key event when the key nav intercepts a key (defaults to false). |
Methods inherited from class com.extjs.gxt.ui.client.event.BaseObservable |
---|
addListener, callListener, fireEvent, fireEvent, getFiresEvents, getListeners, hasActiveEvent, hasListeners, hasListeners, removeAllListeners, removeListener, setFiresEvents |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public KeyNav()
Listener.handleEvent(BaseEvent)
method.
public KeyNav(Component target)
target
- the target componentMethod Detail |
---|
public static EventType getKeyEvent()
public void addKeyNavListener(KeyNavListener listener)
listener
- the key nav listener to addpublic void bind(Component target)
target
- the target componentpublic boolean getCancelBubble()
public Component getComponent()
public boolean getPreventDefault()
public void handleEvent(ComponentEvent ce)
Listener
handleEvent
in interface Listener<E extends ComponentEvent>
ce
- the event which occurredpublic void onKeyPress(E ce)
public void onAlt(E ce)
public void onBackspace(E ce)
public void onControl(E ce)
public void onDelete(E ce)
public void onDown(E ce)
public void onEnd(E ce)
public void onEnter(E ce)
public void onEsc(E ce)
public void onHome(E ce)
public void onLeft(E ce)
public void onPageDown(E ce)
public void onPageUp(E ce)
public void onRight(E ce)
public void onShift(E ce)
public void onTab(E ce)
public void onUp(E ce)
public void removeKeyNavListener(KeyNavListener listener)
listener
- the key nav listener to removepublic void setCancelBubble(boolean cancelBubble)
cancelBubble
- the cancel bubble statepublic void setPreventDefault(boolean preventDefault)
preventDefault
- true to prevent the default
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |