info.magnolia.ui.vaadin.dialog

Class BaseDialog

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

info.magnolia.ui.vaadin.dialog.BaseDialog

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.HasComponents, Serializable, Iterable<com.vaadin.ui.Component>

Direct Known Subclasses:

FormDialog, LightDialog

public class BaseDialog
extends com.vaadin.ui.AbstractComponent
implements com.vaadin.ui.HasComponents

Basic implementation of dialogs. Provides Action registration and callbacks to the view. Can be closed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseDialog.DescriptionVisibilityEvent DescriptionVisibilityEvent.
static class	BaseDialog.DialogCloseEvent DialogCloseEvent.
static class	BaseDialog.WideEvent DescriptionVisibilityEvent.

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

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

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

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

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

com.vaadin.server.Sizeable.Unit

Field Summary

Fields

Modifier and Type	Field and Description
static String	CANCEL_ACTION_NAME
static String	COMMIT_ACTION_NAME

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

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

Constructor Summary

Constructors

Constructor and Description
BaseDialog()

Method Summary

Modifier and Type	Method and Description
void	addDescriptionVisibilityHandler(BaseDialog.DescriptionVisibilityEvent.Handler handler)
void	addDialogCloseHandler(BaseDialog.DialogCloseEvent.Handler handler)
void	addWideHandler(BaseDialog.WideEvent.Handler handler)
protected void	adoptComponent(com.vaadin.ui.Component newContent) Sets a Component The composition root must be set to non-null value before the component can be used.
void	closeSelf()
protected com.vaadin.ui.Component	createDefaultContent()
protected com.vaadin.ui.Component	createDefaultFooter()
protected com.vaadin.ui.Component	createDefaultHeader()
com.vaadin.ui.Component	getContent()
protected BaseDialogState	getState()
Iterator<com.vaadin.ui.Component>	iterator()
void	removeDescriptionVisibilityHandler(BaseDialog.DescriptionVisibilityEvent.Handler handler)
void	removeDialogCloseHandler(BaseDialog.DialogCloseEvent.Handler handler)
void	removeWideHandler(BaseDialog.DialogCloseEvent.Handler handler)
void	setCaption(String caption)
void	setContent(com.vaadin.ui.Component newContent)
void	setDescriptionVisibility(boolean isVisible)
void	setDialogDescription(String description)
void	setFooterToolbar(com.vaadin.ui.Component newFooter)
void	setHeaderToolbar(com.vaadin.ui.Component newHeader)
void	setModalityLevel(String modalityLevel)
void	setWide(boolean isWide)
void	setWideOnClient(boolean isWide)
void	showCloseButton()

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getState, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isResponsive, isVisible, readDesign, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined, writeDesign

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, readDesign, removeListener, removeStyleName, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

CANCEL_ACTION_NAME

public static final String CANCEL_ACTION_NAME

See Also:

Constant Field Values

COMMIT_ACTION_NAME

public static final String COMMIT_ACTION_NAME

See Also:

Constant Field Values

Constructor Detail

BaseDialog

public BaseDialog()

Method Detail

getState

protected BaseDialogState getState()

Overrides:

getState in class com.vaadin.ui.AbstractComponent

closeSelf

public void closeSelf()

setWide

public void setWide(boolean isWide)

setDescriptionVisibility

public void setDescriptionVisibility(boolean isVisible)

setDialogDescription

public void setDialogDescription(String description)

iterator

public Iterator<com.vaadin.ui.Component> iterator()

Specified by:

iterator in interface com.vaadin.ui.HasComponents

Specified by:

iterator in interface Iterable<com.vaadin.ui.Component>

setContent

public void setContent(com.vaadin.ui.Component newContent)

setHeaderToolbar

public void setHeaderToolbar(com.vaadin.ui.Component newHeader)

setFooterToolbar

public void setFooterToolbar(com.vaadin.ui.Component newFooter)

adoptComponent

protected void adoptComponent(com.vaadin.ui.Component newContent)

Sets a Component

The composition root must be set to non-null value before the component can be used. The composition root can only be set once.

Parameters:

newContent - the root of the composition component tree.

getContent

public com.vaadin.ui.Component getContent()

setCaption

public void setCaption(String caption)

Specified by:

setCaption in interface com.vaadin.ui.Component

Overrides:

setCaption in class com.vaadin.ui.AbstractComponent

createDefaultContent

protected com.vaadin.ui.Component createDefaultContent()

createDefaultHeader

protected com.vaadin.ui.Component createDefaultHeader()

createDefaultFooter

protected com.vaadin.ui.Component createDefaultFooter()

showCloseButton

public void showCloseButton()

setModalityLevel

public void setModalityLevel(String modalityLevel)

setWideOnClient

public void setWideOnClient(boolean isWide)

addDescriptionVisibilityHandler

public void addDescriptionVisibilityHandler(BaseDialog.DescriptionVisibilityEvent.Handler handler)

removeDescriptionVisibilityHandler

public void removeDescriptionVisibilityHandler(BaseDialog.DescriptionVisibilityEvent.Handler handler)

addWideHandler

public void addWideHandler(BaseDialog.WideEvent.Handler handler)

removeWideHandler

public void removeWideHandler(BaseDialog.DialogCloseEvent.Handler handler)

addDialogCloseHandler

public void addDialogCloseHandler(BaseDialog.DialogCloseEvent.Handler handler)

removeDialogCloseHandler

public void removeDialogCloseHandler(BaseDialog.DialogCloseEvent.Handler handler)