com.sencha.gxt.widget.core.client
Class ModalPanel

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.sencha.gxt.widget.core.client.Component
              extended by com.sencha.gxt.widget.core.client.ModalPanel
All Implemented Interfaces:
HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, HasEnabled, HasVisibility, IsWidget, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

public class ModalPanel
extends Component

A panel that grays out the view port and displays a widget above it.


Nested Class Summary
static interface ModalPanel.ModalPanelAppearance
           
static class ModalPanel.ModalPanelDefaultAppearance
           
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
ModalPanel()
          Creates a new model panel.
ModalPanel(ModalPanel.ModalPanelAppearance appearance)
          Creates a model panel with the specified appearance.
 
Method Summary
 BaseEventPreview getEventPreview()
          Returns the panel's event preview.
 void hide()
          Hides the panel.
 boolean isBlink()
          Returns true if blinking is enabled.
static ModalPanel pop()
          Returns a ModalPanel from the stack.
static void push(ModalPanel panel)
          Pushes a panel back onto the stack.
 void setBlink(boolean blink)
          True to blink the widget being displayed when the use clicks outside of the widgets bounds (defaults to false).
 void show(Component component)
          Displays the panel.
 void syncModal()
          Syncs to the viewport.
 
Methods inherited from class com.sencha.gxt.widget.core.client.Component
addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getStateId, getToolTip, 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, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ModalPanel

public ModalPanel()
Creates a new model panel.


ModalPanel

public ModalPanel(ModalPanel.ModalPanelAppearance appearance)
Creates a model panel with the specified appearance.

Parameters:
appearance - the appearance of the modal panel
Method Detail

pop

public static ModalPanel pop()
Returns a ModalPanel from the stack.

Returns:
the panel

push

public static void push(ModalPanel panel)
Pushes a panel back onto the stack.

Parameters:
panel - the panel

getEventPreview

public BaseEventPreview getEventPreview()
Returns the panel's event preview.

Returns:
the event preview

hide

public void hide()
Hides the panel.

Overrides:
hide in class Component

isBlink

public boolean isBlink()
Returns true if blinking is enabled.

Returns:
the blink state

setBlink

public void setBlink(boolean blink)
True to blink the widget being displayed when the use clicks outside of the widgets bounds (defaults to false).

Parameters:
blink - true to blink

show

public void show(Component component)
Displays the panel.

Parameters:
component - the component displayed above this modal panel.

syncModal

public void syncModal()
Syncs to the viewport.



Copyright © 2012. All Rights Reserved.