Class Overlay

Field Detail

• Z_INDEX

  public static int Z_INDEX

• CLASSNAME_SHADOW

  @Deprecated
  public static final String CLASSNAME_SHADOW

  Deprecated. See main JavaDoc for Overlay

  Shadow element style. If an extending class wishes to use a different style of shadow, it can use setShadowStyle(String) to give the shadow element a new style name.

  See Also:

  Constant Field Values

• CLASSNAME_CONTAINER

  public static final String CLASSNAME_CONTAINER

  Style name for the overlay container element (see getOverlayContainer().

  See Also:

  Constant Field Values

• ADDITIONAL_CLASSNAME_ANIMATE_IN

  public static final String ADDITIONAL_CLASSNAME_ANIMATE_IN

  Since:

  7.3

  See Also:

  Constant Field Values

• ADDITIONAL_CLASSNAME_ANIMATE_OUT

  public static final String ADDITIONAL_CLASSNAME_ANIMATE_OUT

  Since:

  7.3

  See Also:

  Constant Field Values

• current

  protected static Overlay current

Constructor Detail

• Overlay

  public Overlay()

• Overlay

  public Overlay(boolean autoHide)

• Overlay

  public Overlay(boolean autoHide,
                 boolean modal)

Method Detail

• onAttach

  protected void onAttach()

  Overrides:

  onAttach in class com.google.gwt.user.client.ui.Widget

• isShimElementEnabled

  protected boolean isShimElementEnabled()

• setZIndex

  protected void setZIndex(int zIndex)

  Set the z-index (visual stack position) for this overlay.

  Parameters:

  zIndex - The new z-index

• setPopupPosition

  public void setPopupPosition(int left,
                               int top)

  Overrides:

  setPopupPosition in class com.google.gwt.user.client.ui.PopupPanel

• show

  public void show()

  Overrides:

  show in class com.google.gwt.user.client.ui.PopupPanel

• onDetach

  protected void onDetach()

  Overrides:

  onDetach in class com.google.gwt.user.client.ui.Widget

• setVisible

  public void setVisible(boolean visible)

  Specified by:

  setVisible in interface com.google.gwt.user.client.ui.HasVisibility

  Overrides:

  setVisible in class com.google.gwt.user.client.ui.PopupPanel

• setWidth

  public void setWidth(String width)

  Overrides:

  setWidth in class com.google.gwt.user.client.ui.PopupPanel

• setHeight

  public void setHeight(String height)

  Overrides:

  setHeight in class com.google.gwt.user.client.ui.PopupPanel

• positionOrSizeUpdated

  public void positionOrSizeUpdated()

  Extending classes should always call this method after they change the size of overlay without using normal 'setWidth(String)' and 'setHeight(String)' methods (if not calling super.setWidth/Height).

• updateShadowSizeAndPosition

  @Deprecated
  protected void updateShadowSizeAndPosition()

  Deprecated. Call positionOrSizeUpdated() instead.

• needsShimElement

  protected boolean needsShimElement()

  Returns true if we should add a shim iframe below the overlay to deal with zindex issues with PDFs and applets. Can be overridden to disable shim iframes if they are not needed.

  Returns:

  true if a shim iframe should be added, false otherwise

• getOwner

  public com.google.gwt.user.client.ui.Widget getOwner()

  Get owner (Widget that made this Overlay, not the layout parent) of Overlay.

  Returns:

  Owner (creator) or null if not defined

• setOwner

  public void setOwner(com.google.gwt.user.client.ui.Widget owner)

  Set owner (Widget that made this Overlay, not the layout parent) of Overlay.

  Parameters:

  owner - Owner (creator) of Overlay

• getOverlayContainer

  public com.google.gwt.user.client.Element getOverlayContainer()

  Gets the 'overlay container' element.

  Returns:

  the overlay container element

• center

  public void center()

  Overrides:

  center in class com.google.gwt.user.client.ui.PopupPanel

• hide

  public void hide()

  Overrides:

  hide in class com.google.gwt.user.client.ui.PopupPanel

• hide

  public void hide(boolean autoClosed)

  Overrides:

  hide in class com.google.gwt.user.client.ui.PopupPanel

• hide

  public void hide(boolean autoClosed,
                   boolean animateIn,
                   boolean animateOut)

  Hides the popup and detaches it from the page. This has no effect if it is not currently showing. Animation-in, animation-out can be enable/disabled for different use cases.

  Parameters:

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

  animateIn - enable/disable animate-in animation

  animateOut - enable/disable animate-out animation

  Since:

  7.3.7

  See Also:

  PopupPanel.hide(boolean)

• setFitInWindow

  public void setFitInWindow(boolean fitInWindow)

  Sets whether the overlay should be moved or shrunk to fit inside the window.

  When this is false, the default PopupPanel behavior is used, which tries to position the popup primarly below and to the right of a reference UIObject and, if there is not enough space, above or to the left.

  When this is true, the popup will be moved up/left in case it does not fit on either side. If the popup is larger than the window, it will be shrunk to fit and assume that scrolling e.g. using overflow:auto, is taken care of by the overlay user.

  Parameters:

  fitInWindow - true to ensure that no part of the popup is outside the visible view, false to use the default PopupPanel behavior

  Since:

  7.6.6

• isFitInWindow

  public boolean isFitInWindow()

  Checks whether the overlay should be moved or shrunk to fit inside the window.

  Returns:

  true if the popup will be moved and/or shrunk to fit inside the window, false otherwise

  Since:

  7.6.6

  See Also:

  setFitInWindow(boolean)