public class

AbsolutePanel

extends ComplexPanel
implements InsertPanel.ForIsWidget

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.Widget
		↳	com.google.gwt.user.client.ui.Panel
			↳	com.google.gwt.user.client.ui.ComplexPanel
				↳	com.google.gwt.user.client.ui.AbsolutePanel

Known Direct Subclasses

RootPanel

Class Overview

An absolute panel positions all of its children absolutely, allowing them to overlap.

Note that this panel will not automatically resize itself to allow enough room for its absolutely-positioned children. It must be explicitly sized in order to make room for them.

Once a widget has been added to an absolute panel, the panel effectively "owns" the positioning of the widget. Any existing positioning attributes on the widget may be modified by the panel.

Use in UiBinder Templates

AbsolutePanel elements in UiBinder templates lay out their children with absolute position, using <g:at> elements. Each at element should have left and top attributes in pixels. They also can contain widget children directly, with no position specified.

For example:

 <g:AbsolutePanel>
   <g:at left='10' top='20'>
     <g:Label>Lorem ipsum...</g:Label>
   </g:at>
   <g:Label>...dolores est.</g:Label>
 </g:AbsolutePanel>

Summary

[Expand]

Inherited Constants

From class com.google.gwt.user.client.ui.UIObject

Public Constructors
	AbsolutePanel() Creates an empty absolute panel.

Protected Constructors
	AbsolutePanel(Element elem) Creates an AbsolutePanel with the given element.

Public Methods
void	add(Widget w, int left, int top) Adds a widget to the panel at the specified position.
void	add(Widget w) Adds a child widget.
int	getWidgetLeft(Widget w) Gets the position of the left outer border edge of the widget relative to the left outer border edge of the panel.
int	getWidgetTop(Widget w) Gets the position of the top outer border edge of the widget relative to the top outer border edge of the panel.
void	insert(IsWidget w, int beforeIndex) Convenience overload to allow `IsWidget` to be used directly.
void	insert(Widget w, int left, int top, int beforeIndex) Inserts a child widget at the specified position before the specified index.
void	insert(Widget w, int beforeIndex) Inserts a child widget before the specified index.
boolean	remove(Widget w) Overrides `remove(Widget)` to change the removed Widget's element back to static positioning.This is done so that any positioning changes to the widget that were done by the panel are undone when the widget is disowned from the panel.
void	setWidgetPosition(Widget w, int left, int top) Sets the position of the specified child widget.

Protected Methods
void	setWidgetPositionImpl(Widget w, int left, int top)

[Expand]

Inherited Methods

From class com.google.gwt.user.client.ui.ComplexPanel

void	add(Widget child, Element container) Adds a new child widget to the panel, attaching its Element to the specified container Element.
int	adjustIndex(Widget child, int beforeIndex) Adjusts beforeIndex to account for the possibility that the given widget is already a child of this panel.
void	checkIndexBoundsForAccess(int index) Checks that `index` is in the range [0, getWidgetCount()), which is the valid range on accessible indexes.
void	checkIndexBoundsForInsertion(int index) Checks that `index` is in the range [0, getWidgetCount()], which is the valid range for indexes on an insertion.
WidgetCollection	getChildren() Gets the list of children contained in this panel.
Widget	getWidget(int index) Gets the child widget at the specified index.
int	getWidgetCount() Gets the number of child widgets in this panel.
int	getWidgetIndex(Widget child) Gets the index of the specified child widget.
int	getWidgetIndex(IsWidget child)
void	insert(Widget child, Element container, int beforeIndex, boolean domInsert) Insert a new child Widget into this Panel at a specified index, attaching its Element to the specified container Element.
void	insert(Widget child, Element container, int beforeIndex) This method is deprecated. Use `insert(Widget, Element, int, boolean)` instead
Iterator<Widget>	iterator()
boolean	remove(Widget w) Removes a child widget.
boolean	remove(int index) Removes the widget at the specified index.

From class com.google.gwt.user.client.ui.Panel

void	add(IsWidget child)
void	add(Widget child) Adds a child widget.
final void	adopt(Widget child) Finalize the attachment of a Widget to this Panel.
void	adopt(Widget w, Element container) This method is deprecated. Use `adopt(Widget)`.
void	clear() Removes all child widgets.
void	disown(Widget w) This method is deprecated. Use `orphan(Widget)`.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
final void	orphan(Widget child) This method must be called as part of the remove method of any Panel.
abstract boolean	remove(Widget child) Removes a child widget.
boolean	remove(IsWidget child)

From class com.google.gwt.user.client.ui.Widget

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

From class com.google.gwt.user.client.ui.UIObject

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.ui.HasWidgets

From interface com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

From interface com.google.gwt.user.client.ui.IndexedPanel

From interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

From interface com.google.gwt.user.client.ui.InsertPanel

From interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

From interface com.google.gwt.user.client.ui.IsWidget

From interface java.lang.Iterable

Public Constructors

public AbsolutePanel ()

Creates an empty absolute panel.

Protected Constructors

protected AbsolutePanel (Element elem)

Creates an AbsolutePanel with the given element. This is protected so that it can be used by RootPanel or a subclass that wants to substitute another element. The element is presumed to be a <div>.

Parameters

elem	the element to be used for this panel

Public Methods

public void add (Widget w, int left, int top)

Adds a widget to the panel at the specified position. Setting a position of (-1, -1) will cause the child widget to be positioned statically.

Parameters

w	the widget to be added
left	the widget's left position
top	the widget's top position

public void add (Widget w)

Adds a child widget.

How to Override this Method

There are several important things that must take place in the correct order to properly add or insert a Widget to a Panel. Not all of these steps will be relevant to every Panel, but all of the steps must be considered.

Validate: Perform any sanity checks to ensure the Panel can accept a new Widget. Examples: checking for a valid index on insertion; checking that the Panel is not full if there is a max capacity.
Adjust for Reinsertion: Some Panels need to handle the case where the Widget is already a child of this Panel. Example: when performing a reinsert, the index might need to be adjusted to account for the Widget's removal. See adjustIndex(Widget, int).
Detach Child: Remove the Widget from its existing parent, if any. Most Panels will simply call removeFromParent() on the Widget.
Logical Attach: Any state variables of the Panel should be updated to reflect the addition of the new Widget. Example: the Widget is added to the Panel's WidgetCollection at the appropriate index.
Physical Attach: The Widget's Element must be physically attached to the Panel's Element, either directly or indirectly.
Adopt: Call adopt(Widget) to finalize the add as the very last step.

Parameters

w	the widget to be added

public int getWidgetLeft (Widget w)

Gets the position of the left outer border edge of the widget relative to the left outer border edge of the panel.

Parameters

w	the widget whose position is to be retrieved

Returns

the widget's left position

public int getWidgetTop (Widget w)

Gets the position of the top outer border edge of the widget relative to the top outer border edge of the panel.

Parameters

w	the widget whose position is to be retrieved

Returns

the widget's top position

public void insert (IsWidget w, int beforeIndex)

Convenience overload to allow IsWidget to be used directly.

public void insert (Widget w, int left, int top, int beforeIndex)

Inserts a child widget at the specified position before the specified index. Setting a position of (-1, -1) will cause the child widget to be positioned statically. If the widget is already a child of this panel, it will be moved to the specified index.

Parameters

w	the child widget to be inserted
left	the widget's left position
top	the widget's top position
beforeIndex	the index before which it will be inserted

Throws

IndexOutOfBoundsException	if `beforeIndex` is out of range

public void insert (Widget w, int beforeIndex)

Inserts a child widget before the specified index. If the widget is already a child of this panel, it will be moved to the specified index.

Parameters

w	the child widget to be inserted
beforeIndex	the index before which it will be inserted

public boolean remove (Widget w)

Overrides remove(Widget) to change the removed Widget's element back to static positioning.This is done so that any positioning changes to the widget that were done by the panel are undone when the widget is disowned from the panel.

Parameters

w	the widget to be removed

Returns

true if the child was present

public void setWidgetPosition (Widget w, int left, int top)

Sets the position of the specified child widget. Setting a position of (-1, -1) will cause the child widget to be positioned statically.

Parameters

w	the child widget to be positioned
left	the widget's left position
top	the widget's top position

Interfaces

Classes

Annotations

Enums

Exceptions

AbsolutePanel

Class Overview

Use in UiBinder Templates

Summary

Public Constructors

public AbsolutePanel ()

Protected Constructors

protected AbsolutePanel (Element elem)

Parameters

Public Methods

public void add (Widget w, int left, int top)

Parameters

public void add (Widget w)

Parameters

public int getWidgetLeft (Widget w)

Parameters

Returns

public int getWidgetTop (Widget w)

Parameters

Returns

public void insert (IsWidget w, int beforeIndex)

public void insert (Widget w, int left, int top, int beforeIndex)

Parameters

Throws

public void insert (Widget w, int beforeIndex)

Parameters

public boolean remove (Widget w)

Parameters

Returns

public void setWidgetPosition (Widget w, int left, int top)

Parameters

Protected Methods

protected void setWidgetPositionImpl (Widget w, int left, int top)