public class

DockLayoutPanel

extends ComplexPanel
implements AnimatedLayout ProvidesResize RequiresResize

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.DockLayoutPanel

Known Direct Subclasses

SplitLayoutPanel

Class Overview

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.

This widget will only work in standards mode, which requires that the HTML page in which it is run have an explicit <!DOCTYPE> declaration.

Example

{@example com.google.gwt.examples.DockLayoutPanelExample}

Use in UiBinder Templates

DockLayoutPanel elements in UiBinder templates lay out their children in elements tagged with the cardinal directions, and center:

<g:center>
<g:north>
<g:south>
<g:west>
<g:east>

Each child can hold only widget, and there can be only one <g:center>. However, there can be any number of the directional children.

(Note that the tags of the child elements are not capitalized. This is meant to signal that they are not runtime objects, and so cannot have a ui:field attribute.)

For example:

 <g:DockLayoutPanel unit='EM'>
   <g:north size='5'>
     <g:Label>Top</g:Label>
   </g:north>
   <g:center>
     <g:Label>Body</g:Label>
   </g:center>
   <g:west size='192'>
     <g:HTML>
       <ul>
         <li>Sidebar</li>
         <li>Sidebar</li>
         <li>Sidebar</li>
       </ul>
     </g:HTML>
   </g:west>
 </g:DockLayoutPanel>

Summary

Nested Classes
enum	DockLayoutPanel.Direction	Used in `addEast(Widget, double)` et al to specify the direction in which a child widget will be added.
class	DockLayoutPanel.LayoutData	Layout data associated with each widget.

[Expand]

Inherited Constants

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

Public Constructors
	DockLayoutPanel(Style.Unit unit) Creates an empty dock panel.

Public Methods
void	add(Widget widget) Adds a widget at the center of the dock.
void	addEast(Widget widget, double size) Adds a widget to the east edge of the dock.
void	addLineEnd(Widget widget, double size) Adds a widget to the end of the line.
void	addLineStart(Widget widget, double size) Adds a widget to the start of the line.
void	addNorth(Widget widget, double size) Adds a widget to the north edge of the dock.
void	addSouth(Widget widget, double size) Adds a widget to the south edge of the dock.
void	addWest(Widget widget, double size) Adds a widget to the west edge of the dock.
void	animate(int duration, Layout.AnimationCallback callback) Layout children, animating over the specified period of time.
void	animate(int duration) Layout children, animating over the specified period of time.
void	forceLayout() Layout children immediately.
Element	getWidgetContainerElement(Widget child) Gets the container element wrapping the given child widget.
DockLayoutPanel.Direction	getWidgetDirection(Widget child) Gets the layout direction of the given child widget.
void	insertEast(Widget widget, double size, Widget before) Adds a widget to the east edge of the dock, inserting it before an existing widget.
void	insertLineEnd(Widget widget, double size, Widget before) Adds a widget to the start of the line, inserting it before an existing widget.
void	insertLineStart(Widget widget, double size, Widget before) Adds a widget to the end of the line, inserting it before an existing widget.
void	insertNorth(Widget widget, double size, Widget before) Adds a widget to the north edge of the dock, inserting it before an existing widget.
void	insertSouth(Widget widget, double size, Widget before) Adds a widget to the south edge of the dock, inserting it before an existing widget.
void	insertWest(Widget widget, double size, Widget before) Adds a widget to the west edge of the dock, inserting it before an existing widget.
void	onResize() This method must be called whenever the implementor's size has been modified.
boolean	remove(Widget w) Removes a child widget.
void	setWidgetSize(Widget widget, double size) Updates the size of the widget passed in as long as it is not the center widget and updates the layout of the dock.

Protected Methods
Widget	getCenter()
double	getCenterHeight()
double	getCenterWidth()
DockLayoutPanel.Direction	getResolvedDirection(DockLayoutPanel.Direction direction) Resolve the specified direction based on the current locale.
Style.Unit	getUnit()
void	insert(Widget widget, DockLayoutPanel.Direction direction, double size, Widget before) Adds a widget to the specified edge of the dock.
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.

[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.AnimatedLayout

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.IsWidget

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

From interface java.lang.Iterable

Public Constructors

public DockLayoutPanel (Style.Unit unit)

Creates an empty dock panel.

Parameters

unit	the unit to be used for layout

Public Methods

public void add (Widget widget)

Adds a widget at the center of the dock. No further widgets may be added after this one.

Parameters

widget	the widget to be added

public void addEast (Widget widget, double size)

Adds a widget to the east edge of the dock.

Parameters

widget	the widget to be added
size	the child widget's size

public void addLineEnd (Widget widget, double size)

Adds a widget to the end of the line. In LTR mode, the widget is added to the east. In RTL mode, the widget is added to the west.

Parameters

widget	the widget to be added
size	the child widget's size

public void addLineStart (Widget widget, double size)

Adds a widget to the start of the line. In LTR mode, the widget is added to the west. In RTL mode, the widget is added to the east.

Parameters

widget	the widget to be added
size	the child widget's size

public void addNorth (Widget widget, double size)

Adds a widget to the north edge of the dock.

Parameters

widget	the widget to be added
size	the child widget's size

public void addSouth (Widget widget, double size)

Adds a widget to the south edge of the dock.

Parameters

widget	the widget to be added
size	the child widget's size

public void addWest (Widget widget, double size)

Adds a widget to the west edge of the dock.

Parameters

widget	the widget to be added
size	the child widget's size

public void animate (int duration, Layout.AnimationCallback callback)

Layout children, animating over the specified period of time.

This method provides a callback that will be informed of animation updates. This can be used to create more complex animation effects.

Parameters

duration	the animation duration, in milliseconds
callback	the animation callback

public void animate (int duration)

Layout children, animating over the specified period of time.

Parameters

duration	the animation duration, in milliseconds

public void forceLayout ()

Layout children immediately.

This is not normally necessary, unless you want to update child widgets' positions explicitly to create a starting point for a subsequent call to animate(int).

public Element getWidgetContainerElement (Widget child)

Gets the container element wrapping the given child widget.

Returns

the widget's container element

public DockLayoutPanel.Direction getWidgetDirection (Widget child)

Gets the layout direction of the given child widget.

Parameters

child	the widget to be queried

Returns

the widget's layout direction, or null if it is not a child of this panel

public void insertEast (Widget widget, double size, Widget before)

Adds a widget to the east edge of the dock, inserting it before an existing widget.

Parameters

widget	the widget to be added
size	the child widget's size
before	the widget before which to insert the new child, or `null` to append

public void insertLineEnd (Widget widget, double size, Widget before)

Adds a widget to the start of the line, inserting it before an existing widget. In LTR mode, the widget is added to the east. In RTL mode, the widget is added to the west.

Parameters

widget	the widget to be added
size	the child widget's size
before	the widget before which to insert the new child, or `null` to append

public void insertLineStart (Widget widget, double size, Widget before)

Adds a widget to the end of the line, inserting it before an existing widget. In LTR mode, the widget is added to the west. In RTL mode, the widget is added to the east.

Parameters

widget	the widget to be added
size	the child widget's size
before	the widget before which to insert the new child, or `null` to append

public void insertNorth (Widget widget, double size, Widget before)

Adds a widget to the north edge of the dock, inserting it before an existing widget.

Parameters

widget	the widget to be added
size	the child widget's size
before	the widget before which to insert the new child, or `null` to append

public void insertSouth (Widget widget, double size, Widget before)

Adds a widget to the south edge of the dock, inserting it before an existing widget.

Parameters

widget	the widget to be added
size	the child widget's size
before	the widget before which to insert the new child, or `null` to append

public void insertWest (Widget widget, double size, Widget before)

Adds a widget to the west edge of the dock, inserting it before an existing widget.

Parameters

widget	the widget to be added
size	the child widget's size
before	the widget before which to insert the new child, or `null` to append

public void onResize ()

This method must be called whenever the implementor's size has been modified.

public boolean remove (Widget w)

Removes a child widget.

How to Override this Method

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

Validate: Make sure this Panel is actually the parent of the child Widget; return false if it is not.
Orphan: Call orphan(Widget) first while the child Widget is still attached.
Physical Detach: Adjust the DOM to account for the removal of the child Widget. The Widget's Element must be physically removed from the DOM.
Logical Detach: Update the Panel's state variables to reflect the removal of the child Widget. Example: the Widget is removed from the Panel's WidgetCollection.

Parameters

w	the widget to be removed

Returns

true if the child was present

public void setWidgetSize (Widget widget, double size)

Updates the size of the widget passed in as long as it is not the center widget and updates the layout of the dock.

Parameters

widget	the widget that needs to update its size
size	the size to update the widget to

Protected Methods

protected Widget getCenter ()

protected double getCenterHeight ()

protected double getCenterWidth ()

protected DockLayoutPanel.Direction getResolvedDirection (DockLayoutPanel.Direction direction)

Resolve the specified direction based on the current locale. If the direction is LINE_START or LINE_END, the return value will be one of EAST or WEST depending on the RTL mode of the locale. For all other directions, the specified value is returned.

Parameters

direction	the specified direction

Returns

the locale

protected Style.Unit getUnit ()

protected void insert (Widget widget, DockLayoutPanel.Direction direction, double size, Widget before)

Adds a widget to the specified edge of the dock. If the widget is already a child of this panel, this method behaves as though remove(Widget) had already been called.

Parameters

widget	the widget to be added
direction	the widget's direction in the dock
before	the widget before which to insert the new child, or `null` to append

protected void onLoad ()

This method is called immediately after a widget becomes attached to the browser's document.

protected void onUnload ()

This method is called immediately before a widget will be detached from the browser's document.

Interfaces

Classes

Annotations

Enums

Exceptions

DockLayoutPanel

Class Overview

Example

Use in UiBinder Templates

Summary

Public Constructors

public DockLayoutPanel (Style.Unit unit)

Parameters

Public Methods

public void add (Widget widget)

Parameters

public void addEast (Widget widget, double size)

Parameters

public void addLineEnd (Widget widget, double size)

Parameters

public void addLineStart (Widget widget, double size)

Parameters

public void addNorth (Widget widget, double size)

Parameters

public void addSouth (Widget widget, double size)

Parameters

public void addWest (Widget widget, double size)

Parameters

public void animate (int duration, Layout.AnimationCallback callback)

Parameters

public void animate (int duration)

Parameters

public void forceLayout ()

public Element getWidgetContainerElement (Widget child)

Returns

public DockLayoutPanel.Direction getWidgetDirection (Widget child)

Parameters

Returns

public void insertEast (Widget widget, double size, Widget before)

Parameters

public void insertLineEnd (Widget widget, double size, Widget before)

Parameters

public void insertLineStart (Widget widget, double size, Widget before)

Parameters

public void insertNorth (Widget widget, double size, Widget before)

Parameters

public void insertSouth (Widget widget, double size, Widget before)

Parameters

public void insertWest (Widget widget, double size, Widget before)

Parameters

public void onResize ()

public boolean remove (Widget w)

Parameters

Returns

public void setWidgetSize (Widget widget, double size)

Parameters

Protected Methods

protected Widget getCenter ()

protected double getCenterHeight ()

protected double getCenterWidth ()

protected DockLayoutPanel.Direction getResolvedDirection (DockLayoutPanel.Direction direction)

Parameters

Returns

protected Style.Unit getUnit ()

protected void insert (Widget widget, DockLayoutPanel.Direction direction, double size, Widget before)

Parameters

protected void onLoad ()

protected void onUnload ()