Class UserPropertyEvent

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

public class UserPropertyEvent extends NotificationEvent
Indicates a change to a user-defined property. Use the getAction() method to determine the specific kind of change.
  • Field Details

  • Constructor Details

    • UserPropertyEvent

      public UserPropertyEvent(org.eclipse.birt.report.model.core.DesignElement obj, UserPropertyDefn prop, int theAction)
      Constructor.
      Parameters:
      obj - the element that changed.
      prop - the property that changed.
      theAction - the action which causes this event: ADD, or DROP.
  • Method Details

    • getAction

      public int getAction()
      Returns the action that causes this event. One of ADD, or DROP.
      Returns:
      the action that causes this event.
    • getProperty

      public UserPropertyDefn getProperty()
      Returns the definition of the user-defined property that changed.
      Returns:
      the user-defined property definition.
    • 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.
    • isSame

      public boolean isSame(NotificationEvent event)
      Description copied from class: NotificationEvent
      Compares and justifies whether this event and the given event is the same.
      Overrides:
      isSame in class NotificationEvent
      Parameters:
      event - the event to compare
      Returns:
      true if the two events are the same, otherwise false