com.xmlmind.xmledit.view

Class ViewFactory

java.lang.Object

com.xmlmind.util.PropertySet

com.xmlmind.xmledit.view.ViewFactory

Direct Known Subclasses:

TreeViewFactory

public abstract class ViewFactory
extends PropertySet

Abstract class of objects responsible for creating a node view for each document node.

See Also:

NodeView, Node

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ViewFactory.Effect Effect of an attribute change on the view of the element having this attribute.

Field Summary

Fields

Modifier and Type	Field and Description
protected Document	doc
protected DocumentView	docView

Fields inherited from class com.xmlmind.util.PropertySet

properties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ViewFactory(DocumentView documentView) Constructs a factory for use by specified DocumentView.

Method Summary

Modifier and Type	Method and Description
ViewFactory.Effect	attributeChanged(AttributeEvent event, int viewIndex) Invoked by the DocumentView when an element attribute has changed.
void	beginRebuildView(Node node) Invoked by the DocumentView at the beginning of rebuildView.
abstract TextNodeView	createCommentView(Comment comment, ElementView parentView) Creates an TextNodeView for specified comment node.
abstract ElementView	createElementView(Element element, ElementView parentView) Creates an ElementView for specified element.
abstract TextNodeView	createProcessingInstructionView(ProcessingInstruction pi, ElementView parentView) Creates an TextNodeView for specified processing instruction node.
abstract TextNodeView	createTextView(Text text, ElementView parentView) Creates an TextNodeView for specified text node.
void	endRebuildView(Node node) Invoked by the DocumentView at the end of rebuildView.
Document	getDocument() Returns document displayed by the DocumentView of this factory.
DocumentView	getDocumentView() Returns the DocumentView using this factory.
void	setDocument(Document document) Invoked by the DocumentView to notify this factory that specified document is displayed.
boolean	treeChanged(TreeEvent event, int viewIndex) Invoked by the DocumentView when the child nodes of an element have been modified.

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

docView

protected DocumentView docView

doc

protected Document doc

Constructor Detail

ViewFactory

protected ViewFactory(DocumentView documentView)

Constructs a factory for use by specified DocumentView.

Method Detail

getDocumentView

public DocumentView getDocumentView()

Returns the DocumentView using this factory.

setDocument

public void setDocument(Document document)

Invoked by the DocumentView to notify this factory that specified document is displayed. This may be useful for some factories.

Parameters:

document - document displayed by DocumentView; null if DocumentView is empty.

getDocument

public Document getDocument()

Returns document displayed by the DocumentView of this factory.

beginRebuildView

public void beginRebuildView(Node node)

Invoked by the DocumentView at the beginning of rebuildView.

Default implementation does nothing at all.

See Also:

DocumentView.rebuildView(com.xmlmind.xml.doc.Node), endRebuildView(com.xmlmind.xml.doc.Node)

endRebuildView

public void endRebuildView(Node node)

Invoked by the DocumentView at the end of rebuildView.

Default implementation does nothing at all.

See Also:

DocumentView.rebuildView(com.xmlmind.xml.doc.Node), beginRebuildView(com.xmlmind.xml.doc.Node)

attributeChanged

public ViewFactory.Effect attributeChanged(AttributeEvent event,
                                           int viewIndex)

Invoked by the DocumentView when an element attribute has changed. This factory must return what to do to properly reflect this change on the view of the element for which an attribute has changed.

This default implementation returns ViewFactory.Effect.REBUILD.

Parameters:

event - specifies the attribute change

viewIndex - can be used to access the view of the element for which an attribute has changed (with event.getElementSource().getDocumentListenerData(viewIndex))

Returns:

ViewFactory.Effect.SKIP or ViewFactory.Effect.REFRESH or ViewFactory.Effect.REBUILD

See Also:

Node.getDocumentListenerData(int)

treeChanged

public boolean treeChanged(TreeEvent event,
                           int viewIndex)

Invoked by the DocumentView when the child nodes of an element have been modified. This factory must return what to do to properly reflect this change on the view of the element in which child nodes have changed

This default implementation returns false.

This method is needed to properly support the :first-child, :last-child, :empty, etc, pseudo-classes in styled view factories.

Parameters:

event - specifies which child nodes have been modified

viewIndex - can be used to access the view of the element in which child nodes have changed (with event.getElementSource().getDocumentListenerData(viewIndex))

Returns:

true if the view of the element is to be rebuilt from scratch; false if suffice to update the view of the element (e.g. add a view for a newly added child node)

See Also:

Node.getDocumentListenerData(int)

createElementView

public abstract ElementView createElementView(Element element,
                                              ElementView parentView)

Creates an ElementView for specified element.

Parameters:

element - element for which a view is to be created

parentView - view of parent element; may be useful for some factories

Returns:

created element view or null if specified element is not visible (for example, StyledViewFactory does this for display: none)

createTextView

public abstract TextNodeView createTextView(Text text,
                                            ElementView parentView)

Creates an TextNodeView for specified text node.

Parameters:

text - text node for which a view is to be created

parentView - view of parent element; may be useful for some factories

Returns:

created node view or null if specified node is not visible

createCommentView

public abstract TextNodeView createCommentView(Comment comment,
                                               ElementView parentView)

Creates an TextNodeView for specified comment node.

Parameters:

comment - comment node for which a view is to be created

parentView - view of parent element; may be useful for some factories

Returns:

created node view or null if specified node is not visible

createProcessingInstructionView

public abstract TextNodeView createProcessingInstructionView(ProcessingInstruction pi,
                                                             ElementView parentView)

Creates an TextNodeView for specified processing instruction node.

Parameters:

pi - processing instruction node for which a view is to be created

parentView - view of parent element; may be useful for some factories

Returns:

created node view or null if specified node is not visible