UpdatePropertiesHandler.d.ts 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. /**
  2. * A handler that implements a BPMN 2.0 property update.
  3. *
  4. * This should be used to set simple properties on elements with
  5. * an underlying BPMN business object.
  6. *
  7. * Use respective diagram-js provided handlers if you would
  8. * like to perform automated modeling.
  9. *
  10. * @implements {CommandHandler}
  11. *
  12. */
  13. export default class UpdatePropertiesHandler implements CommandHandler {
  14. static $inject: string[];
  15. /**
  16. * @param elementRegistry
  17. * @param moddle
  18. * @param translate
  19. * @param modeling
  20. * @param textRenderer
  21. */
  22. constructor(elementRegistry: ElementRegistry, moddle: Moddle, translate: Translate, modeling: Modeling, textRenderer: TextRenderer);
  23. /**
  24. * Update a BPMN element's properties.
  25. *
  26. * @param context
  27. *
  28. * @return
  29. */
  30. execute(context: {
  31. element: Element;
  32. properties: Record<string, any>;
  33. } & CommandContext): Element[];
  34. postExecute(context: any): void;
  35. /**
  36. * Revert updating a BPMN element's properties.
  37. *
  38. * @param context
  39. *
  40. * @return
  41. */
  42. revert(context: {
  43. element: Element;
  44. properties: Record<string, any>;
  45. oldProperties: Record<string, any>;
  46. } & CommandContext): Element[];
  47. }
  48. type CommandHandler = import('diagram-js/lib/command/CommandHandler').default;
  49. type CommandContext = import('diagram-js/lib/command/CommandStack').CommandContext;
  50. type ElementRegistry = import('diagram-js/lib/core/ElementRegistry').default;
  51. type Moddle = import('../../../model/Types').Moddle;
  52. export type Translate = typeof import("diagram-js/lib/i18n/translate/translate").default;
  53. type Modeling = import('../Modeling').default;
  54. type TextRenderer = import('../../../draw/TextRenderer').default;
  55. type Element = import('../../../model/Types').Element;