com.aspose.words

Class BuildingBlock

java.lang.Object

com.aspose.words.Node

com.aspose.words.CompositeNode

com.aspose.words.BuildingBlock

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

public class BuildingBlock
extends CompositeNode

Represents a glossary document entry such as a Building Block, AutoText or an AutoCorrect entry.

To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.

BuildingBlock can contain only Section nodes.

BuildingBlock can only be a child of GlossaryDocument.

You can create new building blocks and insert them into a glossary document. You can modify or delete existing building blocks. You can copy or move building blocks between documents. You can insert content of a building block into a document.

Corresponds to the docPart, docPartPr and docPartBody elements in OOXML.

See Also:

GlossaryDocument

Constructor Summary

Constructors

Constructor and Description
BuildingBlock(GlossaryDocument glossaryDoc) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
int	getBehavior() Specifies the behavior that shall be applied when the contents of the building block is inserted into the main document.
java.lang.String	getCategory() Specifies the second-level categorization for the building block.
java.lang.String	getDescription() Gets the description associated with this building block.
Section	getFirstSection() Gets the first section in the building block.
int	getGallery() Specifies the first-level categorization for the building block for the purposes of classification or user interface sorting.
java.util.UUID	getGuid() Gets an identifier (a 128-bit GUID) that uniquely identifies this building block.
Section	getLastSection() Gets the last section in the building block.
java.lang.String	getName() Gets the name of this building block.
int	getNodeType() Returns the NodeType.BUILDING_BLOCK value.
SectionCollection	getSections() Returns a collection that represents all sections in the building block.
int	getType() Specifies the building block type.
void	setBehavior(int value) Specifies the behavior that shall be applied when the contents of the building block is inserted into the main document.
void	setCategory(java.lang.String value) Specifies the second-level categorization for the building block.
void	setDescription(java.lang.String value) Sets the description associated with this building block.
void	setGallery(int value) Specifies the first-level categorization for the building block for the purposes of classification or user interface sorting.
void	setGuid(java.util.UUID value) Sets an identifier (a 128-bit GUID) that uniquely identifies this building block.
void	setName(java.lang.String value) Sets the name of this building block.
void	setType(int value) Specifies the building block type.

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, getDocument, 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

Constructor Detail

BuildingBlock

public BuildingBlock(GlossaryDocument glossaryDoc)

Initializes a new instance of this class.

When BuildingBlock is created, it belongs to the specified glossary document, but is not yet part of the glossary document and Node.getParentNode() is null.

To append BuildingBlock to a GlossaryDocument use CompositeNode.appendChild(com.aspose.words.Node).

Parameters:

glossaryDoc - The owner document.

Method Detail

getNodeType

public int getNodeType()

Returns the NodeType.BUILDING_BLOCK value.

Specified by:

getNodeType in class Node

Returns:

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

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

getSections

public SectionCollection getSections()

Returns a collection that represents all sections in the building block.

Returns:

A collection that represents all sections in the building block.

getFirstSection

public Section getFirstSection()

Gets the first section in the building block. Returns null if there are no sections.

Returns:

The first section in the building block.

getLastSection

public Section getLastSection()

Gets the last section in the building block. Returns null if there are no sections.

Returns:

The last section in the building block.

getName

public java.lang.String getName()

Gets the name of this building block.

The name may contain any string content, usually a friendly identifier. Multiple building blocks can have the same name.

Cannot be null and cannot be an empty string.

Corresponds to the docPartPr.name element in OOXML.

Returns:

The name of this building block.

See Also:

getGallery(), setGallery(int), getCategory(), setCategory(java.lang.String)

setName

public void setName(java.lang.String value)

Sets the name of this building block.

The name may contain any string content, usually a friendly identifier. Multiple building blocks can have the same name.

Cannot be null and cannot be an empty string.

Corresponds to the docPartPr.name element in OOXML.

Parameters:

value - The name of this building block.

See Also:

getGallery(), setGallery(int), getCategory(), setCategory(java.lang.String)

getGuid

public java.util.UUID getGuid()

Gets an identifier (a 128-bit GUID) that uniquely identifies this building block.

Can be used by an application to uniquely reference a building block regardless of different naming due to localization.

Corresponds to the docPartPr.guid element in OOXML.

Returns:

An identifier (a 128-bit GUID) that uniquely identifies this building block.

setGuid

public void setGuid(java.util.UUID value)

Sets an identifier (a 128-bit GUID) that uniquely identifies this building block.

Can be used by an application to uniquely reference a building block regardless of different naming due to localization.

Corresponds to the docPartPr.guid element in OOXML.

Parameters:

value - An identifier (a 128-bit GUID) that uniquely identifies this building block.

getDescription

public java.lang.String getDescription()

Gets the description associated with this building block.

The description may contain any string content, usually additional information.

Cannot be null, but can be an empty string.

Corresponds to the docPartPr.description element in OOXML.

Returns:

The description associated with this building block.

setDescription

public void setDescription(java.lang.String value)

Sets the description associated with this building block.

The description may contain any string content, usually additional information.

Cannot be null, but can be an empty string.

Corresponds to the docPartPr.description element in OOXML.

Parameters:

value - The description associated with this building block.

getGallery

public int getGallery()

Specifies the first-level categorization for the building block for the purposes of classification or user interface sorting.

Building blocks in Microsoft Word user interface are arranged into Galleries. Each getGallery() / setGallery(int) can have multiple Categories. Each block within a getCategory() / setCategory(java.lang.String) has a getName() / setName(java.lang.String).

Corresponds to the docPartPr.category.gallery element in OOXML.

Returns:

The corresponding int value. The returned value is one of BuildingBlockGallery constants.

See Also:

getCategory(), setCategory(java.lang.String), getName(), setName(java.lang.String)

setGallery

public void setGallery(int value)

Specifies the first-level categorization for the building block for the purposes of classification or user interface sorting.

Building blocks in Microsoft Word user interface are arranged into Galleries. Each getGallery() / setGallery(int) can have multiple Categories. Each block within a getCategory() / setCategory(java.lang.String) has a getName() / setName(java.lang.String).

Corresponds to the docPartPr.category.gallery element in OOXML.

Parameters:

value - The corresponding int value. The value must be one of BuildingBlockGallery constants.

See Also:

getCategory(), setCategory(java.lang.String), getName(), setName(java.lang.String)

getCategory

public java.lang.String getCategory()

Specifies the second-level categorization for the building block.

Building blocks in Microsoft Word user interface are arranged into Galleries. Each getGallery() / setGallery(int) can have multiple Categories. Each block within a getCategory() / setCategory(java.lang.String) has a getName() / setName(java.lang.String).

Cannot be null and cannot be an empty string.

Corresponds to the docPartPr.category.name element in OOXML.

Returns:

The corresponding String value.

See Also:

getGallery(), setGallery(int), getName(), setName(java.lang.String)

setCategory

public void setCategory(java.lang.String value)

Specifies the second-level categorization for the building block.

Building blocks in Microsoft Word user interface are arranged into Galleries. Each getGallery() / setGallery(int) can have multiple Categories. Each block within a getCategory() / setCategory(java.lang.String) has a getName() / setName(java.lang.String).

Cannot be null and cannot be an empty string.

Corresponds to the docPartPr.category.name element in OOXML.

Parameters:

value - The corresponding String value.

See Also:

getGallery(), setGallery(int), getName(), setName(java.lang.String)

getBehavior

public int getBehavior()

Specifies the behavior that shall be applied when the contents of the building block is inserted into the main document.

Returns:

The corresponding int value. The returned value is one of BuildingBlockBehavior constants.

setBehavior

public void setBehavior(int value)

Specifies the behavior that shall be applied when the contents of the building block is inserted into the main document.

Parameters:

value - The corresponding int value. The value must be one of BuildingBlockBehavior constants.

getType

public int getType()

Specifies the building block type.

The building block type can influence the visibility and behavior of the building block in Microsoft Word.

Corresponds to the docPartPr.types element in OOXML.

Returns:

The corresponding int value. The returned value is one of BuildingBlockType constants.

setType

public void setType(int value)

Specifies the building block type.

The building block type can influence the visibility and behavior of the building block in Microsoft Word.

Corresponds to the docPartPr.types element in OOXML.

Parameters:

value - The corresponding int value. The value must be one of BuildingBlockType constants.