com.xmlmind.xmledit.edit

Class MarkManager

java.lang.Object

com.xmlmind.util.PropertySet

com.xmlmind.xmledit.edit.MarkManager

All Implemented Interfaces:

DocumentListener

public class MarkManager
extends PropertySet
implements DocumentListener

Manages a set of marks put on nodes or on characters inside textual nodes of a given document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarkManager.CompareByPosition Compares two TextLocations by their document position.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	autoAddingDot
static MarkManager.CompareByPosition	COMPARE_BY_POSITION A ready-to-use CompareByPosition instance.
XMLClipboard	xmlClipboard

Fields inherited from class com.xmlmind.util.PropertySet

properties

Constructor Summary

Constructors

Constructor and Description
MarkManager(XMLClipboard xmlClipboard, boolean autoAddingDot, Document document) Constructs a mark manager attached to specified document.

Method Summary

Modifier and Type	Method and Description
NodeMark	add(Object id, Node node) Adds NodeMark with specified ID to specified location.
TextLocation	add(Object id, TextNode text, int offset) Adds TextLocation with specified ID to specified location.
TextLocation	add(Object id, TextNode text, int offset, boolean cursor) Adds TextLocation with specified ID to specified location.
void	addContextChangeListener(ContextChangeListener listener) Adds specified listener.
void	addMarkChangeListener(MarkChangeListener listener) Adds specified listener.
void	attributeChanged(AttributeEvent event, int listenerIndex) Invoked when an attribute has been added, changed, removed to/from an element.
void	beginMark() Prevents this manager to notify its listeners when marks are changed until endMark() is invoked.
boolean	contains(Object id) Returns true if this manager manages mark with specified ID.
void	editCompleted(EditEvent event, int listenerIndex) Invoked when a sequence of modifications, considered as being a whole, is finished.
void	editStarted(EditEvent event, int listenerIndex) Invoked when a sequence of modifications, considered as being a whole, has started.
void	elementNameChanged(ElementNameEvent event, int listenerIndex) Invoked after the name of a element is changed.
void	endMark() Stops preventing this manager to notify its listeners when marks are changed.
void	eventHappened(DocumentEvent event, int listenerIndex) Invoked by a document listener to communicate with other document listeners.
Mark	get(Object id) Returns mark with specified ID.
Mark[]	getAll() Returns all marks managed by this manager.
int	getCount() Returns number of marks managed by this manager.
Document	getDocument() Specifies or changes the document to which this mark manager is attached (a mark manager is a DocumentListener).
TextLocation	getDot() Returns the dot mark if any; null otherwise.
TextLocation	getMark() Returns the mark mark if any; null otherwise.
NodeMark	getSelected() Returns the selected mark if any; null otherwise.
NodeMark	getSelected2() Returns the selected2 mark if any; null otherwise.
void	inclusionUpdated(InclusionUpdatedEvent event, int listenerIndex) Invoked when an Inclusion has been updated, that is, that a sequence of contiguous included nodes has been replaced by another sequence of contiguous included nodes.
void	notifyContextChangeListeners() Equivalent to notifyContextChangeListeners(ContextChangeEvent.Reason.FORCED).
void	notifyContextChangeListeners(ContextChangeEvent.Reason reason) Notify context change listeners.
void	processingInstructionChanged(ProcessingInstructionEvent event, int listenerIndex) Invoked after the target of a processing instruction is changed.
Mark	remove(Object id) Removes (unmanages) mark with specified ID.
void	removeAll() Remove all marks managed by this manager.
void	removeAll(String[] idPrefixes) Remove some marks managed by this manager.
void	removeContextChangeListener(ContextChangeListener listener) Removes specified listener.
void	removeMarkChangeListener(MarkChangeListener listener) Removes specified listener.
NodeMark	set(Object id, Node node) Adds or moves NodeMark with specified ID to specified location.
TextLocation	set(Object id, TextNode text, int offset) Adds or moves TextLocation with specified ID to specified location.
TextLocation	set(Object id, TextNode text, int offset, boolean cursor) Adds or moves TextLocation with specified ID to specified location.
void	setDocument(Document document) Specifies or changes the document to which this mark manager is attached (a mark manager is a DocumentListener).
void	textChanged(TextEvent event, int listenerIndex) Invoked when characters have been changed in a text node (text, comment, processing instruction).
void	treeChanged(TreeEvent event, int listenerIndex) Invoked when a child node has been added, replaced or removed to/from an element.

Methods inherited from class com.xmlmind.util.PropertySet

getProperties, getProperty, getPropertyCount, hasProperty, putProperties, putProperty, removeAllProperties, removeProperty

Methods inherited from class java.lang.Object

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

Field Detail

xmlClipboard

public final XMLClipboard xmlClipboard

autoAddingDot

public final boolean autoAddingDot

COMPARE_BY_POSITION

public static final MarkManager.CompareByPosition COMPARE_BY_POSITION

A ready-to-use CompareByPosition instance.

Constructor Detail

MarkManager

public MarkManager(XMLClipboard xmlClipboard,
                   boolean autoAddingDot,
                   Document document)

Constructs a mark manager attached to specified document.

Parameters:

xmlClipboard - the clipboard cache.

autoAddingDot - if true, enable the auto-add-dot feature

document - attach mark manager to this document. May be null.

See Also:

setDocument(com.xmlmind.xml.doc.Document)

Method Detail

setDocument

public void setDocument(Document document)

Specifies or changes the document to which this mark manager is attached (a mark manager is a DocumentListener).

If this mark manager was previously attached to another document, all marks put on this document are automatically removed.

getDocument

public Document getDocument()

Specifies or changes the document to which this mark manager is attached (a mark manager is a DocumentListener).

set

public NodeMark set(Object id,
                    Node node)

Adds or moves NodeMark with specified ID to specified location.

Parameters:

id - id of mark to be added or moved

node - node to be marked

Returns:

added or moved NodeMark

set

public TextLocation set(Object id,
                        TextNode text,
                        int offset)

Adds or moves TextLocation with specified ID to specified location.

Parameters:

id - id of mark to be added or moved

text - textual node containing character to be marked

offset - index within textual node of character to be marked

Returns:

added or moved TextLocation

set

public TextLocation set(Object id,
                        TextNode text,
                        int offset,
                        boolean cursor)

Adds or moves TextLocation with specified ID to specified location.

Parameters:

id - id of mark to be added or moved

text - textual node containing character to be marked

offset - index within textual node of character to be marked

cursor - if added, newly created TextLocation has cursor behavior

Returns:

added or moved TextLocation

add

public NodeMark add(Object id,
                    Node node)

Adds NodeMark with specified ID to specified location.

Parameters:

id - id of mark to be added or moved

node - node to be marked

Returns:

added NodeMark or null if mark with specified ID is already managed by this manager

add

public TextLocation add(Object id,
                        TextNode text,
                        int offset)

Adds TextLocation with specified ID to specified location.

Parameters:

id - id of mark to be added or moved

text - textual node containing character to be marked

offset - index within textual node of character to be marked

Returns:

added TextLocation or null if mark with specified ID is already managed by this manager

add

public TextLocation add(Object id,
                        TextNode text,
                        int offset,
                        boolean cursor)

Adds TextLocation with specified ID to specified location.

Parameters:

id - id of mark to be added or moved

text - textual node containing character to be marked

offset - index within textual node of character to be marked

cursor - if added, newly created TextLocation has cursor behavior

Returns:

added TextLocation or null if mark with specified ID is already managed by this manager

remove

public Mark remove(Object id)

Removes (unmanages) mark with specified ID.

Parameters:

id - ID of mark to be removed.

Returns:

removed mark or null if no mark with specified ID was managed by this manager

removeAll

public void removeAll(String[] idPrefixes)

Remove some marks managed by this manager.

Parameters:

idPrefixes - the ID prefixes of the marks to be removed

removeAll

public void removeAll()

Remove all marks managed by this manager.

contains

public boolean contains(Object id)

Returns true if this manager manages mark with specified ID. Returns false otherwise.

getCount

public int getCount()

Returns number of marks managed by this manager.

getDot

public TextLocation getDot()

Returns the dot mark if any; null otherwise.

Newly typed characters are inserted at the dot text location. The dot text location is visualized by the caret.

getMark

public TextLocation getMark()

Returns the mark mark if any; null otherwise.

The text range between mark and dot, if not empty, is called the text selection.

getSelected

public NodeMark getSelected()

Returns the selected mark if any; null otherwise.

The node range between selected and selected2 is called the node selection. If there is no selected2 mark, the node selection consists in the single node marked by selected.

getSelected2

public NodeMark getSelected2()

Returns the selected2 mark if any; null otherwise.

The node range between selected and selected2 is called the node selection. If there is no selected2 mark, the node selection consists in the single node marked by selected.

get

public Mark get(Object id)

Returns mark with specified ID. Returns null if this manager does not manage such mark.

getAll

public Mark[] getAll()

Returns all marks managed by this manager.

beginMark

public void beginMark()

Prevents this manager to notify its listeners when marks are changed until endMark() is invoked.

Calls to this method can be nested, in which case this method does nothing at all.

Commands often use this method because they often need to remove several marks (example: selected2 and mark) and at the same time, move other marks (example: selected or dot). Without beginMark/endMark, several editing context changes are reported instead of a single one. Editing context changes generally cause the application to enable or disable its menu, its toolbars, to update its status bar, its panes, etc, that is, this is generally a computation intensive operation.

endMark

public void endMark()

Stops preventing this manager to notify its listeners when marks are changed.

There must be a call to endMark for each call to beginMark().

addMarkChangeListener

public void addMarkChangeListener(MarkChangeListener listener)

Adds specified listener.

removeMarkChangeListener

public void removeMarkChangeListener(MarkChangeListener listener)

Removes specified listener.

addContextChangeListener

public void addContextChangeListener(ContextChangeListener listener)

Adds specified listener.

removeContextChangeListener

public void removeContextChangeListener(ContextChangeListener listener)

Removes specified listener.

notifyContextChangeListeners

public void notifyContextChangeListeners()

Equivalent to notifyContextChangeListeners(ContextChangeEvent.Reason.FORCED).

notifyContextChangeListeners

public void notifyContextChangeListeners(ContextChangeEvent.Reason reason)

Notify context change listeners.

Parameters:

reason - reason why the ContextChangeEvent is sent

editStarted

public void editStarted(EditEvent event,
                        int listenerIndex)

Description copied from interface: DocumentListener

Invoked when a sequence of modifications, considered as being a whole, has started.

Specified by:

editStarted in interface DocumentListener

Parameters:

event - contains details about what has happened.

listenerIndex - may be used to retrieve data, private to the listener, attached to a document node

See Also:

Node.getDocumentListenerData(int)

editCompleted

public void editCompleted(EditEvent event,
                          int listenerIndex)

Description copied from interface: DocumentListener

Invoked when a sequence of modifications, considered as being a whole, is finished.

Specified by:

editCompleted in interface DocumentListener

Parameters:

event - contains details about what has happened.

listenerIndex - may be used to retrieve data, private to the listener, attached to a document node

See Also:

Node.getDocumentListenerData(int)

textChanged

public void textChanged(TextEvent event,
                        int listenerIndex)

Description copied from interface: DocumentListener

Invoked when characters have been changed in a text node (text, comment, processing instruction).

Specified by:

textChanged in interface DocumentListener

Parameters:

event - contains details about what has happened.

listenerIndex - may be used to retrieve data, private to the listener, attached to a document node

See Also:

Node.getDocumentListenerData(int)

inclusionUpdated

public void inclusionUpdated(InclusionUpdatedEvent event,
                             int listenerIndex)

Description copied from interface: DocumentListener

Invoked when an Inclusion has been updated, that is, that a sequence of contiguous included nodes has been replaced by another sequence of contiguous included nodes.

Specified by:

inclusionUpdated in interface DocumentListener

Parameters:

event - contains details about what has happened.

listenerIndex - may be used to retrieve data, private to the listener, attached to a document node

See Also:

Node.getDocumentListenerData(int)

treeChanged

public void treeChanged(TreeEvent event,
                        int listenerIndex)

Description copied from interface: DocumentListener

Invoked when a child node has been added, replaced or removed to/from an element.

Specified by:

treeChanged in interface DocumentListener

Parameters:

event - contains details about what has happened.

listenerIndex - may be used to retrieve data, private to the listener, attached to a document node

See Also:

Node.getDocumentListenerData(int)

eventHappened

public void eventHappened(DocumentEvent event,
                          int listenerIndex)

Description copied from interface: DocumentListener

Invoked by a document listener to communicate with other document listeners.

Specified by:

eventHappened in interface DocumentListener

Parameters:

event - contains the ``message'' sent by the invoker.

listenerIndex - may be used to retrieve data, private to the listener, attached to a document node

See Also:

Node.getDocumentListenerData(int)

attributeChanged

public void attributeChanged(AttributeEvent event,
                             int listenerIndex)

Description copied from interface: DocumentListener

Invoked when an attribute has been added, changed, removed to/from an element.

Specified by:

attributeChanged in interface DocumentListener

Parameters:

event - contains details about what has happened.

listenerIndex - may be used to retrieve data, private to the listener, attached to a document node

See Also:

Node.getDocumentListenerData(int)

processingInstructionChanged

public void processingInstructionChanged(ProcessingInstructionEvent event,
                                         int listenerIndex)

Description copied from interface: DocumentListener

Invoked after the target of a processing instruction is changed.

Specified by:

processingInstructionChanged in interface DocumentListener

Parameters:

event - contains details about what has happened.

listenerIndex - may be used to retrieve data, private to the listener, attached to a document node

See Also:

Node.getDocumentListenerData(int)

elementNameChanged

public void elementNameChanged(ElementNameEvent event,
                               int listenerIndex)

Description copied from interface: DocumentListener

Invoked after the name of a element is changed.

Specified by:

elementNameChanged in interface DocumentListener

Parameters:

event - contains details about what has happened.

listenerIndex - may be used to retrieve data, private to the listener, attached to a document node

See Also:

Node.getDocumentListenerData(int)