public final class

HorizontalSplitPanel

extends Panel

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

Class Overview

A panel that arranges two widgets in a single horizontal row and allows the user to interactively change the proportion of the width dedicated to each of the two widgets. Widgets contained within a HorizontalSplitPanel will be automatically decorated with scrollbars when necessary.

This widget will only work in quirks mode. If your application is in Standards Mode, use SplitLayoutPanel instead.

CSS Style Rules

.gwt-HorizontalSplitPanel { the panel itself }
.gwt-HorizontalSplitPanel hsplitter { the splitter }

Summary

Nested Classes
interface	HorizontalSplitPanel.Resources	The default resources used by this widget.

[Expand]

Inherited Constants

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

Public Constructors
	HorizontalSplitPanel()
	HorizontalSplitPanel(HorizontalSplitPanelImages images) This constructor is deprecated. replaced by `HorizontalSplitPanel(Resources)`
	HorizontalSplitPanel(HorizontalSplitPanel.Resources resources) Creates an empty horizontal split panel.

Public Methods
void	add(Widget w) Adds a widget to a pane in the HorizontalSplitPanel.
Widget	getEndOfLineWidget() Gets the widget in the pane that is at the end of the line direction for the layout.
Widget	getLeftWidget() Gets the widget in the left side of the panel.
Widget	getRightWidget() Gets the widget in the right side of the panel.
Widget	getStartOfLineWidget() Gets the widget in the pane that is at the start of the line direction for the layout.
boolean	isResizing() Indicates whether the split panel is being resized.
Iterator<Widget>	iterator()
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
boolean	remove(Widget widget) Removes a child widget.
void	setEndOfLineWidget(Widget w) Sets the widget in the pane that is at the end of the line direction for the layout.
void	setLeftWidget(Widget w) Sets the widget in the left side of the panel.
void	setRightWidget(Widget w) Sets the widget in the right side of the panel.
void	setSplitPosition(String pos) Moves the position of the splitter.
void	setStartOfLineWidget(Widget w) Sets the widget in the pane that is at the start of the line direction for the layout.

Protected Methods
Element	getElement(int index) Gets the content element for the given index.
Element	getSplitElement() Gets the element that is acting as the splitter.
Widget	getWidget(int index) Gets one of the contained widgets.
void	onEnsureDebugId(String baseID) Affected Elements: -splitter = the container containing the splitter element.
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.
final void	setWidget(int index, Widget w) Sets one of the contained widgets.

[Expand]

Inherited Methods

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

From interface java.lang.Iterable

Public Constructors

public HorizontalSplitPanel ()

public HorizontalSplitPanel (HorizontalSplitPanelImages images)

This constructor is deprecated.
replaced by HorizontalSplitPanel(Resources)

Creates an empty horizontal split panel.

Parameters

images	ImageBundle containing an image for the splitter's drag thumb

public HorizontalSplitPanel (HorizontalSplitPanel.Resources resources)

Creates an empty horizontal split panel.

Parameters

resources	ClientBundle containing an image for the splitter's drag thumb

Public Methods

public void add (Widget w)

Adds a widget to a pane in the HorizontalSplitPanel. The method will first attempt to add the widget to the left pane. If a widget is already in that position, it will attempt to add the widget to the right pane. If a widget is already in that position, an exception will be thrown, as a HorizontalSplitPanel can contain at most two widgets. Note that this method is bidi-sensitive. In an RTL environment, this method will first attempt to add the widget to the right pane, and if a widget is already in that position, it will attempt to add the widget to the left pane.

Parameters

w	the widget to be added

Throws

IllegalStateException

public Widget getEndOfLineWidget ()

Gets the widget in the pane that is at the end of the line direction for the layout. That is, in an RTL layout, gets the widget in the left pane, and in an LTR layout, gets the widget in the right pane.

Returns

the widget, null if there is not one.

public Widget getLeftWidget ()

Gets the widget in the left side of the panel.

Returns

the widget, null if there is not one.

public Widget getRightWidget ()

Gets the widget in the right side of the panel.

Returns

the widget, null if there is not one.

public Widget getStartOfLineWidget ()

Gets the widget in the pane that is at the start of the line direction for the layout. That is, in an RTL environment, gets the widget in the right pane, and in an LTR environment, gets the widget in the left pane.

Returns

the widget, null if there is not one.

public boolean isResizing ()

Indicates whether the split panel is being resized.

Returns

true if the user is dragging the splitter, false otherwise

public Iterator<Widget> iterator ()

public void onBrowserEvent (Event event)

Fired whenever a browser event is received.

Parameters

event	the event received

public boolean remove (Widget widget)

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

widget	the widget to be removed

Returns

true if the child was present

public void setEndOfLineWidget (Widget w)

Sets the widget in the pane that is at the end of the line direction for the layout. That is, in an RTL layout, sets the widget in the left pane, and in and RTL layout, sets the widget in the right pane.

Parameters

w	the widget

public void setLeftWidget (Widget w)

Sets the widget in the left side of the panel.

Parameters

w	the widget

public void setRightWidget (Widget w)

Sets the widget in the right side of the panel.

Parameters

w	the widget

public void setSplitPosition (String pos)

Moves the position of the splitter. This method is not bidi-sensitive. The size specified is always the size of the left region, regardless of directionality.

Parameters

pos	the new size of the left region in CSS units (e.g. "10px", "1em")

public void setStartOfLineWidget (Widget w)

Sets the widget in the pane that is at the start of the line direction for the layout. That is, in an RTL layout, sets the widget in the right pane, and in and RTL layout, sets the widget in the left pane.

Parameters

w	the widget

Protected Methods

protected Element getElement (int index)

Gets the content element for the given index.

Parameters

index	the index of the element, only 0 and 1 are valid.

Returns

the element

protected Element getSplitElement ()

Gets the element that is acting as the splitter.

Returns

the element

protected Widget getWidget (int index)

Gets one of the contained widgets.

Parameters

index	the index of the widget, only 0 and 1 are valid.

Returns

the widget

protected void onEnsureDebugId (String baseID)

Affected Elements:

-splitter = the container containing the splitter element.
-right = the container on the right side of the splitter.
-left = the container on the left side of the splitter.

Parameters

baseID	the base ID used by the main element

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.

protected final void setWidget (int index, Widget w)

Sets one of the contained widgets.

Parameters

index	the index, only 0 and 1 are valid
w	the widget

Interfaces

Classes

Annotations

Enums

Exceptions

HorizontalSplitPanel

Class Overview

CSS Style Rules

See Also

Summary

Public Constructors

public HorizontalSplitPanel ()

public HorizontalSplitPanel (HorizontalSplitPanelImages images)

Parameters

public HorizontalSplitPanel (HorizontalSplitPanel.Resources resources)

Parameters

Public Methods

public void add (Widget w)

Parameters

Throws

public Widget getEndOfLineWidget ()

Returns

public Widget getLeftWidget ()

Returns

public Widget getRightWidget ()

Returns

public Widget getStartOfLineWidget ()

Returns

public boolean isResizing ()

Returns

public Iterator<Widget> iterator ()

public void onBrowserEvent (Event event)

Parameters

public boolean remove (Widget widget)

Parameters

Returns

public void setEndOfLineWidget (Widget w)

Parameters

public void setLeftWidget (Widget w)

Parameters

public void setRightWidget (Widget w)

Parameters

public void setSplitPosition (String pos)

Parameters

public void setStartOfLineWidget (Widget w)

Parameters

Protected Methods

protected Element getElement (int index)

Parameters

Returns

protected Element getSplitElement ()

Returns

protected Widget getWidget (int index)

Parameters

Returns

protected void onEnsureDebugId (String baseID)

Parameters

See Also

protected void onLoad ()

protected void onUnload ()

protected final void setWidget (int index, Widget w)

Parameters