com.extjs.gxt.ui.client.widget
Class Popup

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<Component>
                          extended by com.extjs.gxt.ui.client.widget.LayoutContainer
                              extended by com.extjs.gxt.ui.client.widget.Popup
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 Popup
extends LayoutContainer

A panel that can be displayed over other widgets.

Events:
BeforeShow : ComponentEvent(component)
Fires before the popup is displayed. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).
Show : ComponentEvent(component)
Fires after a popup is displayed.
BeforeHide : ComponentEvent(component)
Fires before the popup is hidden. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).
Hide : ComponentEvent(component)
Fires after a popup is hidden.
Inherited Events:
LayoutContainer AfterLayout
ScrollContainer Scroll
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
CSS:
.x-popup (the popup itself)


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
Popup()
          Creates a new popup panel.
 
Method Summary
protected  void afterHide()
           
protected  void afterShow()
           
 void center()
          Centers the panel within the viewport.
 java.lang.String 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.
protected  void handleKeyUp(ComponentEvent ce)
           
 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 contrain to viewport is enabled.
protected  boolean onAutoHide(com.google.gwt.user.client.Event event)
          Subclasses may override to cancel the hide from an auto hide.
protected  void onDetach()
           
protected  void onKeyPress(BaseEvent be)
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
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 dislayed within the browser's viewport.
 void setDefaultAlign(java.lang.String defaultAlign)
          The default El.alignTo(com.google.gwt.user.client.Element, java.lang.String, 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(com.google.gwt.user.client.Element elem, java.lang.String pos)
          Displays the popup.
 void show(com.google.gwt.user.client.Element elem, java.lang.String pos, int[] offsets)
          Displays the popup.
 void showAt(int x, int y)
          Shows the popup at the specified location.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.LayoutContainer
add, add, addText, findComponent, getLayout, getLayoutTarget, getWindowResizeDelay, insert, insert, isLayoutOnChange, isMonitorWindowResize, layout, layout, onBlur, onComponentEvent, onFocus, remove, removeAll, setLayout, setLayoutData, setLayoutOnChange, setMonitorWindowResize, setWindowResizeDelay
 
Methods inherited from class com.extjs.gxt.ui.client.widget.ScrollContainer
addScrollListener, afterRender, getHScrollPosition, getScrollMode, getVScrollPosition, 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, getWidget, indexOf, insert, isLayoutNeeded, iterator, notifyHide, notifyShow, onAfterLayout, onAttach, onBeforeLayoutExcecuted, onInsert, onLayoutExcecuted, onRemove, orphan, remove, remove, removeAll, scrollIntoView, setLayoutNeeded, 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, hasListeners, hasListeners, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, onBrowserEvent, 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, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setZIndex, 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

Popup

public Popup()
Creates a new popup panel.

Method Detail

center

public void center()
Centers the panel within the viewport.


getDefaultAlign

public java.lang.String 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 contrain 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 dislayed within the browser's viewport.

Parameters:
constrainViewport - true to constrain

setDefaultAlign

public void setDefaultAlign(java.lang.String defaultAlign)
The default El.alignTo(com.google.gwt.user.client.Element, java.lang.String, 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(Element, String, int[]).

Parameters:
widget - the widget to use for alignment

show

public void show(com.google.gwt.user.client.Element elem,
                 java.lang.String pos)
Displays the popup.

Parameters:
elem - the element to align to
pos - the position

show

public void show(com.google.gwt.user.client.Element elem,
                 java.lang.String pos,
                 int[] offsets)
Displays the popup.

Parameters:
elem - the element to align to
pos - the postion
offsets - the offsets

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()

handleKeyUp

protected void handleKeyUp(ComponentEvent ce)

onAutoHide

protected boolean onAutoHide(com.google.gwt.user.client.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

onKeyPress

protected void onKeyPress(BaseEvent be)

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 LayoutContainer
Parameters:
target - the target element
index - the insert location

onShowPopup

protected Popup onShowPopup()