com.xmlmind.xmledit.view

Class TreeViewFactory

java.lang.Object

com.xmlmind.util.PropertySet

com.xmlmind.xmledit.view.ViewFactory

com.xmlmind.xmledit.view.TreeViewFactory

Direct Known Subclasses:

ViewFactoryBase

public class TreeViewFactory
extends ViewFactory

Simple implementation of ViewFactory which can be used to create a tree view of a document.

Nested Class Summary

Nested classes/interfaces inherited from class com.xmlmind.xmledit.view.ViewFactory

ViewFactory.Effect

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentType	docType
protected boolean	isDummyDocType
protected TreeViewSettings	settings

Fields inherited from class com.xmlmind.xmledit.view.ViewFactory

doc, docView

Fields inherited from class com.xmlmind.util.PropertySet

properties

Constructor Summary

Constructors

Constructor and Description
TreeViewFactory(DocumentView documentView) Constructs a tree view factory for use by specified DocumentView.

Method Summary

Modifier and Type	Method and Description
void	applySettings() Rebuilds the whole node view tree applying current settings of this factory.
ViewFactory.Effect	attributeChanged(AttributeEvent event, int viewIndex) Invoked by the DocumentView when an element attribute has changed.
protected static CharView	createCharView(TextNode text, TreeViewSettings settings)
TextNodeView	createCommentView(Comment comment, ElementView parentView) Creates an TextNodeView for specified comment node.
ElementView	createElementView(Element element, ElementView parentView) Creates an ElementView for specified element.
TextNodeView	createProcessingInstructionView(ProcessingInstruction pi, ElementView parentView) Creates an TextNodeView for specified processing instruction node.
protected static TextNodeOutline	createTextNodeOutline(TextNode text, boolean preserveSpace, TreeViewSettings settings)
TextNodeView	createTextView(Text text, ElementView parentView) Creates an TextNodeView for specified text node.
protected static WordView	createWordView(TextNode text, TreeViewSettings settings)
protected ViewFactory.Effect	directionalityAttributeChanged(Element attrParent, Name attrName)
TreeViewSettings	getSettings() Returns the current settings of this factory.
protected boolean	hasPreserveSpace(TextNode textNode)
void	setDocument(Document document) Invoked by the DocumentView to notify this factory that specified document is displayed.
void	setSettings(TreeViewSettings settings) Changes current settings of this factory and then invokes applySettings().

Methods inherited from class com.xmlmind.xmledit.view.ViewFactory

beginRebuildView, endRebuildView, getDocument, getDocumentView, treeChanged

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

settings

protected TreeViewSettings settings

docType

protected DocumentType docType

isDummyDocType

protected boolean isDummyDocType

Constructor Detail

TreeViewFactory

public TreeViewFactory(DocumentView documentView)

Constructs a tree view factory for use by specified DocumentView.

Method Detail

setDocument

public void setDocument(Document document)

Description copied from class: ViewFactory

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

Overrides:

setDocument in class ViewFactory

Parameters:

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

setSettings

public void setSettings(TreeViewSettings settings)

Changes current settings of this factory and then invokes applySettings().

Note that it is also allowed to use getSettings() to get current settings of this factory, to directly modify these settings and then to invoke applySettings.

applySettings

public void applySettings()

Rebuilds the whole node view tree applying current settings of this factory.

getSettings

public TreeViewSettings getSettings()

Returns the current settings of this factory.

attributeChanged

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

Description copied from class: ViewFactory

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.

Overrides:

attributeChanged in class ViewFactory

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)

directionalityAttributeChanged

protected ViewFactory.Effect directionalityAttributeChanged(Element attrParent,
                                                            Name attrName)

createElementView

public ElementView createElementView(Element element,
                                     ElementView parentView)

Description copied from class: ViewFactory

Creates an ElementView for specified element.

Specified by:

createElementView in class ViewFactory

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 TextNodeView createTextView(Text text,
                                   ElementView parentView)

Description copied from class: ViewFactory

Creates an TextNodeView for specified text node.

Specified by:

createTextView in class ViewFactory

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

hasPreserveSpace

protected boolean hasPreserveSpace(TextNode textNode)

createCommentView

public TextNodeView createCommentView(Comment comment,
                                      ElementView parentView)

Description copied from class: ViewFactory

Creates an TextNodeView for specified comment node.

Specified by:

createCommentView in class ViewFactory

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 TextNodeView createProcessingInstructionView(ProcessingInstruction pi,
                                                    ElementView parentView)

Description copied from class: ViewFactory

Creates an TextNodeView for specified processing instruction node.

Specified by:

createProcessingInstructionView in class ViewFactory

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

createCharView

protected static CharView createCharView(TextNode text,
                                         TreeViewSettings settings)

createWordView

protected static WordView createWordView(TextNode text,
                                         TreeViewSettings settings)

createTextNodeOutline

protected static TextNodeOutline createTextNodeOutline(TextNode text,
                                                       boolean preserveSpace,
                                                       TreeViewSettings settings)