Package com.nomagic.magicdraw.datamarkingsandclassification.banner

Class DataMarkingBannerHelper

java.lang.Object

com.nomagic.magicdraw.datamarkingsandclassification.banner.DataMarkingBannerHelper

@OpenApiAll
public class DataMarkingBannerHelper
extends Object

Provides API for updating and creating Data Marking banners.

updateBannerWithStatus(Project, String, ProgressStatus, boolean, DiagramPresentationElement...) Updates banners in same way as UI action. Also shows same notification.

updateBanner(ProgressStatus, boolean, DiagramPresentationElement...) Updates banner and returns BannerUpdateResult which allows handling of update results like showing of notification in a custom way. Does not start session.

Constructor Summary

Constructors

Constructor	Description
DataMarkingBannerHelper()

Method Summary

Modifier and Type	Method	Description
static BannerUpdateResult	updateBanner(ProgressStatus status, boolean skipDiagramsWithoutBanners, DiagramPresentationElement... diagramPresentationElements)	Function to create or update diagram data markings banner.
static void	updateBannerWithStatus(Project project, String sessionName, ProgressStatus status, boolean skipDiagramsWithoutBanners, DiagramPresentationElement... diagramPresentationElements)	Function to create or update diagram data markings banner.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DataMarkingBannerHelper

public DataMarkingBannerHelper()

Method Details

updateBannerWithStatus

public static void updateBannerWithStatus(Project project,
 String sessionName,
 @CheckForNull
 ProgressStatus status,
 boolean skipDiagramsWithoutBanners,
 DiagramPresentationElement... diagramPresentationElements)

Function to create or update diagram data markings banner. This is same function as used from UI and will show same notification.

Parameters:

project - project

sessionName - name for session

status - progress status. Can be null.

skipDiagramsWithoutBanners - if true will skip diagrams without banners making it only update banners that already exists.

diagramPresentationElements - diagram presentation elements to update data marking banners of.

updateBanner

public static BannerUpdateResult updateBanner(@CheckForNull
 ProgressStatus status,
 boolean skipDiagramsWithoutBanners,
 DiagramPresentationElement... diagramPresentationElements)

Function to create or update diagram data markings banner. Does not create session.

Parameters:

status - progress status. Can be null.

skipDiagramsWithoutBanners - if true will skip diagrams without banners making it only update banners that already exists.

diagramPresentationElements - diagram presentation elements to update data marking banners of.

Returns:

returns BannerUpdateResult for further processing like showing custom notification.