Package com.levigo.jadice.web.shared.model.annotation

Class AnnotationPageSegmentEvent

java.lang.Object

com.levigo.jadice.document.AbstractDocumentEvent

com.levigo.jadice.document.AbstractPageEvent

com.levigo.jadice.document.PageSegmentEvent

com.levigo.jadice.web.shared.model.annotation.AnnotationPageSegmentEvent

public class AnnotationPageSegmentEvent
extends PageSegmentEvent

A semantic event which indicates the occurrence of annotation changes. This high-level event encapsulates information about the annotation changed and which type of change occurred and for annotation property changes the old and new value. If the new value is a primitive type (such as int or boolean) it must be wrapped as the corresponding java.lang.* Object type (such as Integer or Boolean). Null values may be provided for the old and the new values if their true values are not known.

The event is passed to a PageListener or DocumentListener object that is registered to receive such events using the Document.addDocumentListener(DocumentListener) or the Page.addPageListener(PageListener) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AnnotationPageSegmentEvent.EventType	Possible event type identifiers: Property related State related Mode related Action related

Nested classes/interfaces inherited from class com.levigo.jadice.document.PageSegmentEvent

PageSegmentEvent.Type

Constructor Summary

Constructors

Constructor	Description
AnnotationPageSegmentEvent(Page page, PageSegment segment, Annotation annotation, Annotation previousState, AnnotationPageSegmentEvent.EventType eventType, Object oldValue, Object newValue)	Constructor

Method Summary

Modifier and Type	Method	Description
Annotation	getAnnotation()	Gets the annotation concerned.
AnnotationPageSegmentEvent.EventType	getEventType()	Gets the event type of this event. See the following property identifier.
Object	getNewValue()	Gets the new value for the property, expressed as an Object.
Object	getOldValue()	Gets the old value for the property, expressed as an Object.
Annotation	getPreviousState()
String	toString()

Methods inherited from class com.levigo.jadice.document.PageSegmentEvent

getDamage, getDocument, getLayer, getPageSegment, getType, setDamage, setLayer, setPageSegment, setType

Methods inherited from class com.levigo.jadice.document.AbstractPageEvent

getPage, setPage

Methods inherited from class com.levigo.jadice.document.AbstractDocumentEvent

setDocument

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotationPageSegmentEvent

public AnnotationPageSegmentEvent(Page page,
 PageSegment segment,
 Annotation annotation,
 Annotation previousState,
 AnnotationPageSegmentEvent.EventType eventType,
 Object oldValue,
 Object newValue)

Constructor

Parameters:

page - within the page segment change happens

segment - the concerned page segment

annotation - the changed annotation

eventType - the type of the event

oldValue - old property value (optional, could be null)

newValue - new property value (optional, could be null)

Method Details

getPreviousState

public Annotation getPreviousState()

getAnnotation

public Annotation getAnnotation()

Gets the annotation concerned.

Returns:

Annotation

getEventType

public AnnotationPageSegmentEvent.EventType getEventType()

Gets the event type of this event.
See the following property identifier.

Returns:

the event type

See Also:

• AnnotationPageSegmentEvent.EventType

getNewValue

public Object getNewValue()

Gets the new value for the property, expressed as an Object.

Returns:

The new value for the property, expressed as an Object. May be null if multiple properties have changed or if mode or state changes happens.

getOldValue

public Object getOldValue()

Gets the old value for the property, expressed as an Object.

Returns:

The old value for the property, expressed as an Object. May be null if multiple properties have changed or if mode or state changes happens.

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()