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

Class HBoxLayoutContainer

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

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

All Implemented Interfaces:

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, OverflowEvent.HasOverflowHandlers, RemoveEvent.HasRemoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

Direct Known Subclasses:

ToolBar

public class HBoxLayoutContainer
extends BoxLayoutContainer
implements OverflowEvent.HasOverflowHandlers

A layout container for horizontal rows of widgets. Provides support for automatic overflow (i.e. when there are too many widgets to display in the available width -- see setEnableOverflow(boolean)).

Code Snippet:

    HBoxLayoutContainer c = new HBoxLayoutContainer();
    c.setHBoxLayoutAlign(HBoxLayoutAlign.TOP);
    BoxLayoutData layoutData = new BoxLayoutData(new Margins(5, 0, 0, 5));
    c.add(new TextButton("Button 1"), layoutData);
    c.add(new TextButton("Button 2"), layoutData);
    c.add(new TextButton("Button 3"), layoutData);
    Viewport v = new Viewport();
    v.add(c);
    RootPanel.get().add(v);
 

See Also:

ToolBar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HBoxLayoutContainer.HBoxLayoutAlign The vertical alignment of the horizontal widgets.
static interface	HBoxLayoutContainer.HBoxLayoutContainerAppearance

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.container.BoxLayoutContainer

BoxLayoutContainer.BoxLayoutContainerAppearance, BoxLayoutContainer.BoxLayoutData, BoxLayoutContainer.BoxLayoutPack

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	hasOverflow
protected List<Widget>	hiddens
protected TextButton	more
protected Menu	moreMenu

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

Modifier	Constructor and Description
	HBoxLayoutContainer() Creates a new HBoxlayout.
	HBoxLayoutContainer(HBoxLayoutContainer.HBoxLayoutAlign align) Creates a new HBoxlayout.
protected	HBoxLayoutContainer(HBoxLayoutContainer.HBoxLayoutAlign align, HBoxLayoutContainer.HBoxLayoutContainerAppearance appearance)
	HBoxLayoutContainer(HBoxLayoutContainer.HBoxLayoutContainerAppearance appearance) Creates a new HBoxlayout.

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addOverflowHandler(OverflowEvent.OverflowHandler handler) Adds a OverflowEvent handler.
protected void	addWidgetToMenu(Menu menu, Widget w)
protected void	clearMenu()
protected void	doLayout()
HBoxLayoutContainer.HBoxLayoutContainerAppearance	getAppearance() Returns the horizontal layout appearance.
HBoxLayoutContainer.HBoxLayoutAlign	getHBoxLayoutAlign() Returns the horizontal alignment.
protected int	getWidgetWidth(Widget widget)
protected void	hideComponent(Widget w)
protected void	initMore()
boolean	isEnableOverflow() Returns true if overflow is enabled.
protected boolean	isHidden(Widget w)
protected void	onInsert(int index, Widget child)
protected void	onOverflow()
protected void	onRemove(Widget child)
protected void	onUnoverflow()
void	setEnableOverflow(boolean enableOverflow) True to show a drop down icon when the available width is less than the required width (defaults to true).
void	setHBoxLayoutAlign(HBoxLayoutContainer.HBoxLayoutAlign hBoxLayoutAlign) Sets the vertical alignment for child items (defaults to TOP).
protected void	unhideComponent(Widget w)

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

add, getContainerTarget, getPack, getPadding, getScrollOffset, insert, isAdjustForFlexRemainder, setAdjustForFlexRemainder, setPack, setPadding, setScrollOffset

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, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, 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

Field Detail

hiddens

protected List<Widget> hiddens

hasOverflow

protected boolean hasOverflow

more

protected TextButton more

moreMenu

protected Menu moreMenu

Constructor Detail

HBoxLayoutContainer

public HBoxLayoutContainer()

Creates a new HBoxlayout.

HBoxLayoutContainer

public HBoxLayoutContainer(HBoxLayoutContainer.HBoxLayoutContainerAppearance appearance)

Creates a new HBoxlayout.

Parameters:

appearance - the hbox appearance

HBoxLayoutContainer

public HBoxLayoutContainer(HBoxLayoutContainer.HBoxLayoutAlign align)

Creates a new HBoxlayout.

Parameters:

align - the horizontal alignment

HBoxLayoutContainer

protected HBoxLayoutContainer(HBoxLayoutContainer.HBoxLayoutAlign align,
                              HBoxLayoutContainer.HBoxLayoutContainerAppearance appearance)

Method Detail

addOverflowHandler

public HandlerRegistration addOverflowHandler(OverflowEvent.OverflowHandler handler)

Description copied from interface: OverflowEvent.HasOverflowHandlers

Adds a OverflowEvent handler.

Specified by:

addOverflowHandler in interface OverflowEvent.HasOverflowHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

getAppearance

public HBoxLayoutContainer.HBoxLayoutContainerAppearance getAppearance()

Returns the horizontal layout appearance.

Overrides:

getAppearance in class BoxLayoutContainer

Returns:

the appearance

getHBoxLayoutAlign

public HBoxLayoutContainer.HBoxLayoutAlign getHBoxLayoutAlign()

Returns the horizontal alignment.

Returns:

the horizontal alignment

isEnableOverflow

public boolean isEnableOverflow()

Returns true if overflow is enabled.

Returns:

the overflow state

setEnableOverflow

public void setEnableOverflow(boolean enableOverflow)

True to show a drop down icon when the available width is less than the required width (defaults to true).

Parameters:

enableOverflow - true to enable overflow support

setHBoxLayoutAlign

public void setHBoxLayoutAlign(HBoxLayoutContainer.HBoxLayoutAlign hBoxLayoutAlign)

Sets the vertical alignment for child items (defaults to TOP).

Parameters:

hBoxLayoutAlign - the vertical alignment

addWidgetToMenu

protected void addWidgetToMenu(Menu menu,
                               Widget w)

clearMenu

protected void clearMenu()

doLayout

protected void doLayout()

Specified by:

doLayout in class ResizeContainer

getWidgetWidth

protected int getWidgetWidth(Widget widget)

hideComponent

protected void hideComponent(Widget w)

initMore

protected void initMore()

isHidden

protected boolean isHidden(Widget w)

onInsert

protected void onInsert(int index,
                        Widget child)

Overrides:

onInsert in class Container

onRemove

protected void onRemove(Widget child)

Overrides:

onRemove in class BoxLayoutContainer

onOverflow

protected void onOverflow()

onUnoverflow

protected void onUnoverflow()

unhideComponent

protected void unhideComponent(Widget w)