Package com.google.gwt.user.client.ui
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.
-
ClassDescriptionAn absolute panel positions all of its children absolutely, allowing them to overlap.An opaque representation of a particular image such that the image can be accessed either as an HTML fragment or as an
Image
object.This corresponds to the top Element of the DOM structure created byAbstractImagePrototype.createElement()
.Abstract parent class for scrollbars implemented using the native browser scrollbars.Implemented by displays that can be given accept anIsWidget
to show.Deprecated.A widget that represents a simple <a> element.Specifies that a panel can animate between layouts.An exception that is thrown when the panel fails to attach or detach its children.The command to execute when iterating through child widgets.A standard push-button widget.A panel that wraps its contents in a border with a caption that appears in the upper left corner of the border.Implementation class without browser-specific hacks.Implementation class that handles Mozilla rendering issues.Implementation class that handles Safari rendering issues.A panel whose child widgets are contained within the cells of a table.Deprecated.As of GWT 1.6, DOM and logical change events are separate.Deprecated.Widgets should now manage their own handlers viaWidget.addDomHandler(H, com.google.gwt.event.dom.client.DomEvent.Type<H>)
A standard check box widget.Deprecated.UseClickHandler
insteadDeprecated.As of GWT 1.6, call
to manage handlers for your widget insteadaddDomHandler
(myHandler, ClickEvent.getType())Abstract base class for panels that can contain multiple child widgets.A type of widget that can wrap another widget, hiding the wrapped widget's methods.CustomButton is a base button class with built in support for a set number of button faces.A custom version of theScrollPanel
that allows user provided scrollbars.A ClientBundle of resources used by this widget.Styles used by this widget.ExtendsValueLabel
for convenience when dealing with dates andDateTimeFormat
, especially inUiBinder
templates.A panel that displays all of its child widgets in a 'deck', where only one can be visible at a time.A panel that displays all of its child widgets in a 'deck', where only one can be visible at a time.APopupPanel
that wraps its content in a 3x3 grid, which allows users to add rounded corners.AStackPanel
that wraps each item in a 2x3 grid (six box), which allows users to add rounded corners.ATabBar
that wraps each tab in a 2x3 grid (six box), which allows users to add rounded corners.ATabPanel
that uses aDecoratedTabBar
with rounded corners.ASimplePanel
that wraps its contents in stylized boxes, which can be used to add rounded corners to aWidget
.Deprecated.UseWidget.delegateEvent
insteadDeprecated.Deprecated.Deprecated.A form of popup that has a caption area at the top and can be dragged by the user.Set of characteristic interfaces supported by theDialogBox
caption.Default implementation of Caption.A helper class for displaying bidi (i.e.Deprecated.UseCloseEvent
andOpenEvent
insteadDeprecated.UseCloseHandler
and/orOpenHandler
insteadA widget that consists of a header and a content panel that discloses the content when a user clicks on the header.Deprecated.Deprecated.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.Used inDockLayoutPanel.addEast(Widget, double)
et al to specify the direction in which a child widget will be added.Layout data associated with each widget.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.DockPanel layout constant, used inDockPanel.add(Widget, DockPanel.DockLayoutConstant)
.A ValueBox that usesDoubleParser
andDoubleRenderer
.A widget that wraps the HTML <input type='file'> element.Iterator over a finite number of widgets, which are stored in a delegate class (usually a widget panel).Provides widgets to the iterator.Deprecated.UseHasOpenHandlers
andHasCloseHandlers
insteadDeprecated.This interface was specific toFormPanel
; it is not generally useful and will be removed in a future version.Deprecated.UseHasSelectionHandlers
instead.A flexible table that creates cells on demand.A panel that formats its child widgets using the default HTML layout behavior.A widget that implements this interface can receive keyboard focus.Deprecated.UseFocusHandler
and/orBlurHandler
insteadDeprecated.UseFocusHandler
andBlurHandler
insteadDeprecated.Widgets should now manage their own handlers viaWidget.addDomHandler(H, com.google.gwt.event.dom.client.DomEvent.Type<H>)
A simple panel that makes its contents focusable, and adds the ability to catch mouse and keyboard events.Abstract base class for most widgets that can receive keyboard focus.Deprecated.UseFormPanel.SubmitCompleteHandler
and/orFormPanel.SubmitHandler
insteadDeprecated.Widgets should now manage their own handlers viaWidget.addDomHandler(H, com.google.gwt.event.dom.client.DomEvent.Type<H>)
A panel that wraps its contents in an HTML <FORM> element.Fired when a form has been submitted successfully.Handler forFormPanel.SubmitCompleteEvent
events.Fired when the form is submitted.Handler forFormPanel.SubmitEvent
events.Event object containing information about form submission events.Event object containing information about form submission events.A widget that wraps an IFRAME element, which can contain an arbitrary web site.A rectangular grid that can contain text, html, or a childWidget
within its cells.A widget that implements this interface has an intrinsic alignment which can be manipulated using these methods and constants.AWidget
that uses an animation should implement this class so users can enable or disable animations.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 byHasHorizontalAlignment
.A widget that implements this interface has a caption which can be set and retrieved using these methods.Implemented by widgets that pick from a set of values.An object that implements this interface contains html that has a direction.An object that implements this interface contains html that has a direction.An object that implements this interface contains text that has a direction.A widget that implements this interface can be put in an "enabled" or "disabled" state.Deprecated.UseFocusable
insteadCharacteristic interface which indicates that a widget can be aligned horizontally.Type for values defined and used inHasAutoHorizontalAlignment
.Possible return values forHasHorizontalAlignment.getHorizontalAlignment()
, and parameter values forHasHorizontalAlignment.setHorizontalAlignment(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant)
.Implemented by widgets that support horizontal scrolling.An object that implements this interface contains text, which can be set and retrieved using these methods.Deprecated.This interface is no longer implemented by any GWT library.A widget that implements this interface has a 'name' associated with it, allowing it to be used withFormPanel
.Implemented by panels that have only one widget.Implemented by widgets that support scrolling.An object that implements this interface contains text, which can be set and retrieved using these methods.A widget that implements this interface containsitems
and can operate them.Extends this interface with convenience methods to handleIsWidget
.HasValue<T>ExtendsTakesValue
to allow the value to be pulled back out, and to throwValueChangeEvent
events.Characteristic interface which indicates that a widget has an associated vertical alignment.Horizontal alignment constant.Implemented by widgets that support vertical scrolling.Implemented by objects that have the visibility trait.A widget that implements this interface containswidgets
and can enumerate them.Extends this interface with convenience methods to handleIsWidget
.A widget that implements this interface has a 'word-wrap' property that can be manipulated using these methods.A panel that includes a header (top), footer (bottom), and content (middle) area.Represents a hidden field in an HTML form.A panel that lays all of its widgets out in a single horizontal column.Describes a horizontal scrollbar.Deprecated.UseSplitLayoutPanel
instead, but understand that it is not a drop in replacement for this class.The default resources used by this widget.Deprecated.replaced byHorizontalSplitPanel.Resources
.A widget that can contain arbitrary HTML.A panel that contains HTML, and which can attach child widgets to identified elements within that HTML.A widget that serves as an "internal" hyperlink.A widget that displays the image at a given URL.Deprecated.replaced byClientBundle
andImageResource
Explicitly specifies a file name or path to the image resource to be associated with a method in anImageBundle
.Given anImageResource
, renders an element to show it.Implemented by panels that impose an explicit ordering on their children.Extends this interface with convenience methods to handleIsWidget
.A widget that can contain arbitrary HTML.A widget that serves as an "internal" hyperlink.A widget that contains arbitrary text, not interpreted as HTML.Implemented byIndexedPanel
s that also allow insertions.Extends this interface with convenience methods to handleIsWidget
.A ValueBox that usesIntegerParser
andIntegerRenderer
.An interface for UI elements that can be built by first generating a piece of HTML and afterwards wrapping a root widget.Extended by objects which have underlyingTreeItem
.Extended by view interfaces that are likely to be implemented by Widgets.Deprecated.Deprecated.Deprecated.Widgets should now manage their own handlers viaWidget.addDomHandler(H, com.google.gwt.event.dom.client.DomEvent.Type<H>)
A widget that contains arbitrary text, not interpreted as HTML.LabelBase<T>Abstract base class for all text display widgets.A scheduled command used by animated layouts to ensure that only layout is ever performed for a panel within a given user event.Convenience class to help lazy loading.A widget that presents a list of choices to the user, either as a list box or as a drop-down list.Deprecated.will be removed in GWT 2.7 with the handler listeners themselvesDeprecated.will be removed in GWT 2.0 along with the listeners being wrappedDeprecated.will be removed in GWT 2.0 along with the listeners being wrappedWrapper for aFocusListener
.Wrapper for aKeyboardListener
.Wrapper for aLoadListener
.Deprecated.will be removed in GWT 2.0 along with the listeners being wrappedWrapper for aMouseListener
.Wrapper for aMouseWheelListener
.Wrapper for aScrollListener
.Deprecated.useLoadHandler
andErrorHandler
insteadDeprecated.Widgets should now manage their own handlers viaWidget.addDomHandler(H, com.google.gwt.event.dom.client.DomEvent.Type<H>)
A ValueBox that usesLongParser
andLongRenderer
.A standard menu bar widget.Deprecated.replaced byMenuBar.Resources
A ClientBundle that contains the default resources for this widget.An entry in aMenuBar
.A separator that can be placed in aMenuBar
.Deprecated.useMouseDownHandler
,MouseUpHandler
,MouseOverHandler
,MouseMoveHandler
, andMouseOutHandler
insteadDeprecated.useMouseDownHandler
,MouseUpHandler
,MouseOverHandler
,MouseMoveHandler
, and/orMouseOutHandler
insteadDeprecated.Widgets should now manage their own handlers viaWidget.addDomHandler(H, com.google.gwt.event.dom.client.DomEvent.Type<H>)
Deprecated.useMouseWheelHandler
insteadDeprecated.Widgets should now manage their own handlers viaWidget.addDomHandler(H, com.google.gwt.event.dom.client.DomEvent.Type<H>)
Deprecated.useMouseWheelEvent.getDeltaY()
insteadThe defaultSuggestOracle
.Suggestion class forMultiWordSuggestOracle
.AFrame
that has a 'name' associated with it.A horizontal scrollbar implemented using the browsers native scrollbar.A ClientBundle of resources used by this widget.A variation ofNativeHorizontalScrollbar.Resources
that renders the scrollbar semi-transparent until it is hovered.Styles used by this widget.A variation ofNativeHorizontalScrollbar.Style
that renders the scrollbar semi-transparent until it is hovered.A vertical scrollbar implemented using the browsers native scrollbar.A ClientBundle of resources used by this widget.A variation ofNativeVerticalScrollbar.Resources
that renders the scrollbar semi-transparent until it is hovered.Styles used by this widget.A variation ofNativeVerticalScrollbar.Style
that renders the scrollbar semi-transparent until it is hovered.Client bundle used in the uibinder template.Style used in uibinder template.Simple widget for providing notification feedback.Default CSS styles for this widget.NumberLabel<T extends Number>ExtendsValueLabel
for convenience when dealing with numbers andNumberFormat
, especially inUiBinder
templates.Abstract base class for all panels, which are widgets that can contain other widgets.A text box that visually masks its input to prevent eavesdropping.Deprecated.useCloseHandler
insteadDeprecated.Widgets should now manage their own handlers viaWidget.addDomHandler(H, com.google.gwt.event.dom.client.DomEvent.Type<H>)
A panel that can "pop up" over other widgets.The type of animation to use when opening the popup.A callback that is used to set the position of aPopupPanel
right before it is shown.AnAnimation
used to enlarge the popup into view.EXPERIMENTAL and subject to change.A prefix tree (aka trie).This tag interface specifies that the implementing widget will callRequiresResize.onResize()
on its children whenever their size may have changed.A normal push button with custom styling.A mutually-exclusive selection radio button widget.EXPERIMENTAL and subject to change.Used byIsRenderable
to mark their root element in such a way that they can be later retrieved.This interface designates that its implementor needs to be informed whenever its size is modified.A standard push-button widget which will automatically reset its enclosingFormPanel
if any.AComposite
implementation that implementsRequiresResize
and automatically delegates that interface's methods to its wrapped widget, which must itself implementRequiresResize
.A simple panel thatProvidesResize
to its one child, but does notRequiresResize
.Implementation of resize event.Delegate event handler.Implementation of resize event.Implementation of resize event used by IE.A rich text editor that allows complex styling and formatting.Deprecated.useRichTextArea.Formatter
insteadDeprecated.useRichTextArea.Formatter
insteadFont size enumeration.This interface is used to access full formatting options, when available.Justification enumeration.A singleton implementation ofLayoutPanel
that always attaches itself to the document body (i.e.The panel to which all other widgets must ultimately be added.Implementation of scrolling behavior.IE does not fire a scroll event when the scrollable element or the container is resized, so we synthesize one as needed.Deprecated.useScrollHandler
insteadDeprecated.Widgets should now manage their own handlers viaWidget.addDomHandler(H, com.google.gwt.event.dom.client.DomEvent.Type<H>)
A simple panel that wraps its contents in a scrollable area.A simple checkbox widget, with no label.A simple panel thatProvidesResize
to its one child.Base class for panels that contain only one widget.A simple radio button widget, with no label.Deprecated.we have now separated dom and logical change events.Deprecated.useHasClickHandlers
insteadDeprecated.useHasAllFocusHandlers
insteadDeprecated.useHasAllKeyHandlers
insteadDeprecated.useHasErrorHandlers
andHasLoadHandlers
insteadDeprecated.useHasAllMouseHandlers
insteadDeprecated.UseHasMouseWheelHandlers
insteadDeprecated.useHasCloseHandlers
insteadDeprecated.useHasScrollHandlers
insteadDeprecated.useHasSelectionHandlers
andHasBeforeSelectionHandlers
insteadDeprecated.useHasClickHandlers
instead.Deprecated.A panel that adds user-positioned splitters between each of its child widgets.Deprecated.UseSplitLayoutPanel
instead, but understand that it is not a drop in replacement for this class.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.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.A standard push-button widget which will automatically submit its enclosingFormPanel
if any.ASuggestBox
is a text box or text area which displays a pre-configured set of selections that match the user's input.The default implementation ofSuggestBox.SuggestionDisplay
displays suggestions in aPopupPanel
beneath theSuggestBox
.The callback used when a user selects aSuggestOracle.Suggestion
.Used to display suggestions to the user.Event object containing information about the selection of aSuggestOracle.Suggestion
displayed by aSuggestBox
.Deprecated.useSelectionHandler
insteadASuggestOracle
can be used to create suggestions associated with a specific query string.Callback forSuggestOracle
.ASuggestOracle
request.SuggestOracle
response.Suggestion supplied by theSuggestOracle
.A horizontal bar of folder-style tabs, most commonly used as part of aTabPanel
.Set of characteristic interfaces supported byTabBar
tabs.A panel that represents a tabbed set of pages, each of which contains another widget.Deprecated.Deprecated.Widgets should now manage their own handlers viaWidget.addDomHandler(H, com.google.gwt.event.dom.client.DomEvent.Type<H>)
Deprecated.Deprecated.Widgets should now manage their own handlers viaWidget.addDomHandler(H, com.google.gwt.event.dom.client.DomEvent.Type<H>)
A panel that represents a tabbed set of pages, each of which contains another widget.A text box that allows multiple lines of text to be entered.A standard single-line text box.Abstract base class for most text entry widgets.Deprecated.AToggleButton
is a stylish stateful button which allows the user to toggle betweenup
anddown
states.A standard hierarchical tree widget.There are several ways of configuring images for the Tree widget due to deprecated APIs.A ClientBundle that provides images for this widget.Deprecated.replaced byTree.Resources
.An item that can be contained within aTree
.Deprecated.Deprecated.Deprecated.Widgets should now manage their own handlers viaWidget.addDomHandler(H, com.google.gwt.event.dom.client.DomEvent.Type<H>)
The superclass for all user-interface objects.The implementation of the set debug id method, which does nothing by default.ValueBox<T>A text box able to parse its displayed value.ValueBoxBase<T>Abstract base class for all text entry widgets.Alignment values forValueBoxBase.setAlignment(com.google.gwt.user.client.ui.ValueBoxBase.TextAlignment)
.ValueLabel<T>A label displaying its value through a renderer.ValueListBox<T>Implementation ofHasConstrainedValue
based on aSelectElement
.ValuePicker<T>Allows the user to pick a single value from a list.A panel that lays all of its widgets out in a single vertical column.Describes a vertical scrollbar.Deprecated.UseSplitLayoutPanel
instead, but understand that it is not a drop in replacement for this class.The default resources used by this widget.Deprecated.replaced byVerticalSplitPanel.Resources
.The base class for the majority of user-interface objects.A simple collection of widgets to be used bypanels
andcomposites
.A collection of convenience factories for creating iterators for widgets.
Roles
.