de.hybris.platform.cmscockpit.components.liveedit

Class LiveEditView<T extends LiveEditPopupEditDialog>

java.lang.Object

de.hybris.platform.cmscockpit.components.liveedit.LiveEditView<T>

Direct Known Subclasses:

DefaultLiveEditView

public class LiveEditView<T extends LiveEditPopupEditDialog>
extends java.lang.Object

Controller of (live edit) preview of a site.

Note:
We using this component for displaying a preview of particular web application within cmscockpit in following modes:

• displaying preview of particular page in WCMS Page perspective
• displaying live edit session in Live Edit perspective

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LiveEditView.DesktopRefreshContentHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CALLBACK_EVENT
protected static java.lang.String	LIVE_EDIT_BROWSER_SCLASS
protected static java.lang.String	ON_INIT_EVENT
protected static java.lang.String	ON_INVALIDATE_LATER_EVENT
static java.lang.String	URL_CHANGE_EVENT

Constructor Summary

Constructors

Constructor and Description
LiveEditView(DefaultLiveEditViewModel model)
LiveEditView(DefaultLiveEditViewModel model, Div welcomePanel)

Method Summary

Modifier and Type	Method and Description
protected void	addEventListeners() Adds all required events handling i.e: user special events init events invalidate event
protected java.lang.String	extractRequestPath(java.lang.String longUrl) Extracts request path from long URL (request path with query search)
Iframe	getContentFrame() Returns content frame component - for access it from outside
protected EventListener	getIniEventListener() Returns event listener for handling init events Note: This is used for proper initialize live edit view - within preview mode we to update view in order to make content visible.
protected EventListener	getInvalidateListener() Returns event listener for handling invalidate events Note: This is used for invalidate frame content
DefaultLiveEditViewModel	getModel()
LiveEditPopupEditDialog	getPopupEditorDialog()
protected EventListener	getUserEventListener() Returns event listener for handling user events Note: This is used for handling user events such like: displaying popup dialog with proper content editors reacts when user change URL within content frame (this is used for keeping cmscockpit up-to-date with current URL from content frame)
HtmlBasedComponent	getViewComponent() Returns the ZK component of the site preview.
protected Div	getWelcomePanel()
void	initialize() Initialize live edit view (i.e.
protected Iframe	initializeContentFrame() Initialize live edit content iframe
protected Div	initializeViewComponent() Initialize the main view component for the live edit
protected HtmlBasedComponent	loadWelcomePanel(HtmlBasedComponent parent) Loads welcome panel if any
protected void	refreshContentFrame()
protected void	refreshWelcomePanel() Refreshes welcome panel when it is available Note: This is disjoint with content frame i.e.
void	setPopupEditorDialog(T popupEditorDialog)
void	setWelcomePanel(Div welcomePanel)
void	update() Performs general update.
void	updateItem(TypedObject item, java.util.Set<PropertyDescriptor> modifiedProperties, java.lang.Object reason) Performs update according to given item modifications

Methods inherited from class java.lang.Object

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

Field Detail

ON_INIT_EVENT

protected static final java.lang.String ON_INIT_EVENT

See Also:

Constant Field Values

CALLBACK_EVENT

public static final java.lang.String CALLBACK_EVENT

See Also:

Constant Field Values

URL_CHANGE_EVENT

public static final java.lang.String URL_CHANGE_EVENT

See Also:

Constant Field Values

LIVE_EDIT_BROWSER_SCLASS

protected static final java.lang.String LIVE_EDIT_BROWSER_SCLASS

See Also:

Constant Field Values

ON_INVALIDATE_LATER_EVENT

protected static final java.lang.String ON_INVALIDATE_LATER_EVENT

See Also:

Constant Field Values

Constructor Detail

LiveEditView

public LiveEditView(DefaultLiveEditViewModel model)

LiveEditView

public LiveEditView(DefaultLiveEditViewModel model,
                    Div welcomePanel)

Method Detail

initialize

public void initialize()

Initialize live edit view (i.e. creates content frame, loads welcome panel - if any, send init event)

Note:
Should be called after instantiation.

initializeViewComponent

protected Div initializeViewComponent()

Initialize the main view component for the live edit

initializeContentFrame

protected Iframe initializeContentFrame()

Initialize live edit content iframe

addEventListeners

protected void addEventListeners()

Adds all required events handling i.e:

• user special events
• init events
• invalidate event

getViewComponent

public HtmlBasedComponent getViewComponent()

Returns the ZK component of the site preview.

Returns:

ZK component of the site preview

getContentFrame

public Iframe getContentFrame()

Returns content frame component - for access it from outside

Returns:

content frame component

getModel

public DefaultLiveEditViewModel getModel()

setWelcomePanel

public void setWelcomePanel(Div welcomePanel)

getIniEventListener

protected EventListener getIniEventListener()

Returns event listener for handling init events

Note:
This is used for proper initialize live edit view - within preview mode we to update view in order to make content visible. When we are within preview mode then LiveEditViewModel.getCurrentPreviewData() return null

Returns:

instance of EventListener

See Also:

ON_INIT_EVENT

getInvalidateListener

protected EventListener getInvalidateListener()

Returns event listener for handling invalidate events

Note:
This is used for invalidate frame content

Returns:

instance of EventListener

See Also:

ON_INVALIDATE_LATER_EVENT

getUserEventListener

protected EventListener getUserEventListener()

Returns event listener for handling user events

Note:
This is used for handling user events such like:

• displaying popup dialog with proper content editors
• reacts when user change URL within content frame (this is used for keeping cmscockpit up-to-date with current URL from content frame)

Returns:

instance of EventListener

refreshWelcomePanel

protected void refreshWelcomePanel()

Refreshes welcome panel when it is available

Note:
This is disjoint with content frame i.e. when we displaying welcome page we also hide content frame at once and contrarywise

refreshContentFrame

protected void refreshContentFrame()

update

public void update()

Performs general update.

updateItem

public void updateItem(TypedObject item,
                       java.util.Set<PropertyDescriptor> modifiedProperties,
                       java.lang.Object reason)

Performs update according to given item modifications

Parameters:

item - modified item

modifiedProperties - modified properties of the item

extractRequestPath

protected java.lang.String extractRequestPath(java.lang.String longUrl)

Extracts request path from long URL (request path with query search)

Parameters:

longUrl - request path with query search

Returns:

extracted request path

loadWelcomePanel

protected HtmlBasedComponent loadWelcomePanel(HtmlBasedComponent parent)

Loads welcome panel if any

Parameters:

parent - parent component

Returns:

current welcome panel component

getWelcomePanel

protected Div getWelcomePanel()

Returns:

the welcomePanel

getPopupEditorDialog

public LiveEditPopupEditDialog getPopupEditorDialog()

setPopupEditorDialog

public void setPopupEditorDialog(T popupEditorDialog)