com.sencha.gxt.widget.core.client.container

Class HorizontalLayoutContainer

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.container.Container

com.sencha.gxt.widget.core.client.container.ResizeContainer

com.sencha.gxt.widget.core.client.container.InsertResizeContainer

com.sencha.gxt.widget.core.client.container.HorizontalLayoutContainer

All Implemented Interfaces:

HasScrollSupport, HasLayout, AddEvent.HasAddHandlers, BeforeAddEvent.HasBeforeAddHandlers, BeforeHideEvent.HasBeforeHideHandlers, BeforeRemoveEvent.HasBeforeRemoveHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, ContainerHandler.HasContainerHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, RemoveEvent.HasRemoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

public class HorizontalLayoutContainer
extends InsertResizeContainer
implements HasScrollSupport

A layout container that lays out its children in a single row. The layout properties for each child are specified using HorizontalLayoutContainer.HorizontalLayoutData.

Code Snippet:

    HorizontalLayoutContainer c = new HorizontalLayoutContainer();
    HorizontalLayoutData layoutData = new HorizontalLayoutData(100, 100, new Margins(5));
    c.add(new TextButton("Button 1"), layoutData);
    c.add(new TextButton("Button 2"), layoutData);
    c.add(new TextButton("Button 3"), layoutData);
    RootPanel.get().add(c);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HorizontalLayoutContainer.HorizontalLayoutData Specifies parameters that control the layout of the widget in the container.

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.container.ResizeContainer

forceLayoutCommand, forceLayoutOnResize, hadLayoutRunning, layoutCommand, layoutRequiredThisEventLoop, layoutRunning

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
HorizontalLayoutContainer() Creates a horizontal layout container.

Method Summary

Modifier and Type	Method and Description
void	add(IsWidget child, HorizontalLayoutContainer.HorizontalLayoutData layoutData) Adds a widget to the horizontal layout container with the specified layout parameters.
HandlerRegistration	addScrollHandler(ScrollHandler handler)
protected void	doLayout()
ScrollSupport.ScrollMode	getScrollMode() Returns the scroll mode from the container's ScrollSupport instance.
ScrollSupport	getScrollSupport() Returns the scroll support instance.
void	insert(IsWidget w, int beforeIndex, HorizontalLayoutContainer.HorizontalLayoutData layoutData) Inserts the widget at the specified index in the horizontal layout container.
boolean	isAdjustForScroll() Returns true if the container reserves space for the scroll bar.
protected void	onInsert(int index, Widget child)
void	setAdjustForScroll(boolean adjustForScroll) True to request that the container reserve space for the scroll bar (defaults to false).
void	setScrollMode(ScrollSupport.ScrollMode scrollMode) Sets the scroll mode on the container's ScrollSupport instance.
void	setScrollSupport(ScrollSupport support) Sets the scroll support.

Methods inherited from class com.sencha.gxt.widget.core.client.container.InsertResizeContainer

insert, insert

Methods inherited from class com.sencha.gxt.widget.core.client.container.ResizeContainer

applyLayout, applyLayout, forceLayout, forceLayoutOnChildren, forceLayoutOnChildren, getLeftRightMargins, getParentLayoutWidget, getSideMargins, getTopBottomMargins, isLayoutRunning, isOrWasLayoutRunning, isWidgetVisible, onBeforeDoLayout, onLoad, onResize, onResize

Methods inherited from class com.sencha.gxt.widget.core.client.container.Container

add, add, addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, adjustIndex, adopt, checkIndexBoundsForInsertion, clear, disable, doAttachChildren, doDetachChildren, doPhysicalAttach, doPhysicalDetach, enable, ensureGroupingHandlerRegistration, findWidget, getChildren, getContainerTarget, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, onRemove, onWidgetHide, onWidgetShow, orphan, remove, remove, remove

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disableContextMenu, disableEvents, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onAttach, onBlur, onBrowserEvent, onDetach, onDisable, onEnable, onFocus, onHide, onHideContextMenu, onPosition, onRightClick, onShow, onShowContextMenu, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HorizontalLayoutContainer

public HorizontalLayoutContainer()

Creates a horizontal layout container.

Method Detail

add

public void add(IsWidget child,
                HorizontalLayoutContainer.HorizontalLayoutData layoutData)

Adds a widget to the horizontal layout container with the specified layout parameters.

Parameters:

child - the widget to add to the layout container

layoutData - the parameters that describe how to lay out the widget

addScrollHandler

public HandlerRegistration addScrollHandler(ScrollHandler handler)

getScrollMode

public ScrollSupport.ScrollMode getScrollMode()

Returns the scroll mode from the container's ScrollSupport instance.

Returns:

the scroll mode

getScrollSupport

public ScrollSupport getScrollSupport()

Description copied from interface: HasScrollSupport

Returns the scroll support instance.

Specified by:

getScrollSupport in interface HasScrollSupport

Returns:

the scroll support instance

insert

public void insert(IsWidget w,
                   int beforeIndex,
                   HorizontalLayoutContainer.HorizontalLayoutData layoutData)

Inserts the widget at the specified index in the horizontal layout container.

Parameters:

w - the widget to insert in the layout container

beforeIndex - the insert index

layoutData - the parameters that describe how to lay out the widget

isAdjustForScroll

public boolean isAdjustForScroll()

Returns true if the container reserves space for the scroll bar.

Returns:

true if the container reserves space for the scroll bar

setAdjustForScroll

public void setAdjustForScroll(boolean adjustForScroll)

True to request that the container reserve space for the scroll bar (defaults to false).

Parameters:

adjustForScroll - true to reserve space for the scroll bar

setScrollMode

public void setScrollMode(ScrollSupport.ScrollMode scrollMode)

Sets the scroll mode on the container's ScrollSupport instance. The scroll mode will not be preserved if setScrollSupport(ScrollSupport) is called AFTER calling this method.

Parameters:

scrollMode - the scroll mode

setScrollSupport

public void setScrollSupport(ScrollSupport support)

Description copied from interface: HasScrollSupport

Sets the scroll support.

Specified by:

setScrollSupport in interface HasScrollSupport

Parameters:

support - the scroll support

doLayout

protected void doLayout()

Specified by:

doLayout in class ResizeContainer

onInsert

protected void onInsert(int index,
                        Widget child)

Overrides:

onInsert in class Container