com.google.gwt.user.client.ui
Class DockPanel

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.CellPanel
                      com.google.gwt.user.client.ui.DockPanel

All Implemented Interfaces:

EventListener, HasAlignment, HasHorizontalAlignment, HasVerticalAlignment, HasWidgets

public class DockPanel

extends CellPanel

implements HasAlignment

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.

Nested Class Summary

static class

DockPanel.DockLayoutConstant DockPanel layout constant, used in DockPanel#add(Widget, DockLayoutConstant).

Nested classes inherited from class com.google.gwt.user.client.ui.HasHorizontalAlignment

HasHorizontalAlignment.HorizontalAlignmentConstant

Nested classes inherited from class com.google.gwt.user.client.ui.HasVerticalAlignment

HasVerticalAlignment.VerticalAlignmentConstant

Field Summary

static DockPanel.DockLayoutConstant	CENTER Specifies that a widget be added at the center of the dock.
static DockPanel.DockLayoutConstant	EAST Specifies that a widget be added at the east edge of the dock.
static DockPanel.DockLayoutConstant	NORTH Specifies that a widget be added at the north edge of the dock.
static DockPanel.DockLayoutConstant	SOUTH Specifies that a widget be added at the south edge of the dock.
static DockPanel.DockLayoutConstant	WEST Specifies that a widget be added at the west edge of the dock.

Fields inherited from class java.lang.Object

typeId, typeName

Fields inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT

Fields inherited from interface com.google.gwt.user.client.ui.HasVerticalAlignment

ALIGN_BOTTOM, ALIGN_MIDDLE, ALIGN_TOP

Constructor Summary

DockPanel()
Creates an empty dock panel.

Method Summary

boolean	add(Widget w) Adds a new child widget to the panel.
boolean	add(Widget widget, DockPanel.DockLayoutConstant direction) Adds a widget to the specified edge of the dock.
HasHorizontalAlignment.HorizontalAlignmentConstant	getHorizontalAlignment() Gets the horizontal alignment.
HasVerticalAlignment.VerticalAlignmentConstant	getVerticalAlignment() Gets the vertical alignment.
protected void	onLoad() This method is called when the widget becomes attached to the browser's document.
boolean	remove(Widget w) Removes a widget from the panel.
void	setCellHeight(Widget w, String height) Sets the height of the cell associated with the given widget, related to the panel as a whole.
void	setCellHorizontalAlignment(Widget w, HasHorizontalAlignment.HorizontalAlignmentConstant align) Sets the horizontal alignment of the given widget within its cell
void	setCellVerticalAlignment(Widget w, HasVerticalAlignment.VerticalAlignmentConstant align) Sets the vertical alignment of the given widget within its cell
void	setCellWidth(Widget w, String width) Sets the width of the cell associated with the given widget, related to the panel as a whole.
void	setHorizontalAlignment(HasHorizontalAlignment.HorizontalAlignmentConstant align) Sets the horizontal alignment.
void	setVerticalAlignment(HasVerticalAlignment.VerticalAlignmentConstant align) Sets the vertical alignment.

Methods inherited from class com.google.gwt.user.client.ui.CellPanel

getSpacing, getTable, setBorderWidth, setSpacing

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

clear, getWidget, getWidgetCount, getWidgetIndex, insert, iterator

Methods inherited from class com.google.gwt.user.client.ui.Panel

adopt, disown, onAttach, onDetach

Methods inherited from class com.google.gwt.user.client.ui.Widget

getParent, isAttached, onBrowserEvent

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleName, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleName, isVisible, isVisible, removeStyleName, setElement, setHeight, setPixelSize, setSize, setStyleName, setStyleName, setVisible, setVisible, setWidth, sinkEvents, toString, unsinkEvents

Methods inherited from class java.lang.Object

equals, finalize, hashCode

Field Detail

CENTER

public static final DockPanel.DockLayoutConstant CENTER

Specifies that a widget be added at the center of the dock.

EAST

public static final DockPanel.DockLayoutConstant EAST

Specifies that a widget be added at the east edge of the dock.

NORTH

public static final DockPanel.DockLayoutConstant NORTH

Specifies that a widget be added at the north edge of the dock.

SOUTH

public static final DockPanel.DockLayoutConstant SOUTH

Specifies that a widget be added at the south edge of the dock.

WEST

public static final DockPanel.DockLayoutConstant WEST

Specifies that a widget be added at the west edge of the dock.

Constructor Detail

DockPanel

public DockPanel()

Creates an empty dock panel.

Method Detail

add

public boolean add(Widget w)

Description copied from class: Panel

Adds a new child widget to the panel.

Overrides:

add in class ComplexPanel

add

public boolean add(Widget widget,
                   DockPanel.DockLayoutConstant direction)

Adds a widget to the specified edge of the dock.

Parameters:

widget - the widget to be added

direction - the widget's direction in the dock

Returns:

true if successful (no widgets may be added after the CENTER widget)

getHorizontalAlignment

public HasHorizontalAlignment.HorizontalAlignmentConstant getHorizontalAlignment()

Description copied from interface: HasHorizontalAlignment

Gets the horizontal alignment.

Specified by:

getHorizontalAlignment in interface HasHorizontalAlignment

Returns:

the current horizontal alignment.

getVerticalAlignment

public HasVerticalAlignment.VerticalAlignmentConstant getVerticalAlignment()

Description copied from interface: HasVerticalAlignment

Gets the vertical alignment.

Specified by:

getVerticalAlignment in interface HasVerticalAlignment

Returns:

the current vertical alignment.

remove

public boolean remove(Widget w)

Description copied from class: Panel

Removes a widget from the panel.

Overrides:

remove in class ComplexPanel

setHorizontalAlignment

public void setHorizontalAlignment(HasHorizontalAlignment.HorizontalAlignmentConstant align)

Description copied from interface: HasHorizontalAlignment

Sets the horizontal alignment.

Specified by:

setHorizontalAlignment in interface HasHorizontalAlignment

Parameters:

align - the horizontal alignment ( HasHorizontalAlignment.ALIGN_LEFT, HasHorizontalAlignment.ALIGN_CENTER, or HasHorizontalAlignment.ALIGN_RIGHT).

setVerticalAlignment

public void setVerticalAlignment(HasVerticalAlignment.VerticalAlignmentConstant align)

Description copied from interface: HasVerticalAlignment

Sets the vertical alignment.

Specified by:

setVerticalAlignment in interface HasVerticalAlignment

Parameters:

align - the vertical alignment ( HasVerticalAlignment.ALIGN_TOP, HasVerticalAlignment.ALIGN_MIDDLE, or HasVerticalAlignment.ALIGN_BOTTOM).

setCellHeight

public void setCellHeight(Widget w,
                          String height)

Description copied from class: CellPanel

Sets the height of the cell associated with the given widget, related to the panel as a whole.

Specified by:

setCellHeight in class CellPanel

Parameters:

w - the widget whose cell height is to be set

height - the cell's height, in CSS units

setCellHorizontalAlignment

public void setCellHorizontalAlignment(Widget w,
                                       HasHorizontalAlignment.HorizontalAlignmentConstant align)

Description copied from class: CellPanel

Sets the horizontal alignment of the given widget within its cell

Specified by:

setCellHorizontalAlignment in class CellPanel

Parameters:

w - the widget whose horizontal alignment is to be set

align - the widget's horizontal alignment, as defined in HasHorizontalAlignment.

setCellVerticalAlignment

public void setCellVerticalAlignment(Widget w,
                                     HasVerticalAlignment.VerticalAlignmentConstant align)

Description copied from class: CellPanel

Sets the vertical alignment of the given widget within its cell

Specified by:

setCellVerticalAlignment in class CellPanel

Parameters:

w - the widget whose vertical alignment is to be set

align - the widget's vertical alignment, as defined in HasVerticalAlignment.

setCellWidth

public void setCellWidth(Widget w,
                         String width)

Description copied from class: CellPanel

Sets the width of the cell associated with the given widget, related to the panel as a whole.

Specified by:

setCellWidth in class CellPanel

Parameters:

w - the widget whose cell width is to be set

width - the cell's width, in CSS units

onLoad

protected void onLoad()

Description copied from class: Widget

This method is called when the widget becomes attached to the browser's document.

Overrides:

onLoad in class Widget