com.extjs.gxt.ui.client.widget.custom
Class Portal

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.Container<T>
                      extended by com.extjs.gxt.ui.client.widget.ScrollContainer<LayoutContainer>
                          extended by com.extjs.gxt.ui.client.widget.custom.Portal
All Implemented Interfaces:
Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class Portal
extends ScrollContainer<LayoutContainer>

A Portal container of Portlets. It is required that setColumnWidth(int, double) be called for each column prior to rendering.

Events:
ValidateDrop : PortalEvent(portal, startColumn, startRow, column, row)
Fires before a dragged portlet can be inserted into a new location.
Drop : PortalEvent(portal, startColumn, startRow, column, row)
Fires after a portlet has been moved.
Inherited Events:
Container BeforeAdd
Container Add
Container BeforeRemove
Container Remove
BoxComponent Move
BoxComponent Resize
Component Enable
Component Disable
Component BeforeHide
Component Hide
Component BeforeShow
Component Show
Component Attach
Component Detach
Component BeforeRender
Component Render
Component BrowserEvent
Component BeforeStateRestore
Component StateRestore
Component BeforeStateSave
Component SaveState


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Container
attachChildren, enableLayout, layoutExecuted, layoutNeeded, layoutOnAttach, layoutOnChange
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
Portal(int numColumns)
          Creates a new portal container.
 
Method Summary
 void add(Portlet portlet, int column)
          Adds a portlet to the portal.
protected  DragListener createDragListener()
           
 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.
 ScrollSupport getScrollSupport()
          Returns the scroll support instance.
 int getSpacing()
          Returns the spacing between portlets.
 void insert(Portlet portlet, int index, int column)
          Inserts a portlet.
 boolean isAutoScroll()
          Returns true if auto scroll is enabled (defaults to true).
protected  void onDragCancel(DragEvent event)
           
protected  void onDragEnd(DragEvent de)
           
protected  void onDragLeave(DragEvent de)
           
protected  void onDragMove(DragEvent de)
           
protected  void onDragStart(DragEvent de)
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
 void remove(Portlet portlet, int column)
          Removes a portlet from the portal.
 void setAdjustForScroll(boolean adjust)
          True to adjust the layout for a vertical scroll bar (defaults to true).
 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.extjs.gxt.ui.client.widget.ScrollContainer
addScrollListener, afterRender, getHScrollPosition, getScrollMode, getVScrollPosition, onComponentEvent, removeScrollListener, scrollIntoView, setHScrollPosition, setScrollMode, setVScrollPosition
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Container
add, adjustIndex, adopt, createContainerEvent, disable, doAttachChildren, doDetachChildren, doLayout, doLayout, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getLayout, getLayoutTarget, getWidget, indexOf, insert, isLayoutNeeded, iterator, layout, layout, notifyHide, notifyShow, onAfterLayout, onAttach, onBeforeLayoutExcecuted, onInsert, onLayoutExcecuted, onRemove, orphan, remove, remove, removeAll, removeAll, scrollIntoView, setLayout, setLayoutNeeded, setLayoutOnChange, wrapWidget
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, createComponentEvent, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onResize, onShow, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disableContextMenu, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, onBrowserEvent, onDetach, onDetachHelper, onDisable, onEnable, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Portal

public Portal(int numColumns)
Creates a new portal container.

Parameters:
numColumns - the number of columns
Method Detail

add

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

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

getScrollSupport

public ScrollSupport getScrollSupport()
Returns the scroll support instance.

Returns:
the scroll support

getSpacing

public int getSpacing()
Returns the spacing between portlets.

Returns:
the spacing the spacing in pixels

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

setAdjustForScroll

public void setAdjustForScroll(boolean adjust)
True to adjust the layout for a vertical scroll bar (defaults to true).

Parameters:
adjust - true to adjust

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:
ScrollSupport

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

createDragListener

protected DragListener createDragListener()

onDragCancel

protected void onDragCancel(DragEvent event)

onDragEnd

protected void onDragEnd(DragEvent de)

onDragLeave

protected void onDragLeave(DragEvent de)

onDragMove

protected void onDragMove(DragEvent de)

onDragStart

protected void onDragStart(DragEvent de)

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class Component
Parameters:
target - the target element
index - the insert location