com.extjs.gxt.ui.client.widget
Class ScrollContainer<T extends Component>

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.Container<T>
                      com.extjs.gxt.ui.client.widget.ScrollContainer<T>

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

Direct Known Subclasses:

LayoutContainer, Portal

public class ScrollContainer<T extends Component>
extends Container<T>

A Container that scrolls its contents. The container is created with scrolling disabled.

Events:

Scroll : ComponentEvent(component)

Fires when the container is scrolled.

• component : this

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, dummy, 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

ScrollContainer()

Method Summary

void	addScrollListener(ScrollListener listener) Adds a listener to receive scroll events.
protected void	afterRender() Called after the component has been rendered and is attached for the first time.
int	getHScrollPosition() Returns the horizontal scroll position.
Style.Scroll	getScrollMode() Returns the scroll model.
int	getVScrollPosition() Returns the vertical scroll position.
void	onComponentEvent(ComponentEvent ce) Any events a component receives will be forwarded to this method.
void	removeScrollListener(ScrollListener listener) Removes a previously added listener.
void	scrollIntoView(com.google.gwt.user.client.ui.Widget child) Scroll the child into view.
void	setHScrollPosition(int position) Sets the horizontal scroll position.
void	setScrollMode(Style.Scroll scroll) Sets the container's scroll mode.
void	setVScrollPosition(int position) Sets the vertical scroll position.

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, onRender, 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, resolvePotentialElement, 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

ScrollContainer

public ScrollContainer()

Method Detail

addScrollListener

public void addScrollListener(ScrollListener listener)

Adds a listener to receive scroll events.

Parameters:

listener - the listener to be added

getHScrollPosition

public int getHScrollPosition()

Returns the horizontal scroll position.

Returns:

the horizontal scroll position

getScrollMode

public Style.Scroll getScrollMode()

Returns the scroll model.

Returns:

the scroll mode

getVScrollPosition

public int getVScrollPosition()

Returns the vertical scroll position.

Returns:

the vertical scroll position

onComponentEvent

public void onComponentEvent(ComponentEvent ce)

Description copied from class: Component

Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:

onComponentEvent in class Component

Parameters:

ce - the base event

removeScrollListener

public void removeScrollListener(ScrollListener listener)

Removes a previously added listener.

Parameters:

listener - the listener to be removed

scrollIntoView

public void scrollIntoView(com.google.gwt.user.client.ui.Widget child)

Scroll the child into view.

Parameters:

child - the child widget

setHScrollPosition

public void setHScrollPosition(int position)

Sets the horizontal scroll position.

Parameters:

position - the new horizontal scroll position

setScrollMode

public void setScrollMode(Style.Scroll scroll)

Sets the container's scroll mode.

Parameters:

scroll - the scroll mode

setVScrollPosition

public void setVScrollPosition(int position)

Sets the vertical scroll position.

Parameters:

position - the new horizontal scroll position, in pixels

afterRender

protected void afterRender()

Description copied from class: Component

Called after the component has been rendered and is attached for the first time. At this time, the component will be part of the DOM which is required when retrieving location and offsets.

Overrides:

afterRender in class BoxComponent