Class CustomMsgEvent

java.lang.Object
org.eclipse.birt.report.model.api.activity.NotificationEvent
org.eclipse.birt.report.model.api.command.CustomMsgEvent

public class CustomMsgEvent extends NotificationEvent
Notification event that says that the contents of user-defined message is added, dropped, or changed. The target element is the report design.
  • Field Details

  • Constructor Details

    • CustomMsgEvent

      public CustomMsgEvent(org.eclipse.birt.report.model.elements.ReportDesign design, org.eclipse.birt.report.model.elements.Translation translation, int theAction)
      Constructs the event with the user-defined message and the action causing this event.
      Parameters:
      design - the report design
      translation - the user-defined message
      theAction - the action causing this event.
  • Method Details

    • getEventType

      public int getEventType()
      Description copied from class: NotificationEvent
      Returns the event type. The following event types are defined:
      • CONTENT_EVENT
      • ELEMENT_DELETE_EVENT
      • EXTENDS_EVENT
      • NAME_EVENT
      • NAME_SPACE_EVENT
      • PROPERTY_EVENT
      • STYLE_EVENT
      • USER_PROP_EVENT
      • CUSTOM_MSG_EVENT
      • EXTENSION_PROPERTY_DEFINITION_EVENT
      • NOTIFICATION_EVENT
      • VALIDATION_EVENT
      • LIBRARY_EVENT
      • ATTRIBUTE_EVENT
      • DISPOSE_EVENT
      • CONTENT_REPLACE_EVENT
      • TEMPLATE_TRANSFORM_EVENT
      Specified by:
      getEventType in class NotificationEvent
      Returns:
      the event type.
    • getAction

      public int getAction()
      Returns the action causing this event. One of ADD, DROP, or CHANGE.
      Returns:
      the action causing this event.
    • getTranslation

      public org.eclipse.birt.report.model.elements.Translation getTranslation()
      Returns the user-defined message that changes.
      Returns:
      the user-defined message that changes.