com.sencha.gxt.widget.core.client.container
Class Viewport
public class Viewport extends SimpleContainer
A LayoutContainer that fills the browser window and monitors window resizing. Viewports are best used for applications that will fill the browser without window scrolling. Children of the viewport can allow scrolling.
public void onModuleLoad() {
Viewport viewport = new Viewport();
viewport.setWidget(new ContentPanel(), new MarginData(10));
RootPanel.get().add(viewport);
}
The viewport is not added to the root panel automatically. Is is not
necessary to call ResizeContainer.forceLayout() after adding the viewport to the
RootPanel. Layout will be called after being added to the root panel.
| Modifier and Type | Class and Description |
|---|---|
static interface |
Viewport.ViewportAppearance |
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabledHasWidgets.ForIsWidgetIndexedPanel.ForIsWidgetDEBUG_ID_PREFIX| Constructor and Description |
|---|
Viewport()
Creates a viewport layout container with the default appearance.
|
Viewport(Viewport.ViewportAppearance appearance)
Creates a viewport layout container with the specified appearance.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
getEnableScroll()
Returns true if window scrolling is enabled.
|
boolean |
isTouchKeyboardAdjustPan()
Returns true if the viewport is enabled to adjust for a touch keyboard by panning.
|
void |
setEnableScroll(boolean enableScroll)
Sets whether window scrolling is enabled.
|
void |
setTouchKeyboardAdjustPan(boolean touchKeyboardAdjustPan)
This setting controls how the
Viewport responds to a touch device on-screen soft keyboard. |
add, add, getWidget, isResize, setResize, setWidget, setWidgetforceLayout, isLayoutRunning, isOrWasLayoutRunning, onResizeadd, addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, clear, disable, enable, findWidget, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, remove, remove, removeaddBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disableEvents, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, onBrowserEvent, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmaskaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toStringpublic Viewport()
public Viewport(Viewport.ViewportAppearance appearance)
appearance - the appearance of the viewport layout containerpublic boolean getEnableScroll()
public boolean isTouchKeyboardAdjustPan()
public void setEnableScroll(boolean enableScroll)
enableScroll - true to enable window scrollingpublic void setTouchKeyboardAdjustPan(boolean touchKeyboardAdjustPan)
This setting controls how the Viewport responds to a touch device on-screen soft keyboard.
Some devices, such as iOS, will automatically pan content to make the current focus visible when part of the viewport is covered by the soft keyboard. Others, such as Android, will resize the viewport smaller to make room for the soft keyboard.
If set to true, this instructs the Viewport to mimic pan adjustments if the touch
device triggers a resize in response to the on-screen soft keyboard. The default value is false.
PLEASE NOTE: This setting has no effect on devices that automatically pan content in response to the
on-screen soft keyboard. A value of false will not cause such devices to resize —
they will always pan regardless.
touchKeyboardAdjustPan - true to enable the viewport to adjust by panningCopyright © 2016. All rights reserved.