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

Class CssFloatLayoutContainer

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

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 CssFloatLayoutContainer
extends InsertResizeContainer
implements HasScrollSupport

A layout container that uses the CSS float style to enable widgets to float around other widgets.

Code Snippet:

    CssFloatLayoutContainer c = new CssFloatLayoutContainer();
    HTML rectangle = new HTML("I'm a Red
Rectangle");
    Label text = new Label("This text will flow around the Red Rectangle because that's the way things work in CssFloatLayoutContainer. You may need to resize the browser window to see the effect.");
    c.add(rectangle, new CssFloatData(100));
    c.add(text);
    rectangle.getElement().getStyle().setBackgroundColor("red");
    text.getElement().getStyle().setFloat(Float.NONE);
    text.getElement().getStyle().setDisplay(Display.INLINE);
    Viewport v = new Viewport();
    v.add(c);
    RootPanel.get().add(v);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CssFloatLayoutContainer.CssFloatData Specifies widget layout parameters that control the size of the widget.
static interface	CssFloatLayoutContainer.CssFloatLayoutAppearance

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	adjustForScroll

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
CssFloatLayoutContainer() Creates a CSS float layout container with the default appearance.
CssFloatLayoutContainer(CssFloatLayoutContainer.CssFloatLayoutAppearance appearance) Creates a CSS float layout container with the specified appearance.

Method Summary

Modifier and Type	Method and Description
void	add(IsWidget child, CssFloatLayoutContainer.CssFloatData layoutData) Adds a widget to the CSS float layout container with the specified layout parameters.
HandlerRegistration	addScrollHandler(ScrollHandler handler)
protected void	doLayout()
protected XElement	getContainerTarget()
ScrollSupport.ScrollMode	getScrollMode() Returns the scroll mode from the container's ScrollSupport instance.
ScrollSupport	getScrollSupport() Returns the scroll support instance.
Style.Float	getStyleFloat() Returns the value of the CSS float property.
void	insert(IsWidget w, int beforeIndex, CssFloatLayoutContainer.CssFloatData layoutData) Inserts the widget at the specified index in the CSS float layout container.
boolean	isAdjustForScroll() Returns true if adjust for scroll is enabled.
protected void	onInsert(int index, Widget child)
protected void	onRemove(Widget child)
void	setAdjustForScroll(boolean adjustForScroll) True to adjust the container width calculations to account 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.
void	setStyleFloat(Style.Float styleFloat) Sets the value of the CSS float property.

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

adjustForScroll

protected boolean adjustForScroll

Constructor Detail

CssFloatLayoutContainer

public CssFloatLayoutContainer()

Creates a CSS float layout container with the default appearance.

CssFloatLayoutContainer

public CssFloatLayoutContainer(CssFloatLayoutContainer.CssFloatLayoutAppearance appearance)

Creates a CSS float layout container with the specified appearance.

Parameters:

appearance - the appearance of the CSS float layout container

Method Detail

add

public void add(IsWidget child,
                CssFloatLayoutContainer.CssFloatData layoutData)

Adds a widget to the CSS float 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

getStyleFloat

public Style.Float getStyleFloat()

Returns the value of the CSS float property.

Returns:

the value of the CSS float property

insert

public void insert(IsWidget w,
                   int beforeIndex,
                   CssFloatLayoutContainer.CssFloatData layoutData)

Inserts the widget at the specified index in the CSS float 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 adjust for scroll is enabled.

Returns:

the adjust for scroll state

setAdjustForScroll

public void setAdjustForScroll(boolean adjustForScroll)

True to adjust the container width calculations to account for the scroll bar (defaults to false).

Parameters:

adjustForScroll - the adjust for scroll state

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

setStyleFloat

public void setStyleFloat(Style.Float styleFloat)

Sets the value of the CSS float property.

Parameters:

styleFloat - the value of the CSS float property

doLayout

protected void doLayout()

Specified by:

doLayout in class ResizeContainer

getContainerTarget

protected XElement getContainerTarget()

Overrides:

getContainerTarget in class Container

onInsert

protected void onInsert(int index,
                        Widget child)

Overrides:

onInsert in class Container

onRemove

protected void onRemove(Widget child)

Overrides:

onRemove in class Container