java.lang.ObjectNode
CompositeNode
com.aspose.words.BuildingBlock
public class BuildingBlock
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.
Constructor Summary |
---|
BuildingBlock(GlossaryDocument glossaryDoc)
Initializes a new instance of this class. |
Property Getters/Setters Summary | ||
---|---|---|
int | getBehavior() | |
void | setBehavior(int value) | |
Specifies the behavior that shall be applied when the contents of the building block is inserted into the main document. The value of the property is BuildingBlockBehavior integer constant. | ||
java.lang.String | getCategory() | |
void | setCategory(java.lang.String value) | |
Specifies the second-level categorization for the building block. | ||
NodeCollection | getChildNodes() | → inherited from CompositeNode |
Gets all immediate child nodes of this node. | ||
int | getCount() | → inherited from CompositeNode |
Gets the number of immediate children of this node. | ||
java.lang.String | getDescription() | |
void | setDescription(java.lang.String value) | |
Gets or sets the description associated with this building block. | ||
DocumentBase | getDocument() | → inherited from Node |
Gets the document to which this node belongs. | ||
Node | getFirstChild() | → inherited from CompositeNode |
Gets the first child of the node. | ||
Section | getFirstSection() | |
Gets the first section in the building block. | ||
int | getGallery() | |
void | setGallery(int value) | |
Specifies the first-level categorization for the building block for the purposes of classification or user interface sorting. The value of the property is BuildingBlockGallery integer constant. | ||
java.util.UUID | getGuid() | |
void | setGuid(java.util.UUID value) | |
Gets or sets an identifier (a 128-bit GUID) that uniquely identifies this building block. | ||
boolean | hasChildNodes() | → inherited from CompositeNode |
Returns true if this node has any child nodes. | ||
boolean | isComposite() | → inherited from CompositeNode |
Returns true as this node can have child nodes. | ||
Node | getLastChild() | → inherited from CompositeNode |
Gets the last child of the node. | ||
Section | getLastSection() | |
Gets the last section in the building block. | ||
java.lang.String | getName() | |
void | setName(java.lang.String value) | |
Gets or sets the name of this building block. | ||
Node | getNextSibling() | → inherited from Node |
Gets the node immediately following this node. | ||
int | getNodeType() | |
Returns the |
||
CompositeNode | getParentNode() | → inherited from Node |
Gets the immediate parent of this node. | ||
Node | getPreviousSibling() | → inherited from Node |
Gets the node immediately preceding this node. | ||
Range | getRange() | → inherited from Node |
Returns a Range object that represents the portion of a document that is contained in this node. | ||
SectionCollection | getSections() | |
Returns a collection that represents all sections in the building block. | ||
int | getType() | |
void | setType(int value) | |
Specifies the building block type. The value of the property is BuildingBlockType integer constant. |
Method Summary | ||
---|---|---|
boolean | accept(DocumentVisitor visitor) | |
Accepts a visitor. | ||
Node | appendChild(Node newChild) | → inherited from CompositeNode |
Adds the specified node to the end of the list of child nodes for this node. | ||
Node | deepClone(boolean isCloneChildren) | → inherited from Node |
Creates a duplicate of the node. | ||
CompositeNode | getAncestor(int ancestorType) | → inherited from Node |
Gets the first ancestor of the specified |
||
CompositeNode | getAncestor(java.lang.Class ancestorType) | → inherited from Node |
Gets the first ancestor of the specified object type. | ||
Node | getChild(int nodeType, int index, boolean isDeep) | → inherited from CompositeNode |
Returns an Nth child node that matches the specified type. | ||
NodeCollection | getChildNodes(int nodeType, boolean isDeep) | → inherited from CompositeNode |
Returns a live collection of child nodes that match the specified type. | ||
CompositeNode | getContainer() | → inherited from CompositeNode |
Reserved for internal use. | ||
Node | getNextMatchingNode(aspose.obfuscated.type curNode) | → inherited from CompositeNode |
Reserved for internal use. | ||
java.lang.String | getText() | → inherited from CompositeNode |
Gets the text of this node and of all its children. | ||
int | indexOf(Node child) | → inherited from CompositeNode |
Returns the index of the specified child node in the child node array. | ||
Node | insertAfter(Node newChild, Node refChild) | → inherited from CompositeNode |
Inserts the specified node immediately after the specified reference node. | ||
Node | insertBefore(Node newChild, Node refChild) | → inherited from CompositeNode |
Inserts the specified node immediately before the specified reference node. | ||
java.util.Iterator | iterator() | → inherited from CompositeNode |
Provides support for the for each style iteration over the child nodes of this node. | ||
Node | nextPreOrder(Node rootNode) | → inherited from Node |
Gets next node according to the pre-order tree traversal algorithm. | ||
Node | prependChild(Node newChild) | → inherited from CompositeNode |
Adds the specified node to the beginning of the list of child nodes for this node. | ||
Node | previousPreOrder(Node rootNode) | → inherited from Node |
Gets the previous node according to the pre-order tree traversal algorithm. | ||
void | remove() | → inherited from Node |
Removes itself from the parent. | ||
void | removeAllChildren() | → inherited from CompositeNode |
Removes all the child nodes of the current node. | ||
Node | removeChild(Node oldChild) | → inherited from CompositeNode |
Removes the specified child node. | ||
void | removeSmartTags() | → inherited from CompositeNode |
Removes all |
||
NodeList | selectNodes(java.lang.String xpath) | → inherited from CompositeNode |
Selects a list of nodes matching the XPath expression. | ||
Node | selectSingleNode(java.lang.String xpath) | → inherited from CompositeNode |
Selects the first Node that matches the XPath expression. | ||
java.lang.String | toString(int saveFormat) | → inherited from Node |
Exports the content of the node into a string in the specified format. | ||
java.lang.String | toTxt() | → inherited from Node |
Exports the content of the node into a string in plain text format. |
Constructor Detail |
---|
public BuildingBlock(GlossaryDocument glossaryDoc)
When null
.
To append
glossaryDoc
- The owner document.Property Getters/Setters Detail |
---|
getBehavior/setBehavior | |
public int getBehavior() / public void setBehavior(int value) |
getCategory/setCategory | |
public java.lang.String getCategory() / public void setCategory(java.lang.String value) |
Building blocks in Microsoft Word user interface are arranged
into Galleries. Each
Cannot be null
and cannot be an empty string.
Corresponds to the docPartPr.category.name element in OOXML.
getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes() |
Note, GetChildNodes(NodeType.Any, false)
and creates and returns a new collection every time it is accessed.
If there are no child nodes, this property returns an empty collection.
getCount | → inherited from CompositeNode |
public int getCount() |
getDescription/setDescription | |
public java.lang.String getDescription() / public void setDescription(java.lang.String value) |
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.
getDocument | → inherited from Node |
public DocumentBase getDocument() |
The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.
getFirstChild | → inherited from CompositeNode |
public Node getFirstChild() |
getFirstSection | |
public Section getFirstSection() |
null
if there are no sections.
getGallery/setGallery | |
public int getGallery() / public void setGallery(int value) |
Building blocks in Microsoft Word user interface are arranged
into Galleries. Each
Corresponds to the docPartPr.category.gallery element in OOXML.
getGuid/setGuid | |
public java.util.UUID getGuid() / public void setGuid(java.util.UUID value) |
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.
hasChildNodes | → inherited from CompositeNode |
public boolean hasChildNodes() |
isComposite | → inherited from CompositeNode |
public boolean isComposite() |
getLastChild | → inherited from CompositeNode |
public Node getLastChild() |
getLastSection | |
public Section getLastSection() |
null
if there are no sections.
getName/setName | |
public java.lang.String getName() / public void setName(java.lang.String value) |
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.
getNextSibling | → inherited from Node |
public Node getNextSibling() |
getNodeType | |
public int getNodeType() |
getParentNode | → inherited from Node |
public CompositeNode getParentNode() |
If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.
getPreviousSibling | → inherited from Node |
public Node getPreviousSibling() |
getRange | → inherited from Node |
public Range getRange() |
getSections | |
public SectionCollection getSections() |
getType/setType | |
public int getType() / public void setType(int value) |
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.
Method Detail |
---|
accept | |
public boolean accept(DocumentVisitor visitor) throws java.lang.Exception |
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.
Calls
Note: A building block node and its children are not visited when you execute a
Visitor over a
visitor
- The visitor that will visit the nodes.appendChild | → inherited from CompositeNode |
public Node appendChild(Node newChild) |
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The node to add.deepClone | → inherited from Node |
public Node deepClone(boolean isCloneChildren) |
This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.
This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.
isCloneChildren
- True to recursively clone the subtree under the specified node;
false to clone only the node itself.getAncestor | → inherited from Node |
public CompositeNode getAncestor(int ancestorType) |
ancestorType
- A getAncestor | → inherited from Node |
public CompositeNode getAncestor(java.lang.Class ancestorType) |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The object type of the ancestor to retrieve.getChild | → inherited from CompositeNode |
public Node getChild(int nodeType, int index, boolean isDeep) |
If index is out of range, a null is returned.
nodeType
- A index
- Zero based index of the child node to select.
Negative indexes are also allowed and indicate access from the end,
that is -1 means the last node.isDeep
- True to select from all child nodes recursively.
False to select only among immediate children. See remarks for more info.getChildNodes | → inherited from CompositeNode |
public NodeCollection getChildNodes(int nodeType, boolean isDeep) |
The collection of nodes returned by this method is always live.
A live collection is always in sync with the document. For example, if you selected all sections in a document and enumerate through the collection deleting the sections, the section is removed from the collection immediately when it is removed from the document.
nodeType
- A isDeep
- True to select from all child nodes recursively.
False to select only among immediate children. getContainer | → inherited from CompositeNode |
public CompositeNode getContainer() |
getNextMatchingNode | → inherited from CompositeNode |
public Node getNextMatchingNode(aspose.obfuscated.type curNode) |
getText | → inherited from CompositeNode |
public java.lang.String getText() |
The returned string includes all control and special characters as described in
indexOf | → inherited from CompositeNode |
public int indexOf(Node child) |
insertAfter | → inherited from CompositeNode |
public Node insertAfter(Node newChild, Node refChild) |
If refChild is null, inserts newChild at the beginning of the list of child nodes.
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newNode is placed after the refNode. insertBefore | → inherited from CompositeNode |
public Node insertBefore(Node newChild, Node refChild) |
If refChild is null, inserts newChild at the end of the list of child nodes.
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The Node to insert.refChild
- The Node that is the reference node. The newChild is placed before this node.iterator | → inherited from CompositeNode |
public java.util.Iterator iterator() |
nextPreOrder | → inherited from Node |
public Node nextPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.prependChild | → inherited from CompositeNode |
public Node prependChild(Node newChild) |
If the newChild is already in the tree, it is first removed.
If the node being inserted was created from another document, you should use
newChild
- The node to add.previousPreOrder | → inherited from Node |
public Node previousPreOrder(Node rootNode) |
rootNode
- The top node (limit) of traversal.remove | → inherited from Node |
public void remove() |
removeAllChildren | → inherited from CompositeNode |
public void removeAllChildren() |
removeChild | → inherited from CompositeNode |
public Node removeChild(Node oldChild) |
The parent of oldChild is set to null after the node is removed.
oldChild
- The node to remove.removeSmartTags | → inherited from CompositeNode |
public void removeSmartTags() |
selectNodes | → inherited from CompositeNode |
public NodeList selectNodes(java.lang.String xpath) |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.selectSingleNode | → inherited from CompositeNode |
public Node selectSingleNode(java.lang.String xpath) |
Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
xpath
- The XPath expression.toString | → inherited from Node |
public java.lang.String toString(int saveFormat) throws java.lang.Exception |
saveFormat
- A SaveFormat value.toTxt | → inherited from Node |
public java.lang.String toTxt() throws java.lang.Exception |
This method removes field codes and Microsoft Word control characters, uses CrLf
(or any other) combination of characters to mark ends of paragraphs in the resulting string.
It produces a different result from