de.espirit.firstspirit.webedit.client.api

Interface Preview

public interface Preview

FirstSpirit WebEdit Javascript Preview API, accessible via

    WE_API.Preview

Examples:

WE_API.Preview.reload();   // reloads the current page

Since:

5.0.106

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Preview.ElementReloadListener Listener for events about reloaded elements in the preview document.

Method Summary

Methods

Modifier and Type	Method and Description
void	addElementReloadListener(Preview.ElementReloadListener listener) Registers a listener for events about reloaded elements in the current preview document.
Object	getParameter(String name) Returns the current value of the specified preview parameter.
JavaScriptObject	getTimeParameter() Returns the current time the user has chosen using the preview timeline.
JavaScriptObject	getWindow() Returns a reference to the current window object of the preview frame.
boolean	isParameterized() Returns whether or not the current preview parametrization is enabled by the user.
void	reload() Reloads the current page.
void	reload(Element element) Reloads the given element.
void	repaint() Repaints the editor highlighting.
void	rescan(Element element) Searches in the specified element for new editor identifiers.
void	setParameter(String name, Object value) Sets the current value of the specified preview parameter.
void	setTimeParameter(JavaScriptObject date) Set the time that should be used for preview.

Method Detail

reload

void reload()

Reloads the current page.

Since:

5.0.106

reload

void reload(@Nullable
          Element element)

Reloads the given element. The nearest surrounding editor identifier will influence whether or not the preview will be reloaded partly.

Parameters:

element - element to reload.

Since:

5.0.106

addElementReloadListener

void addElementReloadListener(Preview.ElementReloadListener listener)

Registers a listener for events about reloaded elements in the current preview document.

Listener registration in JavaScript might look like:
...addElementReloadListener(function(element){...});

Parameters:

listener - listener to inform

Since:

5.1.37

rescan

void rescan(@Nullable
          Element element)

Searches in the specified element for new editor identifiers.

Parameters:

element - element to scan for editor identifiers.

Since:

5.1.37

repaint

void repaint()

Repaints the editor highlighting.

Since:

5.1.38

getWindow

@Nullable
JavaScriptObject getWindow()

Returns a reference to the current window object of the preview frame.

Returns:

window, or null if currently not available

Since:

5.1.302

isParameterized

boolean isParameterized()

Returns whether or not the current preview parametrization is enabled by the user.

Returns:

true if preview has parameter, false otherwise.

Since:

5.1.30

getParameter

@Nullable
Object getParameter(String name)

Returns the current value of the specified preview parameter.

Parameters:

name - name of the preview parameter to get the value for.

Returns:

parameter value, or null

Since:

5.1.30

setParameter

void setParameter(String name,
                @Nullable
                Object value)

Sets the current value of the specified preview parameter.

Parameters:

name - name of the preview parameter to set the value for.

value - parameter value, or null

Since:

5.1.30

getTimeParameter

@Nullable
JavaScriptObject getTimeParameter()

Returns the current time the user has chosen using the preview timeline.

Returns:

the current time (as javascript Date) object, or null

Since:

5.1.30

setTimeParameter

void setTimeParameter(JavaScriptObject date)

Set the time that should be used for preview.

Parameters:

date - the time (as javascript Date) object, or null

Since:

5.1.30