package

com.google.gwt.user.client.ui

Widgets, Panels, and other user-interface classes. This package contains all of the high-level user-interface Widgets, along with panels and event interfaces. These classes form the bulk of the client-side libraries used by GWT applications.

Interfaces

AcceptsOneWidget Implemented by displays that can be given accept an IsWidget to show. 
AnimatedLayout Specifies that a panel can animate between layouts. 
AttachDetachException.Command The command to execute when iterating through child widgets. 
ChangeListener This interface is deprecated. As of GWT 1.6, DOM and logical change events are separate. Use ChangeHandler for changes triggered by a DOM-based change event and ValueChangeHandler for changes resulting from a logical event such as a method call that changes state  
ClickListener This interface is deprecated. Use ClickHandler instead  
DialogBox.Caption Set of characteristic interfaces supported by the DialogBox caption Note that this set might expand over time, so implement this interface at your own risk. 
DisclosureHandler This interface is deprecated. Use CloseHandler and/or OpenHandler instead 
DisclosurePanelImages An ImageBundle that provides images for DisclosurePanel
DisclosurePanelImagesRTL A bundle containing the RTL versions of the images for DisclosurePanel. 
FiresDisclosureEvents This interface is deprecated. Use HasOpenHandlers and HasCloseHandlers instead  
FiresFormEvents This interface is deprecated. This interface was specific to FormPanel; it is not generally useful and will be removed in a future version. Use addSubmitHandler(FormPanel.SubmitHandler) and addSubmitCompleteHandler(FormPanel.SubmitCompleteHandler) instead  
FiresSuggestionEvents This interface is deprecated. Use HasSelectionHandlers instead.  
Focusable A widget that implements this interface can receive keyboard focus. 
FocusListener This interface is deprecated. Use FocusHandler and/or BlurHandler instead  
FormHandler This interface is deprecated. Use FormPanel.SubmitCompleteHandler and/or FormPanel.SubmitHandler instead  
FormPanel.SubmitCompleteHandler Handler for FormPanel.SubmitCompleteEvent events. 
FormPanel.SubmitHandler Handler for FormPanel.SubmitEvent events. 
HasAlignment A widget that implements this interface has an intrinsic alignment which can be manipulated using these methods and constants. 
HasAnimation A Widget that uses an animation should implement this class so users can enable or disable animations. 
HasAutoHorizontalAlignment A widget that implements this interface can be configured to be aligned according to its contents' direction, in addition to the static alignment options offered by HasHorizontalAlignment
HasCaption A widget that implements this interface has a caption which can be set and retrieved using these methods. 
HasConstrainedValue<T> Implemented by widgets that pick from a set of values. 
HasDirectionalHtml An object that implements this interface contains html that has a direction. 
HasDirectionalSafeHtml An object that implements this interface contains html that has a direction. 
HasDirectionalText An object that implements this interface contains text that has a direction. 
HasEnabled A widget that implements this interface can be put in an "enabled" or "disabled" state. 
HasFocus This interface is deprecated. Use Focusable instead  
HasHorizontalAlignment Characteristic interface which indicates that a widget can be aligned horizontally. 
HasHTML An object that implements this interface contains text, which can be set and retrieved using these methods. 
HasKeyPreview This interface is deprecated. This interface is no longer implemented by any GWT library. Use addNativePreviewHandler(Event.NativePreviewHandler) instead.  
HasName A widget that implements this interface has a 'name' associated with it, allowing it to be used with FormPanel
HasOneWidget Implemented by panels that have only one widget. 
HasText An object that implements this interface contains text, which can be set and retrieved using these methods. 
HasTreeItems A widget that implements this interface contains items and can operate them. 
HasValue<T> Extends TakesValue to allow the value to be pulled back out, and to throw ValueChangeEvent events. 
HasVerticalAlignment Characteristic interface which indicates that a widget has an associated vertical alignment. 
HasWidgets A widget that implements this interface contains widgets and can enumerate them. 
HasWidgets.ForIsWidget Extends this interface with convenience methods to handle IsWidget
HasWordWrap A widget that implements this interface has a 'word-wrap' property that can be manipulated using these methods. 
HorizontalSplitPanel.Resources The default resources used by this widget. 
HorizontalSplitPanelImages This interface is deprecated. replaced by HorizontalSplitPanel.Resources.  
ImageBundle This interface is deprecated. replaced by ClientBundle and ImageResource  
IndexedPanel Implemented by panels that impose an explicit ordering on their children. 
IndexedPanel.ForIsWidget Extends this interface with convenience methods to handle IsWidget
InsertPanel Implemented by IndexedPanels that also allow insertions. 
InsertPanel.ForIsWidget Extends this interface with convenience methods to handle IsWidget
IsTreeItem Extended by objects which have underlying TreeItem
IsWidget Extended by view interfaces that are likely to be implemented by Widgets. 
KeyboardListener This interface is deprecated. use KeyDownHandler, KeyUpHandler and/or KeyPressHandler instead  
LoadListener This interface is deprecated. use LoadHandler and ErrorHandler instead  
MenuBar.MenuBarImages This interface is deprecated. replaced by MenuBar.Resources  
MenuBar.Resources A ClientBundle that contains the default resources for this widget. 
MouseListener This interface is deprecated. use MouseDownHandler, MouseUpHandler, MouseOverHandler, MouseMoveHandler, and MouseOutHandler instead  
MouseWheelListener This interface is deprecated. use MouseWheelHandler instead  
NotificationMole.Style Default CSS styles for this widget. 
PopupListener This interface is deprecated. use CloseHandler instead  
PopupPanel.PositionCallback A callback that is used to set the position of a PopupPanel right before it is shown. 
ProvidesResize This tag interface specifies that the implementing widget will call onResize() on its children whenever their size may have changed. 
RequiresResize This interface designates that its implementor needs to be informed whenever its size is modified. 
RichTextArea.BasicFormatter This interface is deprecated. use RichTextArea.Formatter instead  
RichTextArea.ExtendedFormatter This interface is deprecated. use RichTextArea.Formatter instead  
RichTextArea.Formatter

This interface is used to access full formatting options, when available. 

ScrollListener This interface is deprecated. use ScrollHandler instead  
SourcesChangeEvents This interface is deprecated. we have now separated dom and logical change events. Use HasChangeHandlers if the change listener was triggered by a dom change event or HasValueChangeHandlers if it was based on a logical event  
SourcesClickEvents This interface is deprecated. use HasClickHandlers instead  
SourcesFocusEvents This interface is deprecated. use HasAllFocusHandlers instead  
SourcesKeyboardEvents This interface is deprecated. use HasAllKeyHandlers instead  
SourcesLoadEvents This interface is deprecated. use HasErrorHandlers and HasLoadHandlers instead  
SourcesMouseEvents This interface is deprecated. use HasAllMouseHandlers instead  
SourcesMouseWheelEvents This interface is deprecated. Use HasMouseWheelHandlers instead  
SourcesPopupEvents This interface is deprecated. use HasCloseHandlers instead  
SourcesScrollEvents This interface is deprecated. use HasScrollHandlers instead  
SourcesTabEvents This interface is deprecated. use HasSelectionHandlers and HasBeforeSelectionHandlers instead  
SourcesTableEvents This interface is deprecated. use HasClickHandlers instead. Event sources should implement methods similar to getCellForEvent(com.google.gwt.event.dom.client.ClickEvent)  
SourcesTreeEvents This interface is deprecated. use HasBeforeSelectionHandlers, HasOpenHandlers and HasClickHandlers instead  
SuggestBox.SuggestionCallback The callback used when a user selects a SuggestOracle.Suggestion
SuggestionHandler This interface is deprecated. use SelectionHandler instead  
SuggestOracle.Callback Callback for SuggestOracle
SuggestOracle.Suggestion Suggestion supplied by the SuggestOracle
TabBar.Tab Set of characteristic interfaces supported by TabBar tabs. 
TableListener This interface is deprecated. use ClickHandler and getCellForEvent(com.google.gwt.event.dom.client.ClickEvent) instead  
TabListener This interface is deprecated. use addBeforeSelectionHandler(com.google.gwt.event.logical.shared.BeforeSelectionHandler) and/or addSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler) instead  
Tree.Resources A ClientBundle that provides images for this widget. 
TreeImages This interface is deprecated. replaced by Tree.Resources.  
TreeListener This interface is deprecated. Use SelectionHandler, OpenHandler, and CloseHandler instead  
VerticalSplitPanel.Resources The default resources used by this widget. 
VerticalSplitPanelImages This interface is deprecated. replaced by VerticalSplitPanel.Resources.  

Classes

AbsolutePanel An absolute panel positions all of its children absolutely, allowing them to overlap. 
AbstractImagePrototype An opaque representation of a particular image such that the image can be accessed either as an HTML fragment or as an Image object. 
AbstractImagePrototype.ImagePrototypeElement This corresponds to the top Element of the DOM structure created by createElement()
Accessibility

Allows ARIA attributes to be added to widgets so that they can be identified by assistive technologies. 

Anchor A widget that represents a simple <a> element. 
Button A standard push-button widget. 
ButtonBase Abstract base class for Button, CheckBox, RadioButton
CaptionPanel A panel that wraps its contents in a border with a caption that appears in the upper left corner of the border. 
CaptionPanel.CaptionPanelImpl Implementation class without browser-specific hacks. 
CaptionPanel.CaptionPanelImplMozilla Implementation class that handles Mozilla rendering issues. 
CaptionPanel.CaptionPanelImplSafari Implementation class that handles Safari rendering issues. 
CellPanel A panel whose child widgets are contained within the cells of a table. 
ChangeListenerCollection This class is deprecated. Widgets should now manage their own handlers via addDomHandler(H, DomEvent.Type)  
CheckBox A standard check box widget. 
ClickListenerCollection This class is deprecated. As of GWT 1.6, call addDomHandler(myHandler, ClickEvent.getType()) to manage handlers for your widget instead  
ComplexPanel Abstract base class for panels that can contain multiple child widgets. 
Composite A type of widget that can wrap another widget, hiding the wrapped widget's methods. 
CustomButton CustomButton is a base button class with built in support for a set number of button faces. 
CustomButton.Face Represents a button's face. 
DateLabel Extends ValueLabel for convenience when dealing with dates and DateTimeFormat, especially in UiBinder templates. 
DeckPanel A panel that displays all of its child widgets in a 'deck', where only one can be visible at a time. 
DecoratedPopupPanel

A PopupPanel that wraps its content in a 3x3 grid, which allows users to add rounded corners. 

DecoratedStackPanel

A StackPanel that wraps each item in a 2x3 grid (six box), which allows users to add rounded corners. 

DecoratedTabBar

A TabBar that wraps each tab in a 2x3 grid (six box), which allows users to add rounded corners. 

DecoratedTabPanel A TabPanel that uses a DecoratedTabBar with rounded corners. 
DecoratorPanel

A SimplePanel that wraps its contents in stylized boxes, which can be used to add rounded corners to a Widget

DelegatingChangeListenerCollection This class is deprecated. Use Widget.delegateEvent instead  
DelegatingClickListenerCollection This class is deprecated. Use delegateEvent(Widget, GwtEvent) instead  
DelegatingFocusListenerCollection This class is deprecated. Use delegateEvent(Widget, GwtEvent) instead  
DelegatingKeyboardListenerCollection This class is deprecated. Use delegateEvent(Widget, GwtEvent) instead  
DialogBox A form of popup that has a caption area at the top and can be dragged by the user. 
DirectionalTextHelper A helper class for displaying bidi (i.e. 
DisclosureEvent This class is deprecated. Use CloseEvent and OpenEvent instead  
DisclosurePanel A widget that consists of a header and a content panel that discloses the content when a user clicks on the header. 
DockLayoutPanel A panel that lays its child widgets out "docked" at its outer edges, and allows its last widget to take up the remaining space in its center. 
DockLayoutPanel.LayoutData Layout data associated with each widget. 
DockPanel This class is deprecated. Use DockLayoutPanel instead, but understand that it is not a drop in replacement for this class. It requires standards mode, and is most easily used under a RootLayoutPanel (as opposed to a RootPanel 
DockPanel.DockLayoutConstant DockPanel layout constant, used in add(Widget, DockPanel.DockLayoutConstant)
DoubleBox A ValueBox that uses DoubleParser and DoubleRenderer
FileUpload A widget that wraps the HTML <input type='file'> element. 
FlexTable A flexible table that creates cells on demand. 
FlexTable.FlexCellFormatter FlexTable-specific implementation of HTMLTable.CellFormatter
FlowPanel A panel that formats its child widgets using the default HTML layout behavior. 
FocusListenerAdapter This class is deprecated. Use FocusHandler and BlurHandler instead  
FocusListenerCollection This class is deprecated. Widgets should now manage their own handlers via addDomHandler(H, DomEvent.Type)  
FocusPanel A simple panel that makes its contents focusable, and adds the ability to catch mouse and keyboard events. 
FocusWidget Abstract base class for most widgets that can receive keyboard focus. 
FormHandlerCollection This class is deprecated. Widgets should now manage their own handlers via addDomHandler(H, DomEvent.Type)  
FormPanel A panel that wraps its contents in an HTML <FORM> element. 
FormPanel.SubmitCompleteEvent Fired when a form has been submitted successfully. 
FormPanel.SubmitEvent Fired when the form is submitted. 
FormSubmitCompleteEvent Event object containing information about form submission events. 
FormSubmitEvent Event object containing information about form submission events. 
Frame A widget that wraps an IFRAME element, which can contain an arbitrary web site. 
Grid A rectangular grid that can contain text, html, or a child Widget within its cells. 
HasHorizontalAlignment.AutoHorizontalAlignmentConstant Type for values defined and used in HasAutoHorizontalAlignment
HasHorizontalAlignment.HorizontalAlignmentConstant Possible return values for getHorizontalAlignment(), and parameter values for setHorizontalAlignment(HasHorizontalAlignment.HorizontalAlignmentConstant)
HasVerticalAlignment.VerticalAlignmentConstant Horizontal alignment constant. 
Hidden Represents a hidden field in an HTML form. 
HorizontalPanel A panel that lays all of its widgets out in a single horizontal column. 
HorizontalSplitPanel This class is deprecated. Use SplitLayoutPanel instead, but understand that it is not a drop in replacement for this class. It requires standards mode, and is most easily used under a RootLayoutPanel (as opposed to a RootPanel 
HTML A widget that can contain arbitrary HTML. 
HTMLPanel A panel that contains HTML, and which can attach child widgets to identified elements within that HTML. 
HTMLTable HTMLTable contains the common table algorithms for Grid and FlexTable
HTMLTable.Cell Return value for getCellForEvent(ClickEvent)
HTMLTable.CellFormatter This class contains methods used to format a table's cells. 
HTMLTable.ColumnFormatter This class contains methods used to format a table's columns. 
HTMLTable.RowFormatter This class contains methods used to format a table's rows. 
Hyperlink A widget that serves as an "internal" hyperlink. 
Image A widget that displays the image at a given URL. 
InlineHTML A widget that can contain arbitrary HTML. 
InlineHyperlink A widget that serves as an "internal" hyperlink. 
InlineLabel A widget that contains arbitrary text, not interpreted as HTML. 
IntegerBox A ValueBox that uses IntegerParser and IntegerRenderer
KeyboardListenerAdapter This class is deprecated. use KeyDownHandler, KeyUpHandler and/or KeyPressHandler instead  
KeyboardListenerCollection This class is deprecated. Widgets should now manage their own handlers via addDomHandler(H, DomEvent.Type)  
Label A widget that contains arbitrary text, not interpreted as HTML. 
LabelBase<T> Abstract base class for all text display widgets. 
LayoutCommand A scheduled command used by animated layouts to ensure that only layout is ever performed for a panel within a given user event. 
LayoutPanel A panel that lays its children out in arbitrary layers using the Layout class. 
LazyPanel Convenience class to help lazy loading. 
ListBox A widget that presents a list of choices to the user, either as a list box or as a drop-down list. 
ListenerWrapper<T> This class is deprecated. will be removed in GWT 2.0 with the handler listeners themselves  
ListenerWrapper.WrappedChangeListener This class is deprecated. will be removed in GWT 2.0 along with the listeners being wrapped  
ListenerWrapper.WrappedClickListener This class is deprecated. will be removed in GWT 2.0 along with the listeners being wrapped  
ListenerWrapper.WrappedFocusListener Wrapper for a FocusListener
ListenerWrapper.WrappedKeyboardListener Wrapper for a KeyboardListener
ListenerWrapper.WrappedLoadListener Wrapper for a LoadListener
ListenerWrapper.WrappedLogicalChangeListener<V> This class is deprecated. will be removed in GWT 2.0 along with the listeners being wrapped  
ListenerWrapper.WrappedMouseListener Wrapper for a MouseListener
ListenerWrapper.WrappedMouseWheelListener Wrapper for a MouseWheelListener
ListenerWrapper.WrappedScrollListener Wrapper for a ScrollListener
LoadListenerCollection This class is deprecated. Widgets should now manage their own handlers via addDomHandler(H, DomEvent.Type)  
LongBox A ValueBox that uses LongParser and LongRenderer
MenuBar A standard menu bar widget. 
MenuItem An entry in a MenuBar
MenuItemSeparator A separator that can be placed in a MenuBar
MouseListenerAdapter This class is deprecated. use MouseDownHandler, MouseUpHandler, MouseOverHandler, MouseMoveHandler, and/or MouseOutHandler instead  
MouseListenerCollection This class is deprecated. Widgets should now manage their own handlers via addDomHandler(H, DomEvent.Type)  
MouseWheelListenerCollection This class is deprecated. Widgets should now manage their own handlers via addDomHandler(H, DomEvent.Type)  
MouseWheelVelocity This class is deprecated. use getDeltaY() instead  
MultiWordSuggestOracle The default SuggestOracle
MultiWordSuggestOracle.MultiWordSuggestion Suggestion class for MultiWordSuggestOracle
NamedFrame A Frame that has a 'name' associated with it. 
NotificationMole Simple widget for providing notification feedback. 
NumberLabel<T extends Number> Extends ValueLabel for convenience when dealing with numbers and NumberFormat, especially in UiBinder templates. 
Panel Abstract base class for all panels, which are widgets that can contain other widgets. 
PasswordTextBox A text box that visually masks its input to prevent eavesdropping. 
PopupListenerCollection This class is deprecated. Widgets should now manage their own handlers via addDomHandler(H, DomEvent.Type)  
PopupPanel A panel that can "pop up" over other widgets. 
PushButton A normal push button with custom styling. 
RadioButton A mutually-exclusive selection radio button widget. 
ResetButton A standard push-button widget which will automatically reset its enclosing FormPanel if any. 
ResizeComposite A Composite implementation that implements RequiresResize and automatically delegates that interface's methods to its wrapped widget, which must itself implement RequiresResize
RichTextArea A rich text editor that allows complex styling and formatting. 
RichTextArea.FontSize Font size enumeration. 
RichTextArea.Justification Justification enumeration. 
RootLayoutPanel A singleton implementation of LayoutPanel that always attaches itself to the document body (i.e. 
RootPanel The panel to which all other widgets must ultimately be added. 
ScrollListenerCollection This class is deprecated. Widgets should now manage their own handlers via addDomHandler(H, DomEvent.Type)  
ScrollPanel A simple panel that wraps its contents in a scrollable area. 
SimpleCheckBox A simple checkbox widget, with no label. 
SimplePanel Base class for panels that contain only one widget. 
SimpleRadioButton A simple radio button widget, with no label. 
SplitLayoutPanel A panel that adds user-positioned splitters between each of its child widgets. 
StackLayoutPanel A panel that stacks its children vertically, displaying only one at a time, with a header for each child which the user can click to display. 
StackPanel A panel that stacks its children vertically, displaying only one at a time, with a header for each child which the user can click to display. 
SubmitButton A standard push-button widget which will automatically submit its enclosing FormPanel if any. 
SuggestBox A SuggestBox is a text box or text area which displays a pre-configured set of selections that match the user's input. 
SuggestBox.DefaultSuggestionDisplay

The default implementation of SuggestBox.SuggestionDisplay displays suggestions in a PopupPanel beneath the SuggestBox

SuggestBox.SuggestionDisplay Used to display suggestions to the user. 
SuggestionEvent Event object containing information about the selection of a SuggestOracle.Suggestion displayed by a SuggestBox
SuggestOracle A SuggestOracle can be used to create suggestions associated with a specific query string. 
SuggestOracle.Request A SuggestOracle request. 
SuggestOracle.Response SuggestOracle response. 
TabBar A horizontal bar of folder-style tabs, most commonly used as part of a TabPanel
TabLayoutPanel A panel that represents a tabbed set of pages, each of which contains another widget. 
TableListenerCollection This class is deprecated. Widgets should now manage their own handlers via addDomHandler(H, DomEvent.Type)  
TabListenerCollection This class is deprecated. Widgets should now manage their own handlers via addDomHandler(H, DomEvent.Type)  
TabPanel A panel that represents a tabbed set of pages, each of which contains another widget. 
TextArea A text box that allows multiple lines of text to be entered. 
TextBox A standard single-line text box. 
TextBoxBase Abstract base class for most text entry widgets. 
TextBoxBase.TextAlignConstant This class is deprecated. use setAlignment(ValueBoxBase.TextAlignment)  
ToggleButton A ToggleButton is a stylish stateful button which allows the user to toggle between up and down states. 
Tree A standard hierarchical tree widget. 
TreeItem An item that can be contained within a Tree
TreeItem.TreeItemImpl Implementation class for TreeItem
TreeItem.TreeItemImplIE6 IE specific implementation class for TreeItem
TreeListenerCollection This class is deprecated. Widgets should now manage their own handlers via addDomHandler(H, DomEvent.Type)  
UIObject The superclass for all user-interface objects. 
UIObject.DebugIdImpl The implementation of the set debug id method, which does nothing by default. 
UIObject.DebugIdImplEnabled The implementation of the setDebugId method, which sets the id of the Elements in this UIObject
ValueBox<T> A text box able to parse its displayed value. 
ValueBoxBase<T> Abstract base class for all text entry widgets. 
ValueLabel<T> A label displaying its value through a renderer. 
ValueListBox<T> Implementation of HasConstrainedValue based on a SelectElement
ValuePicker<T> Allows the user to pick a single value from a list. 
VerticalPanel A panel that lays all of its widgets out in a single vertical column. 
VerticalSplitPanel This class is deprecated. Use SplitLayoutPanel instead, but understand that it is not a drop in replacement for this class. It requires standards mode, and is most easily used under a RootLayoutPanel (as opposed to a RootPanel 
Widget The base class for the majority of user-interface objects. 
WidgetCollection A simple collection of widgets to be used by panels and composites

Enums

DockLayoutPanel.Direction Used in addEast(Widget, double) et al to specify the direction in which a child widget will be added. 
ValueBoxBase.TextAlignment Alignment values for setAlignment(ValueBoxBase.TextAlignment)

Exceptions

AttachDetachException An exception that is thrown when the panel fails to attach or detach its children.