Package de.xima.fc.interfaces.workflow.mixin

Interface IKeyValueSummarizableElement<TData,​TElement extends IWorkflowElementEntity>

    • Method Detail

      • getElementSummaryKeyValueModel

        ISummaryKeyValueModel getElementSummaryKeyValueModel​(IGetElementSummaryParams<TData> params)
        Parameters:
        params - The custom properties of the node or trigger.
        Returns:
        A list of key value pairs to display in a table in the overview panel.

      • getElementSummaryModel

        default Serializable getElementSummaryModel​(IGetElementSummaryParams<TData> params)
        Description copied from interface: IElementHandler
        When the user clicks on the info icon of a node or trigger, an panel with a quick summary of that node or trigger opens. By default, this panel only shows the available values returned by the node and which errors it can throw. You can implement IElementHandler.getElementSummaryXhtml() to include a custom summary of the element's current properties. If you do, you should also override this method. It must create the view model for the XHTML page. The value returned by this method is passed to the XHTML page via the expression language variable model.

        If you wish to display a quick summary as a list of key value pairs derived directly from the properties model, consider using the mixin IKeyValueSummarizableElement.

        Specified by:
        getElementSummaryModel in interface IElementHandler<TData,​TElement extends IWorkflowElementEntity>
        Parameters:
        params - The current properties model of the node or trigger.
        Returns:
        The view model for the summary. When null, no summary is displayed.

      • getElementSummaryXhtml

        default URL getElementSummaryXhtml()
                            throws MalformedURLException
        Description copied from interface: IElementHandler
        When the user clicks on the info icon of a node or trigger, an panel with a quick summary of that node or trigger opens. By default, this panel only shows the available values returned by the node and which errors it can throw. You can implement this method to include a custom summary of the element's current properties. If you do, you should also override IElementHandler.getElementSummaryModel(IGetElementSummaryParams).

        This method should return the path to the XHTML page for the custom workflow element summary that is shown in an overlay when the user click on the info icon on a node or trigger. Usually the XHTML file is part of the JAR resources of the module or plugin. In this case, you should return an URL to a JAR file resource (jar:file:/...) like so: 

         @Override
 public URL getXhtmlView() {
   return getClass().getResource("/path/to/view.xhtml");
 }

        The XHTML page should be a passive view without any interaction. The following to variables are made available to the XHTML page:

        Specified by:
        getElementSummaryXhtml in interface IElementHandler<TData,​TElement extends IWorkflowElementEntity>
        Returns:
        The XHTML page for the custom element summary. When null, no summary is displayed.
        Throws:
        MalformedURLException - When the URL could not be created. When this exception is thrown, it is treated as if null had been returned.