com.vaadin.ui
Class PopupView

java.lang.Object
  com.vaadin.terminal.AbstractClientConnector
      com.vaadin.ui.AbstractComponent
          com.vaadin.ui.AbstractComponentContainer
              com.vaadin.ui.PopupView

All Implemented Interfaces:

MethodEventSource, Connector, ClientConnector, RpcTarget, Sizeable, Vaadin6Component, VariableOwner, Component, ComponentContainer, HasComponents, Serializable, Iterable<Component>, EventListener

public class PopupView
extends AbstractComponentContainer
implements Vaadin6Component

A component for displaying a two different views to data. The minimized view is normally used to render the component, and when it is clicked the full view is displayed on a popup. The inner class PopupView.Content is used to deliver contents to this component.

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

static interface	PopupView.Content Used to deliver customized content-packages to the PopupView.
class	PopupView.PopupVisibilityEvent This event is received by the PopupVisibilityListeners when the visibility of the popup changes.
static interface	PopupView.PopupVisibilityListener Defines a listener that can receive a PopupVisibilityEvent when the visibility of the popup changes.

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent

AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler

Nested classes/interfaces inherited from interface com.vaadin.terminal.VariableOwner

VariableOwner.ErrorEvent

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.terminal.Sizeable

Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.ComponentContainer

ComponentContainer.ComponentAttachEvent, ComponentContainer.ComponentAttachListener, ComponentContainer.ComponentDetachEvent, ComponentContainer.ComponentDetachListener

Field Summary

Fields inherited from interface com.vaadin.terminal.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

PopupView(PopupView.Content content)
Creates a PopupView through the PopupView.Content interface.

PopupView(String small, Component large)
A simple way to create a PopupPanel.

Method Summary

void	addComponent(Component c) Not supported in this implementation.
void	addListener(PopupView.PopupVisibilityListener listener) Add a listener that is called whenever the visibility of the popup is changed.
void	changeVariables(Object source, Map<String,Object> variables) Deserialize changes received from client.
int	getComponentCount() Gets the number of contained components.
Iterator<Component>	getComponentIterator() This class only contains other components when the popup is showing.
PopupView.Content	getContent() Returns the content-package for this PopupView.
boolean	getPopupVisibility() Deprecated. Use isPopupVisible() instead.
boolean	isHideOnMouseOut() Check if this popup will be hidden when the user takes the mouse cursor out of the popup area.
boolean	isPopupVisible() Return whether the popup is visible.
void	moveComponentsFrom(ComponentContainer source) Not supported in this implementation.
void	paintContent(PaintTarget target) Paint (serialize) the component for the client.
void	removeAllComponents() Not supported in this implementation.
void	removeComponent(Component c) Not supported in this implementation
void	removeListener(PopupView.PopupVisibilityListener listener) Removes a previously added listener, so that it no longer receives events when the visibility of the popup changes.
void	replaceComponent(Component oldComponent, Component newComponent) Not supported in this implementation.
void	setContent(PopupView.Content newContent) This method will replace the current content of the panel with a new one.
void	setHideOnMouseOut(boolean hideOnMouseOut) Should the popup automatically hide when the user takes the mouse cursor out of the popup area? If this is false, the user must click outside the popup to close it.
void	setPopupVisibility(boolean visible) Deprecated. Use #setPopupVisible() instead.
void	setPopupVisible(boolean visible) Set the visibility of the popup.

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addListener, addListener, fireComponentAttachEvent, fireComponentDetachEvent, isComponentVisible, iterator, removeListener, removeListener, setHeight, setVisible, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addListener, addListener, addListener, addShortcutListener, addStyleName, attach, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireEvent, focus, getActionManager, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getRoot, getState, getStyle, getStyleName, getWidth, getWidthUnits, handleError, hasListeners, isConnectorEnabled, isEnabled, isImmediate, isReadOnly, isVisible, removeListener, removeListener, removeListener, removeListener, removeListener, removeShortcutListener, removeStyleName, requestRepaint, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setErrorHandler, setHeight, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyle, setStyleName, setWidth, updateState

Methods inherited from class com.vaadin.terminal.AbstractClientConnector

addExtension, addMethodInvocationToQueue, createState, getAllChildrenIterable, getConnectorId, getExtensions, getRpcManager, getRpcProxy, getStateType, registerRpc, registerRpc, removeExtension, requestRepaintAll, retrievePendingRpcCalls

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.terminal.VariableOwner

isEnabled, isImmediate

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getApplication, getCaption, getDebugId, getIcon, getLocale, getParent, getRoot, getState, getStyleName, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setDebugId, setEnabled, setIcon, setReadOnly, setStyleName, setVisible, updateState

Methods inherited from interface com.vaadin.terminal.gwt.server.ClientConnector

detach, getExtensions, getStateType, isConnectorEnabled, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setParent

Methods inherited from interface com.vaadin.terminal.gwt.client.Connector

getConnectorId

Methods inherited from interface com.vaadin.terminal.gwt.server.RpcTarget

getRpcManager

Methods inherited from interface com.vaadin.terminal.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setSizeFull, setSizeUndefined, setWidth, setWidth

Constructor Detail

PopupView

public PopupView(String small,
                 Component large)

A simple way to create a PopupPanel. Note that the minimal representation may not be dynamically updated, in order to achieve this create your own Content object and use PopupView(Content).

Parameters:

small - the minimal textual representation as HTML

large - the full, Component-type representation

PopupView

public PopupView(PopupView.Content content)

Creates a PopupView through the PopupView.Content interface. This allows the creator to dynamically change the contents of the PopupView.

Parameters:

content - the PopupView.Content that contains the information for this

Method Detail

setContent

public void setContent(PopupView.Content newContent)
                throws IllegalArgumentException

This method will replace the current content of the panel with a new one.

Parameters:

newContent - PopupView.Content object containing new information for the PopupView

Throws:

IllegalArgumentException - if the method is passed a null value, or if one of the content methods returns null

getContent

public PopupView.Content getContent()

Returns the content-package for this PopupView.

Returns:

the PopupView.Content for this object or null

setPopupVisibility

@Deprecated
public void setPopupVisibility(boolean visible)

Deprecated. Use #setPopupVisible() instead.

getPopupVisibility

@Deprecated
public boolean getPopupVisibility()

Deprecated. Use isPopupVisible() instead.

setPopupVisible

public void setPopupVisible(boolean visible)

Set the visibility of the popup. Does not hide the minimal representation.

Parameters:

visible -

isPopupVisible

public boolean isPopupVisible()

Return whether the popup is visible.

Returns:

true if the popup is showing

isHideOnMouseOut

public boolean isHideOnMouseOut()

Check if this popup will be hidden when the user takes the mouse cursor out of the popup area.

Returns:

true if the popup is hidden on mouse out, false otherwise

setHideOnMouseOut

public void setHideOnMouseOut(boolean hideOnMouseOut)

Should the popup automatically hide when the user takes the mouse cursor out of the popup area? If this is false, the user must click outside the popup to close it. The default is true.

Parameters:

hideOnMouseOut -

getComponentIterator

public Iterator<Component> getComponentIterator()

This class only contains other components when the popup is showing.

Specified by:

getComponentIterator in interface HasComponents

Returns:

the component iterator.

See Also:

HasComponents.getComponentIterator()

getComponentCount

public int getComponentCount()

Gets the number of contained components. Consistent with the iterator returned by getComponentIterator().

Specified by:

getComponentCount in interface ComponentContainer

Returns:

the number of contained components (zero or one)

removeAllComponents

public void removeAllComponents()

Not supported in this implementation.

Specified by:

removeAllComponents in interface ComponentContainer

Overrides:

removeAllComponents in class AbstractComponentContainer

Throws:

UnsupportedOperationException

See Also:

AbstractComponentContainer.removeAllComponents()

moveComponentsFrom

public void moveComponentsFrom(ComponentContainer source)
                        throws UnsupportedOperationException

Not supported in this implementation.

Specified by:

moveComponentsFrom in interface ComponentContainer

Overrides:

moveComponentsFrom in class AbstractComponentContainer

Parameters:

source - the container which contains the components that are to be moved to this container.

Throws:

UnsupportedOperationException

See Also:

AbstractComponentContainer.moveComponentsFrom(com.vaadin.ui.ComponentContainer)

addComponent

public void addComponent(Component c)
                  throws UnsupportedOperationException

Not supported in this implementation.

Specified by:

addComponent in interface ComponentContainer

Overrides:

addComponent in class AbstractComponentContainer

Parameters:

c - the component to be added.

Throws:

UnsupportedOperationException

See Also:

AbstractComponentContainer.addComponent(com.vaadin.ui.Component)

replaceComponent

public void replaceComponent(Component oldComponent,
                             Component newComponent)
                      throws UnsupportedOperationException

Not supported in this implementation.

Specified by:

replaceComponent in interface ComponentContainer

Parameters:

oldComponent - the old component that will be replaced.

newComponent - the new component to be replaced.

Throws:

UnsupportedOperationException

See Also:

ComponentContainer.replaceComponent(com.vaadin.ui.Component, com.vaadin.ui.Component)

removeComponent

public void removeComponent(Component c)
                     throws UnsupportedOperationException

Not supported in this implementation

Specified by:

removeComponent in interface ComponentContainer

Overrides:

removeComponent in class AbstractComponentContainer

Parameters:

c - the component to be removed.

Throws:

UnsupportedOperationException

See Also:

AbstractComponentContainer.removeComponent(com.vaadin.ui.Component)

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Paint (serialize) the component for the client.

Specified by:

paintContent in interface Vaadin6Component

Parameters:

target - the target UIDL stream where the component should paint itself to.

Throws:

PaintException - if the paint operation failed.

See Also:

com.vaadin.ui.AbstractComponent#paintContent(com.vaadin.terminal.PaintTarget)

changeVariables

public void changeVariables(Object source,
                            Map<String,Object> variables)

Deserialize changes received from client.

Specified by:

changeVariables in interface VariableOwner

Parameters:

source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.

variables - the Mapping from variable names to new variable values.

See Also:

com.vaadin.ui.AbstractComponent#changeVariables(java.lang.Object, java.util.Map)

addListener

public void addListener(PopupView.PopupVisibilityListener listener)

Add a listener that is called whenever the visibility of the popup is changed.

Parameters:

listener - the listener to add

See Also:

PopupView.PopupVisibilityListener, PopupView.PopupVisibilityEvent, removeListener(PopupVisibilityListener)

removeListener

public void removeListener(PopupView.PopupVisibilityListener listener)

Removes a previously added listener, so that it no longer receives events when the visibility of the popup changes.

Parameters:

listener - the listener to remove

See Also:

PopupView.PopupVisibilityListener, addListener(PopupVisibilityListener)