info.magnolia.ui.preview

Class AbstractItemPreviewComponent<T>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.CustomComponent

info.magnolia.ui.preview.AbstractItemPreviewComponent<T>

Type Parameters:

T - the item type to preview.

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, ItemPreviewComponent<T>, Serializable, Iterable<com.vaadin.ui.Component>

public abstract class AbstractItemPreviewComponent<T>
extends com.vaadin.ui.CustomComponent
implements ItemPreviewComponent<T>

Abstract implementation of ItemPreviewComponent. An item preview usually consists of two parts

• image preview: an image, if any, representing the item
• details: e.g. item properties and their respective values

See Also:

Serialized Form

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vaadin.ui.Layout	rootLayout

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
AbstractItemPreviewComponent(info.magnolia.i18nsystem.SimpleTranslator i18n, PropertySetFactory<T> propertySetFactory, PreviewProvider<T> previewProvider, Map<String,Class> properties)

Method Summary

Modifier and Type	Method and Description
protected void	clearRootLayout()
protected abstract com.vaadin.ui.Component	createDetailComponent(String propertyName, Object value)
protected info.magnolia.i18nsystem.SimpleTranslator	getI18n()
protected PreviewProvider<T>	getPreviewProvider()
protected com.vaadin.data.PropertySet<T>	getPropertySet()
protected com.vaadin.ui.Layout	getRootLayout()
void	onValueChange(T item) Will typically display or update details about this item.
protected com.vaadin.ui.Component	refreshItemDetail(T item) Refreshes the item detail.
protected com.vaadin.ui.Component	refreshItemPreview(T item) Refreshes the item preview.
protected void	refreshRootLayout()

Methods inherited from class com.vaadin.ui.CustomComponent

getComponentCount, getCompositionRoot, getState, getState, iterator, setCompositionRoot

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, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, readDesign, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined, writeDesign

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, 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, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

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, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, 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, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

rootLayout

protected final com.vaadin.ui.Layout rootLayout

Constructor Detail

AbstractItemPreviewComponent

@Inject
public AbstractItemPreviewComponent(info.magnolia.i18nsystem.SimpleTranslator i18n,
                                            PropertySetFactory<T> propertySetFactory,
                                            PreviewProvider<T> previewProvider,
                                            Map<String,Class> properties)

Method Detail

getRootLayout

protected com.vaadin.ui.Layout getRootLayout()

onValueChange

public void onValueChange(T item)

Description copied from interface: ItemPreviewComponent

Will typically display or update details about this item.

Specified by:

onValueChange in interface ItemPreviewComponent<T>

refreshItemDetail

protected com.vaadin.ui.Component refreshItemDetail(T item)

Refreshes the item detail. This method is triggered by ItemPreviewComponent.onValueChange(Object) in case of value changes.

createDetailComponent

protected abstract com.vaadin.ui.Component createDetailComponent(String propertyName,
                                                                 Object value)

Returns:

typically a Label displaying an i18n-ised, human-readable property name and its value.

refreshItemPreview

protected com.vaadin.ui.Component refreshItemPreview(T item)

Refreshes the item preview. This method is triggered by ItemPreviewComponent.onValueChange(Object)} in case of value changes.

clearRootLayout

protected void clearRootLayout()

refreshRootLayout

protected void refreshRootLayout()

getPropertySet

protected com.vaadin.data.PropertySet<T> getPropertySet()

getI18n

protected info.magnolia.i18nsystem.SimpleTranslator getI18n()

getPreviewProvider

protected PreviewProvider<T> getPreviewProvider()