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

Class PortalLayoutContainer

java.lang.Object

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

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

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

All Implemented Interfaces:

HasScrollHandlers, HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, InsertPanel, InsertPanel.ForIsWidget, IsWidget, ProvidesResize, RequiresResize, 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, PortalDropEvent.HasPortalDropHandlers, PortalValidateDropEvent.HasPortalValidateDropHandlers, RemoveEvent.HasRemoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId, Iterable<Widget>

public class PortalLayoutContainer
extends CssFloatLayoutContainer
implements PortalValidateDropEvent.HasPortalValidateDropHandlers, PortalDropEvent.HasPortalDropHandlers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PortalLayoutContainer.PortalLayoutAppearance

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

CssFloatLayoutContainer.CssFloatData, CssFloatLayoutContainer.CssFloatLayoutAppearance

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

InsertPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

HasWidgets.ForIsWidget

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
PortalLayoutContainer(int numColumns)
PortalLayoutContainer(PortalLayoutContainer.PortalLayoutAppearance appearance, int numColumns)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Portlet portlet, int column) Adds a portlet to the portal.
HandlerRegistration	addDropHandler(PortalDropEvent.PortalDropHandler handler) Adds a PortalDropEvent.PortalDropHandler handler for PortalDropEvent events.
HandlerRegistration	addValidateDropHandler(PortalValidateDropEvent.PortalValidateDropHandler handler) Adds a PortalValidateDropEvent.PortalValidateDropHandler handler for PortalValidateDropEvent events.
AutoScrollSupport	getAutoScrollSupport() Returns the scroll support instance.
int	getColumnCount()
int	getPortletColumn(Portlet portlet) Returns the column of the given porlet.
int	getPortletIndex(Portlet portlet) Returns the index of the column for the given portlet.
int	getSpacing() Returns the spacing between portlets.
VerticalLayoutContainer	getWidget(int index)
void	insert(IsWidget w, int beforeIndex)
void	insert(IsWidget w, int beforeIndex, CssFloatLayoutContainer.CssFloatData layoutData)
void	insert(Portlet portlet, int index, int column) Inserts a portlet.
boolean	isAutoScroll() Returns true if auto scroll is enabled (defaults to true).
void	remove(Portlet portlet, int column) Removes a portlet from the portal.
void	setAutoScroll(boolean autoScroll) True to automatically scroll the portal container when the user hovers over the top and bottom of the container (defaults to true).
void	setColumnWidth(int colIndex, double width) Sets the column's width.
void	setSpacing(int spacing) Sets the spacing between portlets (defaults to 10).

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

add, addScrollHandler, getScrollSupport, getStyleFloat, isAdjustForScroll, setAdjustForScroll, setScrollSupport, setStyleFloat

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

insert

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

forceLayout, isLayoutRunning, isOrWasLayoutRunning, onResize

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

add, add, addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, clear, disable, enable, findWidget, getItemByItemId, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, 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, addStyleOnOver, clearSizeCache, disableEvents, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getStateId, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, onBrowserEvent, removeHandler, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel

add

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

getWidgetCount, getWidgetIndex, remove

Constructor Detail

PortalLayoutContainer

@UiConstructor
public PortalLayoutContainer(int numColumns)

PortalLayoutContainer

public PortalLayoutContainer(PortalLayoutContainer.PortalLayoutAppearance appearance,
                     int numColumns)

Method Detail

getAutoScrollSupport

public AutoScrollSupport getAutoScrollSupport()

Returns the scroll support instance.

Returns:

the scroll support

add

@UiChild(tagname="portlet")
public void add(Portlet portlet,
                      int column)

Adds a portlet to the portal.

Parameters:

portlet - the portlet to add

column - the column to insert into

addValidateDropHandler

public HandlerRegistration addValidateDropHandler(PortalValidateDropEvent.PortalValidateDropHandler handler)

Description copied from interface: PortalValidateDropEvent.HasPortalValidateDropHandlers

Adds a PortalValidateDropEvent.PortalValidateDropHandler handler for PortalValidateDropEvent events.

Specified by:

addValidateDropHandler in interface PortalValidateDropEvent.HasPortalValidateDropHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

addDropHandler

public HandlerRegistration addDropHandler(PortalDropEvent.PortalDropHandler handler)

Description copied from interface: PortalDropEvent.HasPortalDropHandlers

Adds a PortalDropEvent.PortalDropHandler handler for PortalDropEvent events.

Specified by:

addDropHandler in interface PortalDropEvent.HasPortalDropHandlers

Parameters:

handler - the handler

Returns:

the registration for the event

getColumnCount

public int getColumnCount()

getPortletColumn

public int getPortletColumn(Portlet portlet)

Returns the column of the given porlet.

Parameters:

portlet - the portlet

Returns:

the column or -1 if not found

getPortletIndex

public int getPortletIndex(Portlet portlet)

Returns the index of the column for the given portlet.

Parameters:

portlet - the portlet

Returns:

the index or -1 if not found

getSpacing

public int getSpacing()

Returns the spacing between portlets.

Returns:

the spacing the spacing in pixels

getWidget

public VerticalLayoutContainer getWidget(int index)

Specified by:

getWidget in interface IndexedPanel

Overrides:

getWidget in class Container

insert

public void insert(IsWidget w,
          int beforeIndex)

Specified by:

insert in interface InsertPanel.ForIsWidget

Overrides:

insert in class InsertResizeContainer

insert

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

Overrides:

insert in class CssFloatLayoutContainer

insert

public void insert(Portlet portlet,
          int index,
          int column)

Inserts a portlet.

Parameters:

portlet - the portlet to add

index - the insert index

column - the column to insert into

isAutoScroll

public boolean isAutoScroll()

Returns true if auto scroll is enabled (defaults to true).

Returns:

true if auto scroll enabled

remove

public void remove(Portlet portlet,
          int column)

Removes a portlet from the portal.

Parameters:

portlet - the porlet to remove

column - the column

setAutoScroll

public void setAutoScroll(boolean autoScroll)

True to automatically scroll the portal container when the user hovers over the top and bottom of the container (defaults to true).

Parameters:

autoScroll - true to enable auto scroll

See Also:

AutoScrollSupport

setColumnWidth

public void setColumnWidth(int colIndex,
                  double width)

Sets the column's width.

Parameters:

colIndex - the column index

width - the column width

setSpacing

public void setSpacing(int spacing)

Sets the spacing between portlets (defaults to 10).

Parameters:

spacing - the spacing in pixels