com.sencha.gxt.widget.core.client

Class Popup

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

com.sencha.gxt.widget.core.client.Popup

All Implemented Interfaces:

HasGestureRecognizers, 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 Popup
extends SimpleContainer

A panel that can be displayed over other widgets.

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	alignElem
protected int	alignOffsetX
protected int	alignOffsetY
protected Point	alignPoint
protected Style.AnchorAlignment	alignPos
protected boolean	animate
protected boolean	autoFocus
protected boolean	autoHide
protected boolean	constrainViewport
protected Style.AnchorAlignment	defaultAlign
protected BaseEventPreview	preview
protected int	xOffset
protected int	yOffset

Fields inherited from class com.sencha.gxt.widget.core.client.container.SimpleContainer

logger, resize, widget

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.container.Container

children, widgetMap

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, contextMenu, contextMenuGestureRecognizer, dataMap, deferHeight, disableContextMenu, disabled, disabledStyle, disableEvents, ensureVisibilityOnSizing, focusManagerSupport, gestureRecognizers, height, hidden, hideMode, itemId, lastSize, layer, left, mask, maskMessage, monitorWindowResize, overElements, pageX, pageY, resizeHandler, shadow, shadowPosition, shim, stateful, stateId, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
Popup() Creates a new popup panel.

Method Summary

Modifier and Type	Method and Description
protected void	afterHide()
protected void	afterShow()
void	center() Centers the panel within the viewport.
Style.AnchorAlignment	getDefaultAlign() Returns the default alignment.
CompositeElement	getIgnoreList() Any elements added to this list will be ignored when auto close is enabled.
int	getXOffset() Returns the x offset.
int	getYOffset() Returns the y offsets.
void	hide() Hides the popup.
boolean	isAnimate() Returns true if animations are enabled.
boolean	isAutoFocus() Returns true if auto focus is enabled.
boolean	isAutoHide() Returns true if auto hide is enabled.
boolean	isConstrainViewport() Returns true if constrain to viewport is enabled.
protected void	onAfterFirstAttach() Called immediately after the first time the widget becomes attached to the browser's document only the first time.
protected boolean	onAutoHide(Event event) Subclasses may override to cancel the hide from an auto hide.
protected void	onDetach()
protected Popup	onShowPopup()
void	setAnimate(boolean animate) True to enable animations when showing and hiding (defaults to false).
void	setAutoFocus(boolean autoFocus) True to move focus to the popup when being opened (defaults to true).
void	setAutoHide(boolean autoHide) True to close the popup when the user clicks outside of the menu (default to true).
void	setConstrainViewport(boolean constrainViewport) True to ensure popup is displayed within the browser's viewport.
void	setDefaultAlign(Style.AnchorAlignment defaultAlign) The default XElement.alignTo(Element, com.sencha.gxt.core.client.Style.AnchorAlignment, int, int) anchor position value for this menu relative to its element of origin (defaults to "tl-bl?").
void	setXOffset(int xOffset) Sets the xOffset when constrainViewport == true (defaults to 10).
void	setYOffset(int yOffset) Sets the yOffset when constrainViewport == true (defaults to 15).
void	show() Displays the popup.
void	show(Component widget) Displays the popup aligned to the bottom left of the widget.
void	show(Element elem, Style.AnchorAlignment pos) Displays the popup.
void	show(Element elem, Style.AnchorAlignment pos, int offsetX, int offsetY) Displays the popup.
void	showAt(int x, int y) Shows the popup at the specified location.

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

add, add, add, doLayout, getWidget, isResize, onRemove, setElement, setResize, setWidget, setWidget

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

applyLayout, applyLayout, forceLayout, forceLayoutOnChildren, forceLayoutOnChildren, getLeftRightMargins, getParentLayoutWidget, getSideMargins, getTopBottomMargins, isLayoutRunning, isOrWasLayoutRunning, isParentLayoutRunning, isWidgetVisible, onBeforeDoLayout, onLoad, onResize, onResize, parentIsOrWasLayoutRunning

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

addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, adjustIndex, adopt, checkIndexBoundsForInsertion, clear, disable, doAttachChildren, doDetachChildren, doPhysicalAttach, doPhysicalDetach, enable, ensureGroupingHandlerRegistration, findWidget, getAttachException, getChildren, getContainerTarget, getDetachException, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, iterator, onInsert, onWidgetHide, onWidgetShow, orphan, remove, remove, remove

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disableContextMenu, disableEvents, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hideShadow, hideToolTip, isAdjustSize, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, makeVisible, mask, mask, notifyHide, notifyShow, onAttach, onBlur, onBrowserEvent, onDisable, onEnable, onFocus, onHide, onHideContextMenu, onPosition, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, restoreVisible, setAdjustSize, 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, sync, syncSize, unmask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

yOffset

protected int yOffset

xOffset

protected int xOffset

animate

protected boolean animate

autoFocus

protected boolean autoFocus

autoHide

protected boolean autoHide

constrainViewport

protected boolean constrainViewport

defaultAlign

protected Style.AnchorAlignment defaultAlign

alignElem

protected Element alignElem

alignPos

protected Style.AnchorAlignment alignPos

alignOffsetX

protected int alignOffsetX

alignOffsetY

protected int alignOffsetY

alignPoint

protected Point alignPoint

preview

protected BaseEventPreview preview

Constructor Detail

Popup

public Popup()

Creates a new popup panel.

Method Detail

center

public void center()

Centers the panel within the viewport.

getDefaultAlign

public Style.AnchorAlignment getDefaultAlign()

Returns the default alignment.

Returns:

the default align

getIgnoreList

public CompositeElement getIgnoreList()

Any elements added to this list will be ignored when auto close is enabled.

Returns:

the list of ignored elements

getXOffset

public int getXOffset()

Returns the x offset.

Returns:

the offset

getYOffset

public int getYOffset()

Returns the y offsets.

Returns:

the offset

hide

public void hide()

Hides the popup.

Overrides:

hide in class Component

isAnimate

public boolean isAnimate()

Returns true if animations are enabled.

Returns:

the animation state

isAutoFocus

public boolean isAutoFocus()

Returns true if auto focus is enabled.

Returns:

the auto focus state

isAutoHide

public boolean isAutoHide()

Returns true if auto hide is enabled.

Returns:

the auto hide state

isConstrainViewport

public boolean isConstrainViewport()

Returns true if constrain to viewport is enabled.

Returns:

the constrain viewport state

setAnimate

public void setAnimate(boolean animate)

True to enable animations when showing and hiding (defaults to false).

Parameters:

animate - true to enable animations

setAutoFocus

public void setAutoFocus(boolean autoFocus)

True to move focus to the popup when being opened (defaults to true).

Parameters:

autoFocus - true for auto focus

setAutoHide

public void setAutoHide(boolean autoHide)

True to close the popup when the user clicks outside of the menu (default to true).

Parameters:

autoHide - true for auto hide

setConstrainViewport

public void setConstrainViewport(boolean constrainViewport)

True to ensure popup is displayed within the browser's viewport.

Parameters:

constrainViewport - true to constrain

setDefaultAlign

public void setDefaultAlign(Style.AnchorAlignment defaultAlign)

The default XElement.alignTo(Element, com.sencha.gxt.core.client.Style.AnchorAlignment, int, int) anchor position value for this menu relative to its element of origin (defaults to "tl-bl?").

Parameters:

defaultAlign - the default alignment

setXOffset

public void setXOffset(int xOffset)

Sets the xOffset when constrainViewport == true (defaults to 10).

Parameters:

xOffset - the x offset

setYOffset

public void setYOffset(int yOffset)

Sets the yOffset when constrainViewport == true (defaults to 15).

Parameters:

yOffset - the offset

show

public void show()

Displays the popup.

Overrides:

show in class Component

show

public void show(Component widget)

Displays the popup aligned to the bottom left of the widget. For exact control of popup position see #show(com.google.gwt.dom.client.Element, com.sencha.gxt.core.client.Style.AnchorAlignment, int, int).

Parameters:

widget - the widget to use for alignment

show

public void show(Element elem,
                 Style.AnchorAlignment pos)

Displays the popup.

Parameters:

elem - the element to align to

pos - the position

show

public void show(Element elem,
                 Style.AnchorAlignment pos,
                 int offsetX,
                 int offsetY)

Displays the popup.

Parameters:

elem - the element to align to

pos - the position

offsetX - X offset

offsetY - Y offset

showAt

public void showAt(int x,
                   int y)

Shows the popup at the specified location.

Parameters:

x - the x coordinate

y - the y coordinate

afterHide

protected void afterHide()

afterShow

protected void afterShow()

onAfterFirstAttach

protected void onAfterFirstAttach()

Description copied from class: Component

Called immediately after the first time the widget becomes attached to the browser's document only the first time.

Overrides:

onAfterFirstAttach in class Component

onAutoHide

protected boolean onAutoHide(Event event)

Subclasses may override to cancel the hide from an auto hide.

Parameters:

event - the current event

Returns:

true to close, false to cancel

onDetach

protected void onDetach()

Overrides:

onDetach in class Component

onShowPopup

protected Popup onShowPopup()