Package com.inet.html

Class InetHtmlDocument.ExtendedDocuementEvent

java.lang.Object

javax.swing.undo.AbstractUndoableEdit

javax.swing.undo.CompoundEdit

javax.swing.text.AbstractDocument.DefaultDocumentEvent

com.inet.html.InetHtmlDocument.ExtendedDocuementEvent

All Implemented Interfaces:

Serializable, DocumentEvent, UndoableEdit

Enclosing class:

InetHtmlDocument

public class InetHtmlDocument.ExtendedDocuementEvent
extends AbstractDocument.DefaultDocumentEvent

Extends the DefaultDocumentEvent to support the update events by grouping the changes by paragraph element. This is required to avoid problems with the different structure of view and model.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface javax.swing.event.DocumentEvent

DocumentEvent.ElementChange, DocumentEvent.EventType

Field Summary

Fields inherited from class javax.swing.undo.CompoundEdit

edits

Fields inherited from class javax.swing.undo.AbstractUndoableEdit

RedoName, UndoName

Constructor Summary

Constructors

Constructor	Description
ExtendedDocuementEvent(int offs, int len, int contentChangeStart, int contentChangeLen, DocumentEvent.EventType type, InetHtmlDocument document)	Generates a Document event for a complex change.
ExtendedDocuementEvent(int offs, int len, int contentChangeLen, DocumentEvent.EventType type, InetHtmlDocument document)	Generates a Document event.
ExtendedDocuementEvent(int offs, int len, DocumentEvent.EventType type, InetHtmlDocument document)	Generates a Document event.

Method Summary

Modifier and Type	Method	Description
boolean	addEdit(UndoableEdit anEdit)
ArrayList<UndoableEdit>	getAllChanges()	Returns a list of all changes registered to this event
ArrayList<DocumentEvent.ElementChange>	getEditsFor(Element paragraph)	Returns all edits for paragraph
int	getStructureChangeLen()	Returns the length of the structural change.
int	getStructureChangeStart()	Returns the start of the structural change.
DocumentEvent.EventType	getType()
boolean	hasEditsFor(Element paragraph)
void	redo()
void	undo()

Methods inherited from class javax.swing.text.AbstractDocument.DefaultDocumentEvent

getChange, getDocument, getLength, getOffset, getPresentationName, getRedoPresentationName, getUndoPresentationName, isSignificant, toString

Methods inherited from class javax.swing.undo.CompoundEdit

canRedo, canUndo, die, end, isInProgress, lastEdit

Methods inherited from class javax.swing.undo.AbstractUndoableEdit

replaceEdit

Methods inherited from class java.lang.Object

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

Constructor Details

ExtendedDocuementEvent

public ExtendedDocuementEvent(int offs,
 int len,
 DocumentEvent.EventType type,
 InetHtmlDocument document)

Generates a Document event.

Parameters:

offs - the offset into the document of the change >= 0

len - the length of the change >= 0

type - the type of event (DocumentEvent.EventType)

document - The enclosing document

ExtendedDocuementEvent

public ExtendedDocuementEvent(int offs,
 int len,
 int contentChangeLen,
 DocumentEvent.EventType type,
 InetHtmlDocument document)

Generates a Document event.

Parameters:

offs - the offset within the document where the structural change starts

len - the length of the change structural >= 0

contentChangeLen - the length of content added/removed

type - the type of event (DocumentEvent.EventType)

document - The enclosing document

ExtendedDocuementEvent

public ExtendedDocuementEvent(int offs,
 int len,
 int contentChangeStart,
 int contentChangeLen,
 DocumentEvent.EventType type,
 InetHtmlDocument document)

Generates a Document event for a complex change. The difference between the user and the change length is due to the required structural changes. E.g. a simple removal a the end of a line

Parameters:

offs - the original start offset as defined by the user/caret

len - original length of the change as defined by the user/caret

contentChangeStart - the first position where something is different now, must be <= offset

contentChangeLen - the length of the actual change, must be >= len

type - the type of event (DocumentEvent.EventType)

document - The enclosing document

Method Details

getStructureChangeLen

public int getStructureChangeLen()

Returns the length of the structural change. If the content change length is not explicitly set, it returns the normal getLength()

Returns:

the structure or content change length

getStructureChangeStart

public int getStructureChangeStart()

Returns the start of the structural change. If the content start length is not explicitly set, it returns the normal getOffset()

Returns:

the structure or content change start

addEdit

public boolean addEdit(UndoableEdit anEdit)

Specified by:

addEdit in interface UndoableEdit

Overrides:

addEdit in class AbstractDocument.DefaultDocumentEvent

getAllChanges

public ArrayList<UndoableEdit> getAllChanges()

Returns a list of all changes registered to this event

Returns:

a list of all changes registered to this event

hasEditsFor

public boolean hasEditsFor(Element paragraph)

Parameters:

paragraph - The paragraph to get the edits for

Returns:

true, if any element edits are registered for this paragraph

getEditsFor

public ArrayList<DocumentEvent.ElementChange> getEditsFor(Element paragraph)

Returns all edits for paragraph

Parameters:

paragraph - The paragraph to get the edits for

Returns:

all edits for paragraph or null if none were registered

getType

public DocumentEvent.EventType getType()

Specified by:

getType in interface DocumentEvent

Overrides:

getType in class AbstractDocument.DefaultDocumentEvent

undo

public void undo()
          throws CannotUndoException

Specified by:

undo in interface UndoableEdit

Overrides:

undo in class AbstractDocument.DefaultDocumentEvent

Throws:

CannotUndoException

redo

public void redo()
          throws CannotUndoException

Specified by:

redo in interface UndoableEdit

Overrides:

redo in class AbstractDocument.DefaultDocumentEvent

Throws:

CannotUndoException