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
eventsToSink
-
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX, MISSING_ELEMENT_ERROR, SETELEMENT_TWICE_ERROR
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
FocusWidget()
Creates a new focus widget with no element.protected
FocusWidget(Element elem)
Creates a new focus widget that wraps the specified browser element.
-
Method Summary
-
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, unsinkEvents
-
Methods 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, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
-
-
-
Constructor Detail
-
FocusWidget
protected FocusWidget()
Creates a new focus widget with no element.UIObject.setElement(Element)
must be called before any other methods.
-
FocusWidget
protected FocusWidget(Element elem)
Creates a new focus widget that wraps the specified browser element.- Parameters:
elem
- the element to be wrapped
-
-
Method Detail
-
getFocusImpl
protected static com.google.gwt.user.client.ui.impl.FocusImpl getFocusImpl()
Gets the FocusImpl instance.- Returns:
- impl
-
addBlurHandler
public HandlerRegistration addBlurHandler(BlurHandler handler)
Description copied from interface:HasBlurHandlers
Adds aBlurEvent
handler.- Specified by:
addBlurHandler
in interfaceHasBlurHandlers
- Parameters:
handler
- the blur handler- Returns:
HandlerRegistration
used to remove this handler
-
addClickHandler
public HandlerRegistration addClickHandler(ClickHandler handler)
Description copied from interface:HasClickHandlers
Adds aClickEvent
handler.- Specified by:
addClickHandler
in interfaceHasClickHandlers
- Parameters:
handler
- the click handler- Returns:
HandlerRegistration
used to remove this handler
-
addClickListener
@Deprecated public void addClickListener(ClickListener listener)
Deprecated.Description copied from interface:SourcesClickEvents
Adds a listener interface to receive click events.- Specified by:
addClickListener
in interfaceSourcesClickEvents
- Parameters:
listener
- the listener interface to add
-
addDoubleClickHandler
public HandlerRegistration addDoubleClickHandler(DoubleClickHandler handler)
Description copied from interface:HasDoubleClickHandlers
Adds aDoubleClickEvent
handler.- Specified by:
addDoubleClickHandler
in interfaceHasDoubleClickHandlers
- Parameters:
handler
- the double click handler- Returns:
HandlerRegistration
used to remove this handler
-
addDragEndHandler
public HandlerRegistration addDragEndHandler(DragEndHandler handler)
Description copied from interface:HasDragEndHandlers
Adds aDragEndEvent
handler.- Specified by:
addDragEndHandler
in interfaceHasDragEndHandlers
- Parameters:
handler
- the drag end handler- Returns:
HandlerRegistration
used to remove this handler
-
addDragEnterHandler
public HandlerRegistration addDragEnterHandler(DragEnterHandler handler)
Description copied from interface:HasDragEnterHandlers
Adds aDragEnterEvent
handler.- Specified by:
addDragEnterHandler
in interfaceHasDragEnterHandlers
- Parameters:
handler
- the drag end handler- Returns:
HandlerRegistration
used to remove this handler
-
addDragHandler
public HandlerRegistration addDragHandler(DragHandler handler)
Description copied from interface:HasDragHandlers
Adds aDragEvent
handler.- Specified by:
addDragHandler
in interfaceHasDragHandlers
- Parameters:
handler
- the drag handler- Returns:
HandlerRegistration
used to remove this handler
-
addDragLeaveHandler
public HandlerRegistration addDragLeaveHandler(DragLeaveHandler handler)
Description copied from interface:HasDragLeaveHandlers
Adds aDragLeaveEvent
handler.- Specified by:
addDragLeaveHandler
in interfaceHasDragLeaveHandlers
- Parameters:
handler
- the drag leave handler- Returns:
HandlerRegistration
used to remove this handler
-
addDragOverHandler
public HandlerRegistration addDragOverHandler(DragOverHandler handler)
Description copied from interface:HasDragOverHandlers
Adds aDragOverEvent
handler.- Specified by:
addDragOverHandler
in interfaceHasDragOverHandlers
- Parameters:
handler
- the drag over handler- Returns:
HandlerRegistration
used to remove this handler
-
addDragStartHandler
public HandlerRegistration addDragStartHandler(DragStartHandler handler)
Description copied from interface:HasDragStartHandlers
Adds aDragStartEvent
handler.- Specified by:
addDragStartHandler
in interfaceHasDragStartHandlers
- Parameters:
handler
- the drag start handler- Returns:
HandlerRegistration
used to remove this handler
-
addDropHandler
public HandlerRegistration addDropHandler(DropHandler handler)
Description copied from interface:HasDropHandlers
Adds aDropEvent
handler.- Specified by:
addDropHandler
in interfaceHasDropHandlers
- Parameters:
handler
- the drop handler- Returns:
HandlerRegistration
used to remove this handler
-
addFocusHandler
public HandlerRegistration addFocusHandler(FocusHandler handler)
Description copied from interface:HasFocusHandlers
Adds aFocusEvent
handler.- Specified by:
addFocusHandler
in interfaceHasFocusHandlers
- Parameters:
handler
- the focus handler- Returns:
HandlerRegistration
used to remove this handler
-
addFocusListener
@Deprecated public void addFocusListener(FocusListener listener)
Deprecated.Description copied from interface:SourcesFocusEvents
Adds a listener interface to receive focus events.- Specified by:
addFocusListener
in interfaceSourcesFocusEvents
- Parameters:
listener
- the listener interface to add
-
addGestureChangeHandler
public HandlerRegistration addGestureChangeHandler(GestureChangeHandler handler)
Description copied from interface:HasGestureChangeHandlers
Adds aGestureChangeEvent
handler.- Specified by:
addGestureChangeHandler
in interfaceHasGestureChangeHandlers
- Parameters:
handler
- the gesture change handler- Returns:
HandlerRegistration
used to remove this handler
-
addGestureEndHandler
public HandlerRegistration addGestureEndHandler(GestureEndHandler handler)
Description copied from interface:HasGestureEndHandlers
Adds aGestureEndEvent
handler.- Specified by:
addGestureEndHandler
in interfaceHasGestureEndHandlers
- Parameters:
handler
- the gesture end handler- Returns:
HandlerRegistration
used to remove this handler
-
addGestureStartHandler
public HandlerRegistration addGestureStartHandler(GestureStartHandler handler)
Description copied from interface:HasGestureStartHandlers
Adds aGestureStartEvent
handler.- Specified by:
addGestureStartHandler
in interfaceHasGestureStartHandlers
- Parameters:
handler
- the gesture start handler- Returns:
HandlerRegistration
used to remove this handler
-
addKeyboardListener
@Deprecated public void addKeyboardListener(KeyboardListener listener)
Deprecated.Description copied from interface:SourcesKeyboardEvents
Adds a listener interface to receive keyboard events.- Specified by:
addKeyboardListener
in interfaceSourcesKeyboardEvents
- Parameters:
listener
- the listener interface to add
-
addKeyDownHandler
public HandlerRegistration addKeyDownHandler(KeyDownHandler handler)
Description copied from interface:HasKeyDownHandlers
Adds aKeyDownEvent
handler.- Specified by:
addKeyDownHandler
in interfaceHasKeyDownHandlers
- Parameters:
handler
- the key down handler- Returns:
HandlerRegistration
used to remove this handler
-
addKeyPressHandler
public HandlerRegistration addKeyPressHandler(KeyPressHandler handler)
Description copied from interface:HasKeyPressHandlers
Adds aKeyPressEvent
handler.- Specified by:
addKeyPressHandler
in interfaceHasKeyPressHandlers
- Parameters:
handler
- the key press handler- Returns:
HandlerRegistration
used to remove this handler
-
addKeyUpHandler
public HandlerRegistration addKeyUpHandler(KeyUpHandler handler)
Description copied from interface:HasKeyUpHandlers
Adds aKeyUpEvent
handler.- Specified by:
addKeyUpHandler
in interfaceHasKeyUpHandlers
- Parameters:
handler
- the key up handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseDownHandler
public HandlerRegistration addMouseDownHandler(MouseDownHandler handler)
Description copied from interface:HasMouseDownHandlers
Adds aMouseDownEvent
handler.- Specified by:
addMouseDownHandler
in interfaceHasMouseDownHandlers
- Parameters:
handler
- the mouse down handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseListener
@Deprecated public void addMouseListener(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)
insteadDescription copied from interface:SourcesMouseEvents
Adds a listener interface to receive mouse events.- Specified by:
addMouseListener
in interfaceSourcesMouseEvents
- Parameters:
listener
- the listener interface to add
-
addMouseMoveHandler
public HandlerRegistration addMouseMoveHandler(MouseMoveHandler handler)
Description copied from interface:HasMouseMoveHandlers
Adds aMouseMoveEvent
handler.- Specified by:
addMouseMoveHandler
in interfaceHasMouseMoveHandlers
- Parameters:
handler
- the mouse move handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseOutHandler
public HandlerRegistration addMouseOutHandler(MouseOutHandler handler)
Description copied from interface:HasMouseOutHandlers
Adds aMouseOutEvent
handler.- Specified by:
addMouseOutHandler
in interfaceHasMouseOutHandlers
- Parameters:
handler
- the mouse out handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseOverHandler
public HandlerRegistration addMouseOverHandler(MouseOverHandler handler)
Description copied from interface:HasMouseOverHandlers
Adds aMouseOverEvent
handler.- Specified by:
addMouseOverHandler
in interfaceHasMouseOverHandlers
- Parameters:
handler
- the mouse over handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseUpHandler
public HandlerRegistration addMouseUpHandler(MouseUpHandler handler)
Description copied from interface:HasMouseUpHandlers
Adds aMouseUpEvent
handler.- Specified by:
addMouseUpHandler
in interfaceHasMouseUpHandlers
- Parameters:
handler
- the mouse up handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseWheelHandler
public HandlerRegistration addMouseWheelHandler(MouseWheelHandler handler)
Description copied from interface:HasMouseWheelHandlers
Adds aMouseWheelEvent
handler.- Specified by:
addMouseWheelHandler
in interfaceHasMouseWheelHandlers
- Parameters:
handler
- the mouse wheel handler- Returns:
HandlerRegistration
used to remove this handler
-
addMouseWheelListener
@Deprecated public void addMouseWheelListener(MouseWheelListener listener)
Deprecated.
-
addTouchCancelHandler
public HandlerRegistration addTouchCancelHandler(TouchCancelHandler handler)
Description copied from interface:HasTouchCancelHandlers
Adds aTouchCancelEvent
handler.- Specified by:
addTouchCancelHandler
in interfaceHasTouchCancelHandlers
- Parameters:
handler
- the touch cancel handler- Returns:
HandlerRegistration
used to remove this handler
-
addTouchEndHandler
public HandlerRegistration addTouchEndHandler(TouchEndHandler handler)
Description copied from interface:HasTouchEndHandlers
Adds aTouchEndEvent
handler.- Specified by:
addTouchEndHandler
in interfaceHasTouchEndHandlers
- Parameters:
handler
- the touch end handler- Returns:
HandlerRegistration
used to remove this handler
-
addTouchMoveHandler
public HandlerRegistration addTouchMoveHandler(TouchMoveHandler handler)
Description copied from interface:HasTouchMoveHandlers
Adds aTouchMoveEvent
handler.- Specified by:
addTouchMoveHandler
in interfaceHasTouchMoveHandlers
- Parameters:
handler
- the touch move handler- Returns:
HandlerRegistration
used to remove this handler
-
addTouchStartHandler
public HandlerRegistration addTouchStartHandler(TouchStartHandler handler)
Description copied from interface:HasTouchStartHandlers
Adds aTouchStartEvent
handler.- Specified by:
addTouchStartHandler
in interfaceHasTouchStartHandlers
- Parameters:
handler
- the touch start handler- Returns:
HandlerRegistration
used to remove this handler
-
getTabIndex
public int getTabIndex()
Gets the tab index.- Specified by:
getTabIndex
in interfaceFocusable
- Returns:
- the tab index
-
isEnabled
public boolean isEnabled()
Gets whether this widget is enabled.- Specified by:
isEnabled
in interfaceHasEnabled
- Returns:
true
if the widget is enabled
-
removeClickListener
@Deprecated public void removeClickListener(ClickListener listener)
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned byaddClickHandler(com.google.gwt.event.dom.client.ClickHandler)
insteadDescription copied from interface:SourcesClickEvents
Removes a previously added listener interface.- Specified by:
removeClickListener
in interfaceSourcesClickEvents
- Parameters:
listener
- the listener interface to remove
-
removeFocusListener
@Deprecated public void removeFocusListener(FocusListener listener)
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned byaddFocusHandler(com.google.gwt.event.dom.client.FocusHandler)
insteadDescription copied from interface:SourcesFocusEvents
Removes a previously added listener interface.- Specified by:
removeFocusListener
in interfaceSourcesFocusEvents
- Parameters:
listener
- the listener interface to remove
-
removeKeyboardListener
@Deprecated public void removeKeyboardListener(KeyboardListener listener)
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned by an add*Handler method insteadDescription copied from interface:SourcesKeyboardEvents
Removes a previously added listener interface.- Specified by:
removeKeyboardListener
in interfaceSourcesKeyboardEvents
- Parameters:
listener
- the listener interface to remove
-
removeMouseListener
@Deprecated public void removeMouseListener(MouseListener listener)
Deprecated.Use theHandlerRegistration.removeHandler()
method on the object returned by an add*Handler method insteadDescription copied from interface:SourcesMouseEvents
Removes a previously added listener interface.- Specified by:
removeMouseListener
in interfaceSourcesMouseEvents
- Parameters:
listener
- the listener interface to remove
-
removeMouseWheelListener
@Deprecated public void removeMouseWheelListener(MouseWheelListener listener)
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:Focusable
Sets the widget's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.- Specified by:
setAccessKey
in interfaceFocusable
- Parameters:
key
- the widget's access key
-
setEnabled
public void setEnabled(boolean enabled)
Sets whether this widget is enabled.- Specified by:
setEnabled
in interfaceHasEnabled
- Parameters:
enabled
-true
to enable the widget,false
to disable it
-
setFocus
public void setFocus(boolean focused)
Description copied from interface:Focusable
Explicitly 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#delayTestFinish
for more information on how to do this.
-
setTabIndex
public void setTabIndex(int index)
Description copied from interface:Focusable
Sets 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-1
will cause this widget to be removed from the tab order.- Specified by:
setTabIndex
in interfaceFocusable
- Parameters:
index
- the widget's tab index
-
onAttach
protected void onAttach()
Description copied from class:Widget
This 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.- Overrides:
onAttach
in classWidget
- See Also:
Widget.onLoad()
,Widget.doAttachChildren()
-
-