com.vaadin.client.ui
Class VPopupView

java.lang.Object
  HTML
      com.vaadin.client.ui.VPopupView

All Implemented Interfaces:

DeferredWorker, java.lang.Iterable<Widget>

public class VPopupView
extends HTML
implements java.lang.Iterable<Widget>, DeferredWorker

Nested Class Summary

class

VPopupView.CustomPopup This class is only public to enable overriding showPopup, and is currently not intended to be extended or otherwise used directly.

Field Summary

static java.lang.String	CLASSNAME
ApplicationConnection	client For internal use only.
boolean	hostPopupVisible Helps to communicate popup visibility to the server.
VPopupView.CustomPopup	popup For internal use only.
java.lang.String	uidlId For server-client communication.

Constructor Summary

VPopupView()
loading constructor

Method Summary

com.google.gwt.event.shared.HandlerRegistration	addVisibilityChangeHandler(VisibilityChangeHandler visibilityChangeHandler)
void	center() For internal use only.
boolean	isEnabled() Returns true if the popup is enabled, false if not.
boolean	isWorkPending() Checks whether there are operations pending for this widget that must be executed before reaching a steady state.
java.util.Iterator<Widget>	iterator()
protected void	onDetach() Make sure that we remove the popup when the main widget is removed.
void	preparePopup(VPopupView.CustomPopup popup) For internal use only.
void	setEnabled(boolean enabled) Sets whether this popup is enabled.
void	showPopup(VPopupView.CustomPopup popup) Determines the correct position for a popup and displays the popup at that position.

Methods inherited from class java.lang.Object

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

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME

See Also:

Constant Field Values

uidlId

public java.lang.String uidlId

For server-client communication.

For internal use only. May be removed or replaced in the future.

client

public ApplicationConnection client

For internal use only. May be removed or replaced in the future.

hostPopupVisible

public boolean hostPopupVisible

Helps to communicate popup visibility to the server.

For internal use only. May be removed or replaced in the future.

popup

public final VPopupView.CustomPopup popup

For internal use only. May be removed or replaced in the future.

Constructor Detail

VPopupView

public VPopupView()

loading constructor

Method Detail

preparePopup

public void preparePopup(VPopupView.CustomPopup popup)

For internal use only. May be removed or replaced in the future.

showPopup

public void showPopup(VPopupView.CustomPopup popup)

Determines the correct position for a popup and displays the popup at that position. By default, the popup is shown centered relative to its host component, ensuring it is visible on the screen if possible. Can be overridden to customize the popup position.

Parameters:

popup -

center

public void center()

For internal use only. May be removed or replaced in the future.

onDetach

protected void onDetach()

Make sure that we remove the popup when the main widget is removed.

See Also:

com.google.gwt.user.client.ui.Widget#onUnload()

isEnabled

public boolean isEnabled()

Returns true if the popup is enabled, false if not.

Since:

7.3.4

setEnabled

public void setEnabled(boolean enabled)

Sets whether this popup is enabled.

Parameters:

enabled - true to enable the popup, false to disable it

Since:

7.3.4

addVisibilityChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addVisibilityChangeHandler(VisibilityChangeHandler visibilityChangeHandler)

iterator

public java.util.Iterator<Widget> iterator()

Specified by:

iterator in interface java.lang.Iterable<Widget>

isWorkPending

public boolean isWorkPending()

Description copied from interface: DeferredWorker

Checks whether there are operations pending for this widget that must be executed before reaching a steady state.

Specified by:

isWorkPending in interface DeferredWorker