org.eclipse.birt.report.model.api.command
Class ContentReplaceEvent

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

public class ContentReplaceEvent
extends NotificationEvent

Notification event that says that one content of a container have been replaced by another one. The target element is the container.

Field Summary

protected org.eclipse.birt.report.model.core.ContainerContext

focus The container information.

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

ContentReplaceEvent(org.eclipse.birt.report.model.core.ContainerContext containerInfo, org.eclipse.birt.report.model.core.DesignElement theOld, org.eclipse.birt.report.model.core.DesignElement theNew)
/** Constructs the content replace event with the container element, old element, new element and the slot within this container.

ContentReplaceEvent(org.eclipse.birt.report.model.core.DesignElement theContainer, org.eclipse.birt.report.model.core.DesignElement theOld, org.eclipse.birt.report.model.core.DesignElement theNew, int theSlot)
Deprecated. since birt 2.2 replaced by ContentReplaceEvent(ContainerContext, DesignElement, DesignElement)

Method Summary

int	getEventType() Returns the event type.
IDesignElement	getNewElement() Returns the new element causing this event.
IDesignElement	getOldElement() Returns the old element causing this event.
int	getSlot() Returns the slot id within the container.

Methods inherited from class org.eclipse.birt.report.model.api.activity.NotificationEvent

getDeliveryPath, getSender, getTarget, isSame, setDeliveryPath, setSender, setTarget

Methods inherited from class java.lang.Object

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

Field Detail

focus

protected final org.eclipse.birt.report.model.core.ContainerContext focus

The container information.

Constructor Detail

ContentReplaceEvent

public ContentReplaceEvent(org.eclipse.birt.report.model.core.DesignElement theContainer,
                           org.eclipse.birt.report.model.core.DesignElement theOld,
                           org.eclipse.birt.report.model.core.DesignElement theNew,
                           int theSlot)

Deprecated. since birt 2.2 replaced by ContentReplaceEvent(ContainerContext, DesignElement, DesignElement)

/** Constructs the content replace event with the container element, old element, new element and the slot within this container.

Parameters:

theContainer - the container element

theOld - the old element replaced

theNew - the new element

theSlot - the slot within the container

ContentReplaceEvent

public ContentReplaceEvent(org.eclipse.birt.report.model.core.ContainerContext containerInfo,
                           org.eclipse.birt.report.model.core.DesignElement theOld,
                           org.eclipse.birt.report.model.core.DesignElement theNew)

/** Constructs the content replace event with the container element, old element, new element and the slot within this container.

Parameters:

containerInfo - the container information

theOld - the old element replaced

theNew - the new element

Method Detail

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.

getSlot

public int getSlot()

Returns the slot id within the container.

Returns:

the slot id within the container

getOldElement

public IDesignElement getOldElement()

Returns the old element causing this event.

Returns:

the old element causing this event.

getNewElement

public IDesignElement getNewElement()

Returns the new element causing this event.

Returns:

the new element causing this event.