com.aspose.words

Class GlossaryDocument

java.lang.Object

com.aspose.words.Node

com.aspose.words.CompositeNode

com.aspose.words.DocumentBase

com.aspose.words.GlossaryDocument

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

public class GlossaryDocument
extends DocumentBase

Represents the root element for a glossary document within a Word document. A glossary document is a storage for AutoText, AutoCorrect entries and Building Blocks.

Some documents, usually templates, can contain AutoText, AutoCorrect entries and/or Building Blocks (also known as glossary document entries, document parts or building blocks).

To access building blocks, you need to load a document into a Document object. Building blocks will be available via the Document.getGlossaryDocument() / Document.setGlossaryDocument(com.aspose.words.GlossaryDocument) property.

GlossaryDocument can contain any number of BuildingBlock objects. Each BuildingBlock represents one document part.

Corresponds to the glossaryDocument and docParts elements in OOXML.

See Also:

Document, Document.getGlossaryDocument(), Document.setGlossaryDocument(com.aspose.words.GlossaryDocument), BuildingBlock

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
BuildingBlock	getBuildingBlock(int gallery, java.lang.String category, java.lang.String name)
BuildingBlockCollection	getBuildingBlocks() Returns a typed collection that represents all building blocks in the glossary document.
BuildingBlock	getFirstBuildingBlock() Gets the first building block in the glossary document.
BuildingBlock	getLastBuildingBlock() Gets the last building block in the glossary document.
int	getNodeType() Returns the NodeType.GLOSSARY_DOCUMENT value.

Methods inherited from class com.aspose.words.DocumentBase

getBackgroundShape, getDocument, getFontInfos, getLists, getNodeChangingCallback, getPageColor, getResourceLoadingCallback, getStyles, getWarningCallback, importNode, importNode, resetState, setBackgroundShape, setNodeChangingCallback, setPageColor, setResourceLoadingCallback, setWarningCallback

Methods inherited from class com.aspose.words.CompositeNode

acceptChildren, acceptCore, appendChild, coreRemoveSelfOnly, getChild, getChildNodes, getChildNodes, getContainer, getCount, getCurrentNode, getFirstChild, getLastChild, getNextMatchingNode, getText, hasChildNodes, indexOf, insertAfter, insertBefore, isComposite, iterator, prependChild, removeAllChildren, removeChild, removeSmartTags, selectNodes, selectSingleNode

Methods inherited from class com.aspose.words.Node

dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getNextSibling, getParentNode, getPreviousSibling, getRange, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getNodeType

public int getNodeType()

Returns the NodeType.GLOSSARY_DOCUMENT value.

Specified by:

getNodeType in class Node

Returns:

The NodeType.GLOSSARY_DOCUMENT value. The returned value is one of NodeType constants.

getBuildingBlocks

public BuildingBlockCollection getBuildingBlocks()

Returns a typed collection that represents all building blocks in the glossary document.

Returns:

A typed collection that represents all building blocks in the glossary document.

getFirstBuildingBlock

public BuildingBlock getFirstBuildingBlock()

Gets the first building block in the glossary document. Returns null if there are no building blocks available.

Returns:

The first building block in the glossary document.

getLastBuildingBlock

public BuildingBlock getLastBuildingBlock()

Gets the last building block in the glossary document. Returns null if there are no building blocks available.

Returns:

The last building block in the glossary document.

accept

public boolean accept(DocumentVisitor visitor)
               throws java.lang.Exception

Accepts a visitor.

Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.

For more info see the Visitor design pattern.

Specified by:

accept in class Node

Parameters:

visitor - The visitor that will visit the nodes.

Returns:

True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

Throws:

java.lang.Exception

getBuildingBlock

public BuildingBlock getBuildingBlock(int gallery,
                                      java.lang.String category,
                                      java.lang.String name)