Package de.aristaflow.adept2.model.graphical

Interface RenderOptions

All Superinterfaces:
Serializable
public interface RenderOptions extends Serializable
Various options for rendering process elements as images.
Author:
Ulrich Kreher

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final long
    serialVersionUID
    Generated ID for serialisation.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    dataEdgesVisible()
    Gets whether data edges of the process template should be rendered.
    boolean
    dataElementsVisible()
    Gets whether data elements of the process template should be rendered.
    boolean
    dataFlowLaneVisible()
    Gets whether the data flow lane (part displaying data elements and edges) is visible.
    boolean
    decisionDataEdgesVisible()
    Gets whether edges of decision data elements of the process template should be rendered.
    boolean
    decisionDataElementsVisible()
    Gets whether decision data elements of the process template should be rendered.
    Map<String,String>
    getAdvancedOptions()
    Gets advanced options for rendering the image.
    int
    getHeight()
    Gets the desired height for the returned image.
    String
    getType()
    Gets the type of the image to create.
    Rectangle
    getViewPort()
    Gets the part of the rendered image that is to be returned.
    int
    getWidth()
    Gets the desired width for the returned image.
    boolean
    hiddenNodesVisible()
    Gets whether hidden nodes of the process template should be rendered.
    boolean
    syncEdgesVisible()
    Gets whether synchronisation edges of the process template should be rendered.
    boolean
    systemDataEdgesVisible()
    Gets whether system data edges of the process template should be rendered.
    boolean
    systemDataElementsVisible()
    Gets whether system data elements of the process template should be rendered.

  • Field Details

    • serialVersionUID

      static final long serialVersionUID
      Generated ID for serialisation.
      See Also:

  • Method Details

    • getType

      String getType()
      Gets the type of the image to create.
      Returns:
      The type of the image to create.
      See Also:

    • getWidth

      int getWidth()
      Gets the desired width for the returned image. The rendered image is scaled appropriately. If this is 0 or negative, no scaling for the width will take place.
      Returns:
      The desired width for the returned image, it will be scaled appropriately.

    • getHeight

      int getHeight()
      Gets the desired height for the returned image. The rendered image is scaled appropriately. If this is 0 or negative, no scaling for the height will take place.
      Returns:
      The desired height for the returned image, it will be scaled appropriately.

    • getViewPort

      Rectangle getViewPort()
      Gets the part of the rendered image that is to be returned. This allows for retrieving details of a big image. Use null for retrieving the complete rendered image.
      Returns:
      The part of the rendered image that is to be returned or null for the complete image.

    • dataEdgesVisible

      boolean dataEdgesVisible()
      Gets whether data edges of the process template should be rendered.
      Returns:
      Whether data edges of the process template should be rendered.

    • dataElementsVisible

      boolean dataElementsVisible()
      Gets whether data elements of the process template should be rendered.
      Returns:
      Whether data elements of the process template should be rendered.

    • systemDataEdgesVisible

      boolean systemDataEdgesVisible()
      Gets whether system data edges of the process template should be rendered.
      Returns:
      Whether system data edges of the process template should be rendered.

    • systemDataElementsVisible

      boolean systemDataElementsVisible()
      Gets whether system data elements of the process template should be rendered.
      Returns:
      Whether system data elements of the process template should be rendered.

    • decisionDataEdgesVisible

      boolean decisionDataEdgesVisible()
      Gets whether edges of decision data elements of the process template should be rendered.
      Returns:
      Whether edges of decision data elements of the process template should be rendered.

    • decisionDataElementsVisible

      boolean decisionDataElementsVisible()
      Gets whether decision data elements of the process template should be rendered.
      Returns:
      Whether decision data elements of the process template should be rendered.

    • dataFlowLaneVisible

      boolean dataFlowLaneVisible()
      Gets whether the data flow lane (part displaying data elements and edges) is visible. If not, there will be no whitespace for data elements and edges. This is only allowed if all data elements and edges are hidden. If any data flow element is visible, this value will be ignored.
      Returns:
      Whether the data flow lane (part displaying data elements and edges) is visible.

    • syncEdgesVisible

      boolean syncEdgesVisible()
      Gets whether synchronisation edges of the process template should be rendered.
      Returns:
      Whether synchronisation edges of the process template should be rendered.

    • hiddenNodesVisible

      boolean hiddenNodesVisible()
      Gets whether hidden nodes of the process template should be rendered.
      Returns:
      Whether hidden nodes of the process template should be rendered.

    • getAdvancedOptions

      Map<String,String> getAdvancedOptions()
      Gets advanced options for rendering the image. These options depend on the used rendering implementation. For no advanced options use the empty map.

      The main implementation using advanced options is UISettings.

      Returns:
      Advanced options for rendering the image depending on the used rendering implementation or the empty map.