public interface Preview
WE_API.PreviewExamples:
WE_API.Preview. reload()
; // reloads the current page
Modifier and Type | Interface and Description |
---|---|
static interface |
Preview.ElementReloadListener
Listener for events about reloaded elements in the preview document.
|
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)
Deprecated.
since 5.2, use
MPPWebControl.getParameter(String) instead |
JavaScriptObject |
getTimeParameter()
Deprecated.
since 5.2, use
MPPWebControl.getTimeParameter() instead |
JavaScriptObject |
getWindow()
Returns a reference to the current window object of the preview frame.
|
boolean |
isParameterized()
Deprecated.
since 5.2, use
MPPWebControl.isParameterized() instead |
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)
Deprecated.
since 5.2, use
MPPWebControl.setParameter(String,Object) instead |
void |
setTimeParameter(JavaScriptObject date)
Deprecated.
since 5.2, use
MPPWebControl.setTimeParameter(Object) instead |
void reload()
void reload(@Nullable Element element)
element
- element to reload.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){...});
listener
- listener to informvoid rescan(@Nullable Element element)
element
- element to scan for editor identifiers.void repaint()
@Nullable JavaScriptObject getWindow()
null
if currently not available@Deprecated boolean isParameterized()
MPPWebControl.isParameterized()
insteadtrue
if preview has parameter, false
otherwise.@Nullable @Deprecated Object getParameter(String name)
MPPWebControl.getParameter(String)
insteadname
- name of the preview parameter to get the value for.null
@Deprecated void setParameter(String name, @Nullable Object value)
MPPWebControl.setParameter(String,Object)
insteadname
- name of the preview parameter to set the value for.value
- parameter value, or null
@Nullable @Deprecated JavaScriptObject getTimeParameter()
MPPWebControl.getTimeParameter()
insteadDate
) object, or null
@Deprecated void setTimeParameter(JavaScriptObject date)
MPPWebControl.setTimeParameter(Object)
insteaddate
- the time (as javascript Date
) object, or null
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210