com.google.gwt.user.client.ui
Class ModalLayoutPanel

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.google.gwt.user.client.ui.Panel
              extended by com.google.gwt.user.client.ui.ComplexPanel
                  extended by com.google.gwt.user.client.ui.LayoutPanel
                      extended by com.google.gwt.user.client.ui.ModalLayoutPanel
All Implemented Interfaces:
com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasCloseHandlers<ModalLayoutPanel>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.AnimatedLayout, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.ProvidesResize, com.google.gwt.user.client.ui.RequiresResize, Iterable<com.google.gwt.user.client.ui.Widget>

public class ModalLayoutPanel
extends com.google.gwt.user.client.ui.LayoutPanel
implements com.google.gwt.event.logical.shared.HasCloseHandlers<ModalLayoutPanel>


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
 
Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel
com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget
 
Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets
com.google.gwt.user.client.ui.HasWidgets.ForIsWidget
 
Field Summary
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
ModalLayoutPanel()
           
 
Method Summary
 com.google.gwt.event.shared.HandlerRegistration addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<ModalLayoutPanel> handler)
           
 void hide()
          Hides the popup and detaches it from the page.
 void hide(boolean autoClosed)
          Hides the popup and detaches it from the page.
 boolean isShowing()
          Determines whether or not this popup is showing.
 boolean isVisible()
          Determines whether or not this popup is visible.
protected  void onPreviewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent event)
           
protected  void onUnload()
           
 void removeAutoHidePartner(com.google.gwt.dom.client.Element partner)
          Remove an autoHide partner.
 void setVisible(boolean visible)
          Sets whether this object is visible.
 void show()
          Shows the popup and attach it to the page.
 
Methods inherited from class com.google.gwt.user.client.ui.LayoutPanel
add, animate, animate, forceLayout, getWidgetContainerElement, insert, onLoad, onResize, remove, setWidgetBottomHeight, setWidgetHorizontalPosition, setWidgetLeftRight, setWidgetLeftWidth, setWidgetRightWidth, setWidgetTopBottom, setWidgetTopHeight, setWidgetVerticalPosition, setWidgetVisible
 
Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel
add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove
 
Methods inherited from class com.google.gwt.user.client.ui.Panel
add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setWidth, toString, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

ModalLayoutPanel

public ModalLayoutPanel()
Method Detail

addCloseHandler

public com.google.gwt.event.shared.HandlerRegistration addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<ModalLayoutPanel> handler)
Specified by:
addCloseHandler in interface com.google.gwt.event.logical.shared.HasCloseHandlers<ModalLayoutPanel>

hide

public void hide()
Hides the popup and detaches it from the page. This has no effect if it is not currently showing.


hide

public void hide(boolean autoClosed)
Hides the popup and detaches it from the page. This has no effect if it is not currently showing.

Parameters:
autoClosed - the value that will be passed to CloseHandler.onClose(CloseEvent) when the popup is closed

isShowing

public boolean isShowing()
Determines whether or not this popup is showing.

Returns:
true if the popup is showing
See Also:
show(), hide()

isVisible

public boolean isVisible()
Determines whether or not this popup is visible. Note that this just checks the visibility style attribute, which is set in the setVisible(boolean) method. If you want to know if the popup is attached to the page, use isShowing() instead.

Overrides:
isVisible in class com.google.gwt.user.client.ui.UIObject
Returns:
true if the object is visible
See Also:
setVisible(boolean)

removeAutoHidePartner

public void removeAutoHidePartner(com.google.gwt.dom.client.Element partner)
Remove an autoHide partner.

Parameters:
partner - the auto hide partner to remove

setVisible

public void setVisible(boolean visible)
Sets whether this object is visible. This method just sets the visibility style attribute. You need to call show() to actually attached/detach the PopupPanel to the page.

Overrides:
setVisible in class com.google.gwt.user.client.ui.UIObject
Parameters:
visible - true to show the object, false to hide it
See Also:
show(), hide()

show

public void show()
Shows the popup and attach it to the page. It must have a child widget before this method is called.


onPreviewNativeEvent

protected void onPreviewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent event)

onUnload

protected void onUnload()
Overrides:
onUnload in class com.google.gwt.user.client.ui.LayoutPanel


Copyright © 2011 OneBusAway. All Rights Reserved.