Package com.google.gwt.user.client.ui
Class FocusWidget
java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.FocusWidget
- All Implemented Interfaces:
HasAllDragAndDropHandlers,HasAllFocusHandlers,HasAllGestureHandlers,HasAllKeyHandlers,HasAllMouseHandlers,HasAllTouchHandlers,HasBlurHandlers,HasClickHandlers,HasDoubleClickHandlers,HasDragEndHandlers,HasDragEnterHandlers,HasDragHandlers,HasDragLeaveHandlers,HasDragOverHandlers,HasDragStartHandlers,HasDropHandlers,HasFocusHandlers,HasGestureChangeHandlers,HasGestureEndHandlers,HasGestureStartHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasKeyUpHandlers,HasMouseDownHandlers,HasMouseMoveHandlers,HasMouseOutHandlers,HasMouseOverHandlers,HasMouseUpHandlers,HasMouseWheelHandlers,HasTouchCancelHandlers,HasTouchEndHandlers,HasTouchMoveHandlers,HasTouchStartHandlers,HasAttachHandlers,HasHandlers,EventListener,Focusable,HasEnabled,HasFocus,HasVisibility,IsWidget,SourcesClickEvents,SourcesFocusEvents,SourcesKeyboardEvents,SourcesMouseEvents
- Direct Known Subclasses:
Anchor,ButtonBase,Canvas,FileUpload,ListBox,MediaBase,RichTextArea,SimpleCheckBox,ValueBoxBase
public abstract class FocusWidget
extends Widget
implements SourcesClickEvents, HasClickHandlers, HasDoubleClickHandlers, HasFocus, HasEnabled, HasAllDragAndDropHandlers, HasAllFocusHandlers, HasAllGestureHandlers, HasAllKeyHandlers, HasAllMouseHandlers, HasAllTouchHandlers, SourcesMouseEvents
Abstract base class for most widgets that can receive keyboard focus.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled -
Field Summary
Fields inherited from class com.google.gwt.user.client.ui.Widget
eventsToSinkFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX, MISSING_ELEMENT_ERROR, SETELEMENT_TWICE_ERROR -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCreates a new focus widget with no element.protectedFocusWidget(Element elem) Creates a new focus widget that wraps the specified browser element. -
Method Summary
Modifier and TypeMethodDescriptionaddBlurHandler(BlurHandler handler) Adds aBlurEventhandler.addClickHandler(ClickHandler handler) Adds aClickEventhandler.voidaddClickListener(ClickListener listener) Deprecated.addDoubleClickHandler(DoubleClickHandler handler) Adds aDoubleClickEventhandler.addDragEndHandler(DragEndHandler handler) Adds aDragEndEventhandler.addDragEnterHandler(DragEnterHandler handler) Adds aDragEnterEventhandler.addDragHandler(DragHandler handler) Adds aDragEventhandler.addDragLeaveHandler(DragLeaveHandler handler) Adds aDragLeaveEventhandler.addDragOverHandler(DragOverHandler handler) Adds aDragOverEventhandler.addDragStartHandler(DragStartHandler handler) Adds aDragStartEventhandler.addDropHandler(DropHandler handler) Adds aDropEventhandler.addFocusHandler(FocusHandler handler) Adds aFocusEventhandler.voidaddFocusListener(FocusListener listener) Deprecated.Adds aGestureChangeEventhandler.addGestureEndHandler(GestureEndHandler handler) Adds aGestureEndEventhandler.Adds aGestureStartEventhandler.voidaddKeyboardListener(KeyboardListener listener) addKeyDownHandler(KeyDownHandler handler) Adds aKeyDownEventhandler.addKeyPressHandler(KeyPressHandler handler) Adds aKeyPressEventhandler.addKeyUpHandler(KeyUpHandler handler) Adds aKeyUpEventhandler.addMouseDownHandler(MouseDownHandler handler) Adds aMouseDownEventhandler.voidaddMouseListener(MouseListener listener) Deprecated.UseaddMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler)addMouseMoveHandler(com.google.gwt.event.dom.client.MouseMoveHandler),addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler),addMouseUpHandler(com.google.gwt.event.dom.client.MouseUpHandler)andaddMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler)insteadaddMouseMoveHandler(MouseMoveHandler handler) Adds aMouseMoveEventhandler.addMouseOutHandler(MouseOutHandler handler) Adds aMouseOutEventhandler.addMouseOverHandler(MouseOverHandler handler) Adds aMouseOverEventhandler.addMouseUpHandler(MouseUpHandler handler) Adds aMouseUpEventhandler.addMouseWheelHandler(MouseWheelHandler handler) Adds aMouseWheelEventhandler.voidaddMouseWheelListener(MouseWheelListener listener) Deprecated.addTouchCancelHandler(TouchCancelHandler handler) Adds aTouchCancelEventhandler.addTouchEndHandler(TouchEndHandler handler) Adds aTouchEndEventhandler.addTouchMoveHandler(TouchMoveHandler handler) Adds aTouchMoveEventhandler.addTouchStartHandler(TouchStartHandler handler) Adds aTouchStartEventhandler.protected static com.google.gwt.user.client.ui.impl.FocusImplGets the FocusImpl instance.intGets the tab index.booleanGets whether this widget is enabled.protected voidonAttach()This method is called when a widget is attached to the browser's document.voidremoveClickListener(ClickListener listener) Deprecated.Use theHandlerRegistration.removeHandler()method on the object returned byaddClickHandler(com.google.gwt.event.dom.client.ClickHandler)insteadvoidremoveFocusListener(FocusListener listener) Deprecated.Use theHandlerRegistration.removeHandler()method on the object returned byaddFocusHandler(com.google.gwt.event.dom.client.FocusHandler)insteadvoidremoveKeyboardListener(KeyboardListener listener) Deprecated.Use theHandlerRegistration.removeHandler()method on the object returned by an add*Handler method insteadvoidremoveMouseListener(MouseListener listener) Deprecated.Use theHandlerRegistration.removeHandler()method on the object returned by an add*Handler method insteadvoidremoveMouseWheelListener(MouseWheelListener listener) Deprecated.Use theHandlerRegistration.removeHandler()method on the object returned byaddMouseWheelHandler(com.google.gwt.event.dom.client.MouseWheelHandler)insteadvoidsetAccessKey(char key) Sets the widget's 'access key'.voidsetEnabled(boolean enabled) Sets whether this widget is enabled.voidsetFocus(boolean focused) Explicitly focus/unfocus this widget.voidsetTabIndex(int index) Sets the widget's position in the tab index.Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, ensureHandlers, fireEvent, getHandlerCount, getHandlerManager, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, replaceElement, setLayoutData, setParent, sinkEvents, unsinkEventsMethods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
FocusWidget
protected FocusWidget()Creates a new focus widget with no element.UIObject.setElement(Element)must be called before any other methods. -
FocusWidget
Creates a new focus widget that wraps the specified browser element.- Parameters:
elem- the element to be wrapped
-
-
Method Details
-
getFocusImpl
protected static com.google.gwt.user.client.ui.impl.FocusImpl getFocusImpl()Gets the FocusImpl instance.- Returns:
- impl
-
addBlurHandler
Description copied from interface:HasBlurHandlersAdds aBlurEventhandler.- Specified by:
addBlurHandlerin interfaceHasBlurHandlers- Parameters:
handler- the blur handler- Returns:
HandlerRegistrationused to remove this handler
-
addClickHandler
Description copied from interface:HasClickHandlersAdds aClickEventhandler.- Specified by:
addClickHandlerin interfaceHasClickHandlers- Parameters:
handler- the click handler- Returns:
HandlerRegistrationused to remove this handler
-
addClickListener
Deprecated.Description copied from interface:SourcesClickEventsAdds a listener interface to receive click events.- Specified by:
addClickListenerin interfaceSourcesClickEvents- Parameters:
listener- the listener interface to add
-
addDoubleClickHandler
Description copied from interface:HasDoubleClickHandlersAdds aDoubleClickEventhandler.- Specified by:
addDoubleClickHandlerin interfaceHasDoubleClickHandlers- Parameters:
handler- the double click handler- Returns:
HandlerRegistrationused to remove this handler
-
addDragEndHandler
Description copied from interface:HasDragEndHandlersAdds aDragEndEventhandler.- Specified by:
addDragEndHandlerin interfaceHasDragEndHandlers- Parameters:
handler- the drag end handler- Returns:
HandlerRegistrationused to remove this handler
-
addDragEnterHandler
Description copied from interface:HasDragEnterHandlersAdds aDragEnterEventhandler.- Specified by:
addDragEnterHandlerin interfaceHasDragEnterHandlers- Parameters:
handler- the drag end handler- Returns:
HandlerRegistrationused to remove this handler
-
addDragHandler
Description copied from interface:HasDragHandlersAdds aDragEventhandler.- Specified by:
addDragHandlerin interfaceHasDragHandlers- Parameters:
handler- the drag handler- Returns:
HandlerRegistrationused to remove this handler
-
addDragLeaveHandler
Description copied from interface:HasDragLeaveHandlersAdds aDragLeaveEventhandler.- Specified by:
addDragLeaveHandlerin interfaceHasDragLeaveHandlers- Parameters:
handler- the drag leave handler- Returns:
HandlerRegistrationused to remove this handler
-
addDragOverHandler
Description copied from interface:HasDragOverHandlersAdds aDragOverEventhandler.- Specified by:
addDragOverHandlerin interfaceHasDragOverHandlers- Parameters:
handler- the drag over handler- Returns:
HandlerRegistrationused to remove this handler
-
addDragStartHandler
Description copied from interface:HasDragStartHandlersAdds aDragStartEventhandler.- Specified by:
addDragStartHandlerin interfaceHasDragStartHandlers- Parameters:
handler- the drag start handler- Returns:
HandlerRegistrationused to remove this handler
-
addDropHandler
Description copied from interface:HasDropHandlersAdds aDropEventhandler.- Specified by:
addDropHandlerin interfaceHasDropHandlers- Parameters:
handler- the drop handler- Returns:
HandlerRegistrationused to remove this handler
-
addFocusHandler
Description copied from interface:HasFocusHandlersAdds aFocusEventhandler.- Specified by:
addFocusHandlerin interfaceHasFocusHandlers- Parameters:
handler- the focus handler- Returns:
HandlerRegistrationused to remove this handler
-
addFocusListener
Deprecated.Description copied from interface:SourcesFocusEventsAdds a listener interface to receive focus events.- Specified by:
addFocusListenerin interfaceSourcesFocusEvents- Parameters:
listener- the listener interface to add
-
addGestureChangeHandler
Description copied from interface:HasGestureChangeHandlersAdds aGestureChangeEventhandler.- Specified by:
addGestureChangeHandlerin interfaceHasGestureChangeHandlers- Parameters:
handler- the gesture change handler- Returns:
HandlerRegistrationused to remove this handler
-
addGestureEndHandler
Description copied from interface:HasGestureEndHandlersAdds aGestureEndEventhandler.- Specified by:
addGestureEndHandlerin interfaceHasGestureEndHandlers- Parameters:
handler- the gesture end handler- Returns:
HandlerRegistrationused to remove this handler
-
addGestureStartHandler
Description copied from interface:HasGestureStartHandlersAdds aGestureStartEventhandler.- Specified by:
addGestureStartHandlerin interfaceHasGestureStartHandlers- Parameters:
handler- the gesture start handler- Returns:
HandlerRegistrationused to remove this handler
-
addKeyboardListener
Deprecated.Description copied from interface:SourcesKeyboardEventsAdds a listener interface to receive keyboard events.- Specified by:
addKeyboardListenerin interfaceSourcesKeyboardEvents- Parameters:
listener- the listener interface to add
-
addKeyDownHandler
Description copied from interface:HasKeyDownHandlersAdds aKeyDownEventhandler.- Specified by:
addKeyDownHandlerin interfaceHasKeyDownHandlers- Parameters:
handler- the key down handler- Returns:
HandlerRegistrationused to remove this handler
-
addKeyPressHandler
Description copied from interface:HasKeyPressHandlersAdds aKeyPressEventhandler.- Specified by:
addKeyPressHandlerin interfaceHasKeyPressHandlers- Parameters:
handler- the key press handler- Returns:
HandlerRegistrationused to remove this handler
-
addKeyUpHandler
Description copied from interface:HasKeyUpHandlersAdds aKeyUpEventhandler.- Specified by:
addKeyUpHandlerin interfaceHasKeyUpHandlers- Parameters:
handler- the key up handler- Returns:
HandlerRegistrationused to remove this handler
-
addMouseDownHandler
Description copied from interface:HasMouseDownHandlersAdds aMouseDownEventhandler.- Specified by:
addMouseDownHandlerin interfaceHasMouseDownHandlers- Parameters:
handler- the mouse down handler- Returns:
HandlerRegistrationused to remove this handler
-
addMouseListener
Deprecated.UseaddMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler)addMouseMoveHandler(com.google.gwt.event.dom.client.MouseMoveHandler),addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler),addMouseUpHandler(com.google.gwt.event.dom.client.MouseUpHandler)andaddMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler)insteadDescription copied from interface:SourcesMouseEventsAdds a listener interface to receive mouse events.- Specified by:
addMouseListenerin interfaceSourcesMouseEvents- Parameters:
listener- the listener interface to add
-
addMouseMoveHandler
Description copied from interface:HasMouseMoveHandlersAdds aMouseMoveEventhandler.- Specified by:
addMouseMoveHandlerin interfaceHasMouseMoveHandlers- Parameters:
handler- the mouse move handler- Returns:
HandlerRegistrationused to remove this handler
-
addMouseOutHandler
Description copied from interface:HasMouseOutHandlersAdds aMouseOutEventhandler.- Specified by:
addMouseOutHandlerin interfaceHasMouseOutHandlers- Parameters:
handler- the mouse out handler- Returns:
HandlerRegistrationused to remove this handler
-
addMouseOverHandler
Description copied from interface:HasMouseOverHandlersAdds aMouseOverEventhandler.- Specified by:
addMouseOverHandlerin interfaceHasMouseOverHandlers- Parameters:
handler- the mouse over handler- Returns:
HandlerRegistrationused to remove this handler
-
addMouseUpHandler
Description copied from interface:HasMouseUpHandlersAdds aMouseUpEventhandler.- Specified by:
addMouseUpHandlerin interfaceHasMouseUpHandlers- Parameters:
handler- the mouse up handler- Returns:
HandlerRegistrationused to remove this handler
-
addMouseWheelHandler
Description copied from interface:HasMouseWheelHandlersAdds aMouseWheelEventhandler.- Specified by:
addMouseWheelHandlerin interfaceHasMouseWheelHandlers- Parameters:
handler- the mouse wheel handler- Returns:
HandlerRegistrationused to remove this handler
-
addMouseWheelListener
Deprecated. -
addTouchCancelHandler
Description copied from interface:HasTouchCancelHandlersAdds aTouchCancelEventhandler.- Specified by:
addTouchCancelHandlerin interfaceHasTouchCancelHandlers- Parameters:
handler- the touch cancel handler- Returns:
HandlerRegistrationused to remove this handler
-
addTouchEndHandler
Description copied from interface:HasTouchEndHandlersAdds aTouchEndEventhandler.- Specified by:
addTouchEndHandlerin interfaceHasTouchEndHandlers- Parameters:
handler- the touch end handler- Returns:
HandlerRegistrationused to remove this handler
-
addTouchMoveHandler
Description copied from interface:HasTouchMoveHandlersAdds aTouchMoveEventhandler.- Specified by:
addTouchMoveHandlerin interfaceHasTouchMoveHandlers- Parameters:
handler- the touch move handler- Returns:
HandlerRegistrationused to remove this handler
-
addTouchStartHandler
Description copied from interface:HasTouchStartHandlersAdds aTouchStartEventhandler.- Specified by:
addTouchStartHandlerin interfaceHasTouchStartHandlers- Parameters:
handler- the touch start handler- Returns:
HandlerRegistrationused to remove this handler
-
getTabIndex
public int getTabIndex()Gets the tab index.- Specified by:
getTabIndexin interfaceFocusable- Returns:
- the tab index
-
isEnabled
public boolean isEnabled()Gets whether this widget is enabled.- Specified by:
isEnabledin interfaceHasEnabled- Returns:
trueif the widget is enabled
-
removeClickListener
Deprecated.Use theHandlerRegistration.removeHandler()method on the object returned byaddClickHandler(com.google.gwt.event.dom.client.ClickHandler)insteadDescription copied from interface:SourcesClickEventsRemoves a previously added listener interface.- Specified by:
removeClickListenerin interfaceSourcesClickEvents- Parameters:
listener- the listener interface to remove
-
removeFocusListener
Deprecated.Use theHandlerRegistration.removeHandler()method on the object returned byaddFocusHandler(com.google.gwt.event.dom.client.FocusHandler)insteadDescription copied from interface:SourcesFocusEventsRemoves a previously added listener interface.- Specified by:
removeFocusListenerin interfaceSourcesFocusEvents- Parameters:
listener- the listener interface to remove
-
removeKeyboardListener
Deprecated.Use theHandlerRegistration.removeHandler()method on the object returned by an add*Handler method insteadDescription copied from interface:SourcesKeyboardEventsRemoves a previously added listener interface.- Specified by:
removeKeyboardListenerin interfaceSourcesKeyboardEvents- Parameters:
listener- the listener interface to remove
-
removeMouseListener
Deprecated.Use theHandlerRegistration.removeHandler()method on the object returned by an add*Handler method insteadDescription copied from interface:SourcesMouseEventsRemoves a previously added listener interface.- Specified by:
removeMouseListenerin interfaceSourcesMouseEvents- Parameters:
listener- the listener interface to remove
-
removeMouseWheelListener
Deprecated.Use theHandlerRegistration.removeHandler()method on the object returned byaddMouseWheelHandler(com.google.gwt.event.dom.client.MouseWheelHandler)instead -
setAccessKey
public void setAccessKey(char key) Description copied from interface:FocusableSets the widget's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.- Specified by:
setAccessKeyin interfaceFocusable- Parameters:
key- the widget's access key
-
setEnabled
public void setEnabled(boolean enabled) Sets whether this widget is enabled.- Specified by:
setEnabledin interfaceHasEnabled- Parameters:
enabled-trueto enable the widget,falseto disable it
-
setFocus
public void setFocus(boolean focused) Description copied from interface:FocusableExplicitly focus/unfocus this widget. Only one widget can have focus at a time, and the widget that does will receive all keyboard events. NOTE: Most browsers fire FocusEvents asynchronously. Especially within GWT tests, you'll need to make your test asynchronous to properly do verifications. SeeGWTTestCase#delayTestFinishfor more information on how to do this. -
setTabIndex
public void setTabIndex(int index) Description copied from interface:FocusableSets the widget's position in the tab index. If more than one widget has the same tab index, each such widget will receive focus in an arbitrary order. Setting the tab index to-1will cause this widget to be removed from the tab order.- Specified by:
setTabIndexin interfaceFocusable- Parameters:
index- the widget's tab index
-
onAttach
protected void onAttach()Description copied from class:WidgetThis method is called when a widget is attached to the browser's document. To receive notification after a Widget has been added to the document, override the
Widget.onLoad()method or useWidget.addAttachHandler(com.google.gwt.event.logical.shared.AttachEvent.Handler).It is strongly recommended that you override
Widget.onLoad()orWidget.doAttachChildren()instead of this method to avoid inconsistencies between logical and physical attachment states.Subclasses that override this method must call
super.onAttach()to ensure that the Widget has been attached to its underlying Element.
-
addClickHandler(com.google.gwt.event.dom.client.ClickHandler)instead