com.whitestein.lsps.vaadin.forms.singlecomponentcontainer

Class WPopup

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.singlecomponentcontainer.WSingleComponentContainer

com.whitestein.lsps.vaadin.forms.singlecomponentcontainer.WPopup

All Implemented Interfaces:

com.vaadin.event.ConnectorEventListener, com.vaadin.server.ClientConnector.AttachListener, Serializable, EventListener

public class WPopup
extends WSingleComponentContainer

Author:

mvy

See Also:

Serialized Form

Field Summary

Fields inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

form, INTERNAL_STATE_RECORD_PROPERTY

Fields inherited from interface com.vaadin.server.ClientConnector.AttachListener

attachMethod

Constructor Summary

Constructors

Constructor and Description
WPopup()

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.ui.AbstractComponent	createWidget() Called once, to create the actual Vaadin component.
com.vaadin.ui.Window	getWidget() Gets the Vaadin representation of this component.
boolean	isClosable() Returns the closable status of the window.
boolean	isDraggable() Indicates whether a window can be dragged or not.
boolean	isModal()
boolean	isResizable()
boolean	isVisible() Indicates whether the popup is visible or not.
protected void	onClose()
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setClosable(boolean closable) Sets the closable status for the window.
void	setDraggable(boolean draggable) Enables or disables that a window can be dragged (moved) by the user.
void	setModal(boolean modal) Sets window modality.
void	setResizable(boolean resizable) Sets window resizable.
void	setVisible(boolean visible) Sets the visible flag to the popup
protected void	writeInternalState(Map<String,Object> state) Writes the UI state of this component to the provided map.

Methods inherited from class com.whitestein.lsps.vaadin.forms.singlecomponentcontainer.WSingleComponentContainer

getContent, setContent

Methods inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

addDataErrorMessage, addStyleName, attach, call, clearDataErrorMessages, createEvent, equals, getCaption, getComponentAlignment, getContextClickHandler, getCustomErrorMessage, getDataErrorMessages, getDescription, getExpandRatio, getHasChildrenAdapter, getHeight, getIcon, getModelingId, getNamespace, getStyleName, getTabIndex, getWidth, hashCode, isEnabled, isReadOnly, localize, markAsDirty, preventGC, removeStyleName, restoreState, saveState, setCaption, setComponentAlignment, setContextClickHandler, setContextMenuItems, setCustomErrorMessage, setDescription, setEnabled, setExpandRatio, setHeight, setIcon, setReadOnly, setStyleName, setTabIndex, setWidth, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WPopup

public WPopup()

Method Detail

createWidget

protected com.vaadin.ui.AbstractComponent createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class FormComponent

Returns:

the actual Vaadin component, may be null if the component has no UI counterpart.

getWidget

public com.vaadin.ui.Window getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class WSingleComponentContainer

Returns:

the Vaadin representation of this form component.

setVisible

public void setVisible(boolean visible)

Sets the visible flag to the popup

Overrides:

setVisible in class FormComponent

Parameters:

visible -

isVisible

public boolean isVisible()

Indicates whether the popup is visible or not.

Overrides:

isVisible in class FormComponent

Returns:

true if the popup is visible

onClose

protected void onClose()

writeInternalState

protected void writeInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Writes the UI state of this component to the provided map. The written state is later used to restore the UI when a saved document or saved Todo is reopened.

Many UI attributes such as size, caption, etc. are not held in the records but are stored exclusively in the Vaadin components. In the records the getter/setter methods of such attributes directly delegate to the underlying component. For the purposes of the Save Document/Todo use case the state of such attributes has to be preserved.

Subclasses should override this method. The overriding method should call super.writeInternalState(state) to store the state form the super class as well. The attributes should be written to the provided state parameter. The type of the values written to the state can only by Java representation of LSPS types. That is java.util.Date, java.lang.String, Decimal, RecordHolder, ListHolder, ... The name of the attributes stored in the map should be unique and should not collide with the names used by any of the superclass. It is the responsibility of the overridden method to ensure that.

Subclasses overriding this method should also override FormComponent.restoreInternalState(Map) and restore the state written by this method.

Overrides:

writeInternalState in class WSingleComponentContainer

Parameters:

state - a map to which this method should write the component's UI state.

See Also:

FormComponent.restoreInternalState(Map), FormComponent.saveState()

restoreInternalState

protected void restoreInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map). Subclasses should override and call super.restoreInternalState(state);

Overrides:

restoreInternalState in class WSingleComponentContainer

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)

setModal

public void setModal(boolean modal)

Sets window modality. When a modal window is open, components outside that window cannot be accessed.

Keyboard navigation is restricted by blocking the tab key at the top and bottom of the window by activating the tab stop function internally.

Parameters:

modal - true if modality is to be turned on

isModal

public boolean isModal()

Returns:

true if this window is modal.

setResizable

public void setResizable(boolean resizable)

Sets window resizable.

Parameters:

resizable - true if resizability is to be turned on

isResizable

public boolean isResizable()

Returns:

true if window is resizable by the end-user, otherwise false.

isDraggable

public boolean isDraggable()

Indicates whether a window can be dragged or not. By default a window is draggable.

Returns:

whether the window can be dragged by the user

setDraggable

public void setDraggable(boolean draggable)

Enables or disables that a window can be dragged (moved) by the user. By default a window is draggable.

Parameters:

draggable - true if the window can be dragged by the user

isClosable

public boolean isClosable()

Returns the closable status of the window. If a window is closable, it typically shows an X in the upper right corner. Clicking on the X sends a close event to the server. Setting closable to false will remove the X from the window and prevent the user from closing the window. Note! For historical reasons readonly controls the closability of the window and therefore readonly and closable affect each other. Setting readonly to true will set closable to false and vice versa.

Returns:

true if the window can be closed by the user.

setClosable

public void setClosable(boolean closable)

Sets the closable status for the window. If a window is closable it typically shows an X in the upper right corner. Clicking on the X sends a close event to the server. Setting closable to false will remove the X from the window and prevent the user from closing the window. Note! For historical reasons readonly controls the closability of the window and therefore readonly and closable affect each other. Setting readonly to true will set closable to false and vice versa.

Parameters:

closable - determines if the window can be closed by the user.