Package com.priint.pubserver.comet.bridge.preview

Annotation Interface CometPreviewStatementProperties

@Inherited @Documented @Retention(RUNTIME) @Target(METHOD) public @interface CometPreviewStatementProperties

The CometPreviewStatementProperties annotation allows additional information for methods tagged as PluginMethod.MethodType.PREVIEW_STATEMENT methods.

For examples please refer to the DemoPreviewStatement Plugin delivered with the PublishingServer developer stack.

  • Element Details

    • needsSelection

      boolean needsSelection

      Does this statement require selection?

      Tells whether this statement requires selection (i.e. a selected placeholder or entry in the product panel) or not.
      Default is true, which means, that this statement will only be executed, when an appropriate selection is available in the client application (panel or document).

      Returns:
      true, if the statement requires a selection, false otherwise
      Default:
      true

    • selectionTarget

      CometPreviewStatementProperties.SelectionTarget selectionTarget

      The target for selection.

      Target can be or SelectionTarget.PANEL or SelectionTarget.BOTH. In this case, the Document selection takes precedence over the panel selection.

      Returns:
      the selection target, default SelectionTarget.BOTH
      Default:
      BOTH

    • useParent

      boolean useParent

      Use the parent bucket IDs to process this statement.

      Use the parent bucket IDs to process this statement. If set to true, the IDs of the parent bucket will be used rather than the entity IDs.
      Default is false

      Returns:
      true, if parent IDs should be used, false otherwise.
      Default:
      false