Class TemplateTransformEvent
java.lang.Object
org.eclipse.birt.report.model.api.activity.NotificationEvent
org.eclipse.birt.report.model.api.command.TemplateTransformEvent
Notification event that says that transformation betweem a template element
and a report item or data set occurs. The target element is the container.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final org.eclipse.birt.report.model.core.ContainerContext
The slot within the container.Fields inherited from class org.eclipse.birt.report.model.api.activity.NotificationEvent
ATTRIBUTE_EVENT, CONTAINER, CONTENT_EVENT, CONTENT_REPLACE_EVENT, CONTENTS, CSS_EVENT, CSS_RELOADED_EVENT, CUSTOM_MSG_EVENT, DATA_DESIGN_RELOADED_EVENT, DATA_MART_PROPERTY_EVENT, deliveryPath, DESCENDENT, DIRECT, DISPOSE_EVENT, ELEMENT_CLIENT, ELEMENT_DELETE_EVENT, ELEMENT_LOCALIZE_EVENT, ENCRYPTION_EVENT, EXTENDS_EVENT, EXTENSION_PROPERTY_DEFINITION_EVENT, LAYOUT_CHANGED_EVENT, LIBRARY_CHANGE_EVENT, LIBRARY_EVENT, LIBRARY_RELOADED_EVENT, NAME_EVENT, NAME_SPACE_EVENT, PROPERTY_EVENT, sender, STRUCTURE_CLIENT, STYLE_CLIENT, STYLE_EVENT, target, TEMPLATE_TRANSFORM_EVENT, THEME_EVENT, USER_PROP_EVENT, VALIDATION_EVENT, VIEWS_CONTENT_EVENT
-
Constructor Summary
ConstructorsConstructorDescriptionTemplateTransformEvent
(org.eclipse.birt.report.model.core.ContainerContext containerInfo, org.eclipse.birt.report.model.core.DesignElement from, org.eclipse.birt.report.model.core.DesignElement to) /** Constructs the content replace event with the container element, from element, to element and the slot within this container. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the event type.getFrom()
Returns the element which this event transforms from.int
getSlot()
Returns the slot id within the container.getTo()
Returns the element which this event transforms to.boolean
isSame
(NotificationEvent event) Compares and justifies whether this event and the given event is the same.Methods inherited from class org.eclipse.birt.report.model.api.activity.NotificationEvent
getDeliveryPath, getSender, getTarget, setDeliveryPath, setSender, setTarget
-
Field Details
-
focus
protected final org.eclipse.birt.report.model.core.ContainerContext focusThe slot within the container.
-
-
Constructor Details
-
TemplateTransformEvent
public TemplateTransformEvent(org.eclipse.birt.report.model.core.ContainerContext containerInfo, org.eclipse.birt.report.model.core.DesignElement from, org.eclipse.birt.report.model.core.DesignElement to) /** Constructs the content replace event with the container element, from element, to element and the slot within this container.- Parameters:
containerInfo
- the container informationfrom
- the element which the transformation starts fromto
- the element which the transformation ends to
-
-
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 classNotificationEvent
- Returns:
- the event type.
-
getSlot
public int getSlot()Returns the slot id within the container.- Returns:
- the slot id within the container
-
getFrom
Returns the element which this event transforms from.- Returns:
- the element which this event transforms from.
-
getTo
Returns the element which this event transforms to.- Returns:
- the element which this event transforms to.
-
isSame
Description copied from class:NotificationEvent
Compares and justifies whether this event and the given event is the same.- Overrides:
isSame
in classNotificationEvent
- Parameters:
event
- the event to compare- Returns:
- true if the two events are the same, otherwise false
-