HeaderFooter

Наследование: java.lang.Object, com.aspose.words.Node, com.aspose.words.CompositeNode, com.aspose.words.Story

public class HeaderFooter extends Story

Представляет контейнер для текста верхнего или нижнего колонтитула раздела.

Чтобы узнать больше, посетитеWorking with Headers and Footers документальная статья.

HeaderFooter может содержатьParagraph а такжеTable дочерние узлы.

HeaderFooter является узлом уровня раздела и может быть только потомкомSection . Может быть только одинHeaderFooter или каждыйgetHeaderFooterType() вSection.

ЕслиSection не имеетHeaderFooter определенного вида илиHeaderFooterне имеет дочерних узлов, этот верхний/нижний колонтитул считается связанным с верхним/нижним колонтитулом того же типа, что и предыдущий раздел в Microsoft Word.

КогдаHeaderFooter содержит по крайней мере одинParagraph, он больше не считается связанным с предыдущим в Microsoft Word.

Конструкторы

Конструктор	Описание
HeaderFooter(DocumentBase doc, int headerFooterType)	Инициализирует новый экземпляр этого класса.

Методы

Метод	Описание
accept(DocumentVisitor visitor)	Принимает посетителя.
appendChild(Node newChild)	Добавляет указанный узел в конец списка дочерних узлов для этого узла.
appendParagraph(String text)	Быстрый метод, который создаетParagraphобъект с необязательным текстом и добавляет его в конец этого объекта.
dd()
deepClone(boolean isCloneChildren)	Создает дубликат узла.
deleteShapes()	Удаляет все фигуры из текста этой истории.
equals(Object arg0)
getAncestor(int ancestorType)
getAncestor(Class ancestorType)	Получает первого предка указанного типа объекта.
getChild(int nodeType, int index, boolean isDeep)
getChildNodes()	Получает все непосредственные дочерние узлы этого узла.
getChildNodes(int nodeType, boolean isDeep)
getClass()
getContainer()
getCount()	Получает количество непосредственных дочерних элементов этого узла.
getCurrentNode()
getCustomNodeId()	Задает идентификатор пользовательского узла.
getDocument()	Получает документ, которому принадлежит этот узел.
getFirstChild()	Получает первый дочерний элемент узла.
getFirstParagraph()	Получает первый абзац в истории.
getHeaderFooterType()	Получает тип этого верхнего/нижнего колонтитула.
getLastChild()	Получает последний дочерний элемент узла.
getLastParagraph()	Получает последний абзац в истории.
getNextMatchingNode(Node curNode)
getNextSibling()	Получает узел, следующий сразу за этим узлом.
getNodeType()	ВозвращаетNodeType.HeaderFooter.
getParagraphs()	Получает коллекцию абзацев, которые являются непосредственными дочерними элементами истории.
getParentNode()	Получает непосредственного родителя этого узла.
getParentSection()	Получает родительский раздел этой истории.
getPreviousSibling()	Получает узел, непосредственно предшествующий этому узлу.
getRange()	ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле.
getStoryType()	Получает тип этой истории.
getTables()	Получает коллекцию таблиц, которые являются непосредственными дочерними элементами истории.
getText()	Получает текст этого узла и всех его дочерних элементов.
hasChildNodes()	Возвращает true, если у этого узла есть дочерние узлы.
hashCode()
indexOf(Node child)	Возвращает индекс указанного дочернего узла в массиве дочерних узлов.
insertAfter(Node newChild, Node refChild)	Вставляет указанный узел сразу после указанного ссылочного узла.
insertBefore(Node newChild, Node refChild)	Вставляет указанный узел непосредственно перед указанным ссылочным узлом.
isComposite()	Возвращает true, так как этот узел может иметь дочерние узлы.
isHeader()	Правда, если этоHeaderFooter объект является заголовком.
isLinkedToPrevious()	Истинно, если этот верхний или нижний колонтитул связан с соответствующим верхним или нижним колонтитулом в предыдущем разделе.
isLinkedToPrevious(boolean value)	Истинно, если этот верхний или нижний колонтитул связан с соответствующим верхним или нижним колонтитулом в предыдущем разделе.
iterator()	Обеспечивает поддержку для каждой итерации стиля над дочерними узлами этого узла.
nextPreOrder(Node rootNode)	Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
nodeTypeToString(int nodeType)
notify()
notifyAll()
prependChild(Node newChild)	Добавляет указанный узел в начало списка дочерних узлов для этого узла.
previousPreOrder(Node rootNode)	Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
remove()	Удаляет себя из родителя.
removeAllChildren()	Удаляет все дочерние узлы текущего узла.
removeChild(Node oldChild)	Удаляет указанный дочерний узел.
removeSmartTags()	Удаляет всеSmartTag узлы-потомки текущего узла.
selectNodes(String xpath)	Выбирает список узлов, соответствующих выражению XPath.
selectSingleNode(String xpath)	Выбирает первый узел, соответствующий выражению XPath.
setCustomNodeId(int value)	Задает идентификатор пользовательского узла.
toString()
toString(SaveOptions saveOptions)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.
toString(int saveFormat)
wait()
wait(long arg0)
wait(long arg0, int arg1)

HeaderFooter(DocumentBase doc, int headerFooterType)

public HeaderFooter(DocumentBase doc, int headerFooterType)

Инициализирует новый экземпляр этого класса.

Параметры:

Параметр	Тип	Описание
doc	DocumentBase
headerFooterType	int

accept(DocumentVisitor visitor)

public boolean accept(DocumentVisitor visitor)

Принимает посетителя.

Перечисляет этот узел и все его дочерние элементы. Каждый узел вызывает соответствующий метод в DocumentVisitor.

Дополнительные сведения см. в шаблоне проектирования «Посетитель».

Параметры:

Параметр	Тип	Описание
visitor	DocumentVisitor	Посетитель, который будет посещать узлы.

Возвращает: boolean - Истинно, если были посещены все узлы; false, если DocumentVisitor остановил операцию перед посещением всех узлов. Вызывает DocumentVisitor.VisitHeaderFooterStart, затем вызывает Accept для всех дочерних узлов раздела и в конце вызывает DocumentVisitor.VisitHeaderFooterEnd.

appendChild(Node newChild)

public Node appendChild(Node newChild)

Добавляет указанный узел в конец списка дочерних узлов для этого узла.

Если новый дочерний элемент уже находится в дереве, он сначала удаляется.

Если вставляемый узел был создан из другого документа, следует использоватьM:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) чтобы импортировать узел в текущий документ. Затем импортированный узел можно вставить в текущий документ.

Параметры:

Параметр	Тип	Описание
newChild	Node	Добавляемый узел.

Возвращает: Node - Добавлен узел.

appendParagraph(String text)

public Paragraph appendParagraph(String text)

Быстрый метод, который создаетParagraphобъект с необязательным текстом и добавляет его в конец этого объекта.

Параметры:

Параметр	Тип	Описание
text	java.lang.String	Текст для абзаца. Может быть нулевой или пустой строкой.

Возвращает: Paragraph - Вновь созданный и добавленный абзац.

dd()

public void dd()

deepClone(boolean isCloneChildren)

public Node deepClone(boolean isCloneChildren)

Создает дубликат узла.

Этот метод служит конструктором копирования для узлов. Клонированный узел не имеет родителя, но принадлежит к тому же документу, что и исходный узел.

Этот метод всегда выполняет глубокую копию узла.isCloneChildren Параметр указывает, следует ли также выполнять копирование всех дочерних узлов.

Параметры:

Параметр	Тип	Описание
isCloneChildren	boolean	Значение true, чтобы рекурсивно клонировать поддерево в указанном узле; false, чтобы клонировать только сам узел.

Возвращает: Node - Клонированный узел.

deleteShapes()

public void deleteShapes()

Удаляет все фигуры из текста этой истории.

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

Параметр	Тип	Описание
arg0	java.lang.Object

Возвращает: логический

getAncestor(int ancestorType)

public CompositeNode getAncestor(int ancestorType)

Параметры:

Параметр	Тип	Описание
ancestorType	int

Возвращает: CompositeNode

getAncestor(Class ancestorType)

public CompositeNode getAncestor(Class ancestorType)

Получает первого предка указанного типа объекта.

Параметры:

Параметр	Тип	Описание
ancestorType	java.lang.Class	Тип объекта-предка для извлечения.

Возвращает: CompositeNode - предок указанного типа или ноль, если предок этого типа не найден.

Тип предка совпадает, если он равен ancestorType или является производным от ancestorType.

getChild(int nodeType, int index, boolean isDeep)

public Node getChild(int nodeType, int index, boolean isDeep)

Параметры:

Параметр	Тип	Описание
nodeType	int
index	int
isDeep	boolean

Возвращает: Node

getChildNodes()

public NodeCollection getChildNodes()

Получает все непосредственные дочерние узлы этого узла.

Примечание,getChildNodes() эквивалентно вызову GetChildNodes(NodeType.Any, false) и создает и возвращает новую коллекцию при каждом доступе к ней.

Если дочерних узлов нет, это свойство возвращает пустую коллекцию.

Возвращает: NodeCollection - Все непосредственные дочерние узлы этого узла.

getChildNodes(int nodeType, boolean isDeep)

public NodeCollection getChildNodes(int nodeType, boolean isDeep)

Параметры:

Параметр	Тип	Описание
nodeType	int
isDeep	boolean

Возвращает: NodeCollection

getClass()

public final native Class<?> getClass()

Возвращает: java.lang.Класс

getContainer()

public CompositeNode getContainer()

Возвращает: CompositeNode

getCount()

public int getCount()

Получает количество непосредственных дочерних элементов этого узла.

Возвращает: int - количество непосредственных дочерних элементов этого узла.

getCurrentNode()

public Node getCurrentNode()

Возвращает: Node

getCustomNodeId()

public int getCustomNodeId()

Задает идентификатор пользовательского узла.

По умолчанию ноль.

Этот идентификатор можно установить и использовать произвольно. Например, как ключ для получения внешних данных.

Важное примечание: указанное значение не сохраняется в выходной файл и существует только в течение срока службы узла.

Возвращает: int - соответствующее значение int.

getDocument()

public DocumentBase getDocument()

Получает документ, которому принадлежит этот узел.

Узел всегда принадлежит документу, даже если он только что создан и еще не добавлен в дерево или удален из дерева.

Возвращает: DocumentBase - Документ, которому принадлежит этот узел.

getFirstChild()

public Node getFirstChild()

Получает первый дочерний элемент узла. Если нет первого дочернего узла, возвращается нуль.

Возвращает: Node - Первый дочерний узел.

getFirstParagraph()

public Paragraph getFirstParagraph()

Получает первый абзац в истории.

Возвращает: Paragraph - Первый абзац рассказа.

getHeaderFooterType()

public int getHeaderFooterType()

Получает тип этого верхнего/нижнего колонтитула.

Возвращает: int - Тип этого верхнего/нижнего колонтитула. Возвращаемое значение является одним изHeaderFooterType константы.

getLastChild()

public Node getLastChild()

Получает последний дочерний элемент узла. Если последнего дочернего узла нет, возвращается нуль.

Возвращает: Node - Последний дочерний узел.

getLastParagraph()

public Paragraph getLastParagraph()

Получает последний абзац в истории.

Возвращает: Paragraph - Последний абзац в рассказе.

getNextMatchingNode(Node curNode)

public Node getNextMatchingNode(Node curNode)

Параметры:

Параметр	Тип	Описание
curNode	Node

Возвращает: Node

getNextSibling()

public Node getNextSibling()

Получает узел, следующий сразу за этим узлом. Если следующего узла нет, возвращается нуль.

Возвращает: Node - Узел, непосредственно следующий за этим узлом.

getNodeType()

public int getNodeType()

ВозвращаетNodeType.HeaderFooter.

Возвращает: инт -NodeType.HeaderFooter . Возвращаемое значение является одним изNodeType константы.

getParagraphs()

public ParagraphCollection getParagraphs()

Получает коллекцию абзацев, которые являются непосредственными дочерними элементами истории.

Возвращает: ParagraphCollection - Набор абзацев, которые являются непосредственными потомками истории.

getParentNode()

public CompositeNode getParentNode()

Получает непосредственного родителя этого узла.

Если узел был только что создан и еще не добавлен в дерево, или если он был удален из дерева, родитель имеет значение null.

Возвращает: CompositeNode - Непосредственный родитель этого узла.

getParentSection()

public Section getParentSection()

Получает родительский раздел этой истории.

ParentSection эквивалентен (Section)ParentNode .

Возвращает: Section - Родительский раздел этой истории.

getPreviousSibling()

public Node getPreviousSibling()

Получает узел, непосредственно предшествующий этому узлу. Если предыдущего узла нет, возвращается нуль.

Возвращает: Node - Узел, непосредственно предшествующий этому узлу.

getRange()

public Range getRange()

ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле.

Возвращает: Range - АRange объект, который представляет часть документа, содержащегося в этом узле.

getStoryType()

public int getStoryType()

Получает тип этой истории.

Возвращает: int - Тип этой истории. Возвращаемое значение является одним изStoryType константы.

getTables()

public TableCollection getTables()

Получает коллекцию таблиц, которые являются непосредственными дочерними элементами истории.

Возвращает: TableCollection - Коллекция таблиц, которые являются непосредственными дочерними элементами истории.

getText()

public String getText()

Получает текст этого узла и всех его дочерних элементов.

Возвращаемая строка включает все управляющие и специальные символы, как описано вControlChar.

Возвращает: java.lang.String

hasChildNodes()

public boolean hasChildNodes()

Возвращает true, если у этого узла есть дочерние узлы.

Возвращает: boolean — Истинно, если у этого узла есть дочерние узлы.

hashCode()

public native int hashCode()

Возвращает: инт

indexOf(Node child)

public int indexOf(Node child)

Возвращает индекс указанного дочернего узла в массиве дочерних узлов. Возвращает -1, если узел не найден среди дочерних узлов.

Параметры:

Параметр	Тип	Описание
child	Node

Возвращает: инт

insertAfter(Node newChild, Node refChild)

public Node insertAfter(Node newChild, Node refChild)

Вставляет указанный узел сразу после указанного ссылочного узла.

Если refChild имеет значение null, вставляет newChild в начало списка дочерних узлов.

Если новый дочерний элемент уже находится в дереве, он сначала удаляется.

Если вставляемый узел был создан из другого документа, следует использоватьM:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) чтобы импортировать узел в текущий документ. Затем импортированный узел можно вставить в текущий документ.

Параметры:

Параметр	Тип	Описание
newChild	Node	Узел для вставки.
refChild	Node	Узел, который является эталонным узлом. newNode размещается после refNode.

Возвращает: Node - Вставленный узел.

insertBefore(Node newChild, Node refChild)

public Node insertBefore(Node newChild, Node refChild)

Вставляет указанный узел непосредственно перед указанным ссылочным узлом.

Если refChild имеет значение null, вставляет newChild в конец списка дочерних узлов.

Если новый дочерний элемент уже находится в дереве, он сначала удаляется.

Если вставляемый узел был создан из другого документа, следует использоватьM:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) чтобы импортировать узел в текущий документ. Затем импортированный узел можно вставить в текущий документ.

Параметры:

Параметр	Тип	Описание
newChild	Node	Узел для вставки.
refChild	Node	Узел, который является эталонным узлом. Новый дочерний элемент помещается перед этим узлом.

Возвращает: Node - Вставленный узел.

isComposite()

public boolean isComposite()

Возвращает true, так как этот узел может иметь дочерние узлы.

Возвращает: boolean — True, так как этот узел может иметь дочерние узлы.

isHeader()

public boolean isHeader()

Правда, если этоHeaderFooter объект является заголовком.

Возвращает: boolean - соответствующее логическое значение.

isLinkedToPrevious()

public boolean isLinkedToPrevious()

Истинно, если этот верхний или нижний колонтитул связан с соответствующим верхним или нижним колонтитулом в предыдущем разделе.

Значение по умолчанию верно.

Обратите внимание, когда ваша ссылка находится в верхнем или нижнем колонтитуле, ее содержимое очищается.

Возвращает: boolean - соответствующее логическое значение.

isLinkedToPrevious(boolean value)

public void isLinkedToPrevious(boolean value)

Истинно, если этот верхний или нижний колонтитул связан с соответствующим верхним или нижним колонтитулом в предыдущем разделе.

Значение по умолчанию верно.

Обратите внимание, когда ваша ссылка находится в верхнем или нижнем колонтитуле, ее содержимое очищается.

Параметры:

Параметр	Тип	Описание
value	boolean	Соответствующее логическое значение.

iterator()

public Iterator iterator()

Обеспечивает поддержку для каждой итерации стиля над дочерними узлами этого узла.

Возвращает: java.util.Iterator

nextPreOrder(Node rootNode)

public Node nextPreOrder(Node rootNode)

Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.

Параметры:

Параметр	Тип	Описание
rootNode	Node	Верхний узел (предел) обхода.

Возвращает: Node - Следующий узел в порядке предварительного заказа. Null, если достигнут rootNode.

nodeTypeToString(int nodeType)

public static String nodeTypeToString(int nodeType)

Параметры:

Параметр	Тип	Описание
nodeType	int

Возвращает: java.lang.String

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

prependChild(Node newChild)

public Node prependChild(Node newChild)

Добавляет указанный узел в начало списка дочерних узлов для этого узла.

Если новый дочерний элемент уже находится в дереве, он сначала удаляется.

Если вставляемый узел был создан из другого документа, следует использоватьM:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) чтобы импортировать узел в текущий документ. Затем импортированный узел можно вставить в текущий документ.

Параметры:

Параметр	Тип	Описание
newChild	Node	Добавляемый узел.

Возвращает: Node - Добавлен узел.

previousPreOrder(Node rootNode)

public Node previousPreOrder(Node rootNode)

Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.

Параметры:

Параметр	Тип	Описание
rootNode	Node	Верхний узел (предел) обхода.

Возвращает: Node - Предыдущий узел в порядке предварительного заказа. Null, если достигнут rootNode.

remove()

public void remove()

Удаляет себя из родителя.

removeAllChildren()

public void removeAllChildren()

Удаляет все дочерние узлы текущего узла.

removeChild(Node oldChild)

public Node removeChild(Node oldChild)

Удаляет указанный дочерний узел.

Родительский элемент oldChild устанавливается равным нулю после удаления узла.

Параметры:

Параметр	Тип	Описание
oldChild	Node	Узел для удаления.

Возвращает: Node - Удаленный узел.

removeSmartTags()

public void removeSmartTags()

Удаляет всеSmartTag узлы-потомки текущего узла. Этот метод не удаляет содержимое смарт-тегов.

selectNodes(String xpath)

public NodeList selectNodes(String xpath)

Выбирает список узлов, соответствующих выражению XPath.

На данный момент поддерживаются только выражения с именами элементов. Выражения, использующие имена атрибутов, не поддерживаются.

Параметры:

Параметр	Тип	Описание
xpath	java.lang.String	Выражение XPath.

Возвращает: NodeList - Список узлов, соответствующих запросу XPath.

selectSingleNode(String xpath)

public Node selectSingleNode(String xpath)

Выбирает первый узел, соответствующий выражению XPath.

На данный момент поддерживаются только выражения с именами элементов. Выражения, использующие имена атрибутов, не поддерживаются.

Параметры:

Параметр	Тип	Описание
xpath	java.lang.String	Выражение XPath.

Возвращает: Node - Первый узел, соответствующий запросу XPath, или нуль, если соответствующий узел не найден.

setCustomNodeId(int value)

public void setCustomNodeId(int value)

Задает идентификатор пользовательского узла.

По умолчанию ноль.

Этот идентификатор можно установить и использовать произвольно. Например, как ключ для получения внешних данных.

Важное примечание: указанное значение не сохраняется в выходной файл и существует только в течение срока службы узла.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение.

toString()

public String toString()

Возвращает: java.lang.String

toString(SaveOptions saveOptions)

public String toString(SaveOptions saveOptions)

Экспортирует содержимое узла в строку, используя указанные параметры сохранения.

Параметры:

Параметр	Тип	Описание
saveOptions	SaveOptions	Указывает параметры, управляющие способом сохранения узла.

Возвращает: java.lang.String — содержимое узла в указанном формате.

toString(int saveFormat)

public String toString(int saveFormat)

Параметры:

Параметр	Тип	Описание
saveFormat	int

Возвращает: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

Параметр	Тип	Описание
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

Параметр	Тип	Описание
arg0	long
arg1	int