Interface PreviewOperation
public interface PreviewOperation
Operation providing means to control the preview in the original client.
- Since:
- 5.2.613
-
Field Summary
Modifier and TypeFieldDescriptionstatic final OperationType<PreviewOperation>
Operation providing means to control the preview in the original client. -
Method Summary
Modifier and TypeMethodDescriptionvoid
perform()
Starts the preview operation as configured.void
setElement
(@NotNull IDProvider element) Ensure the preview being shown belongs to the element defined.
-
Field Details
-
TYPE
Operation providing means to control the preview in the original client.- Since:
- 5.2.613
-
-
Method Details
-
setElement
Ensure the preview being shown belongs to the element defined.- Parameters:
element
- The element to show the preview for.- Throws:
OperationSetupException
- If the given element cannot be previewed for some reason, e.g., the element's type is not supported or there is no preview defined for the element.- Since:
- 5.2.613
-
perform
void perform()Starts the preview operation as configured. By default, currently shown preview will be refreshed/reloaded.- Since:
- 5.2.613
-