FooterArtifact
Наследование: java.lang.Object, com.aspose.pdf.Artifact
public class FooterArtifact extends Artifact
Описывает артефакт нижнего колонтитула. Это может быть использовано для установки нижнего колонтитула страницы.
Конструкторы
Конструктор | Описание |
---|---|
FooterArtifact() | Создает экземпляр артефакта нижнего колонтитула. |
Методы
Метод | Описание |
---|---|
beginUpdates() | Запустить удаленные обновления. |
close() | Закрывает все ресурсы, используемые этим документом. |
dispose() | Утилизируйте артефакт. |
equals(Object arg0) | |
getArtifactHorizontalAlignment() | Получает горизонтальное выравнивание артефакта. |
getArtifactVerticalAlignment() | Получает вертикальное выравнивание артефакта. |
getBottomMargin() | Получает нижнее поле артефакта. |
getClass() | |
getContents() | Получает коллекцию внутренних операторов артефакта. |
getCustomSubtype() | Получает имя подтипа артефакта. |
getCustomType() | Получает имя типа артефакта. |
getForm() | Получает XForm артефакта (если используется XForm). |
getImage() | Получает изображение артефакта (если присутствует). |
getLeftMargin() | Получает левое поле артефакта. |
getLines() | Строки многострочного текстового артефакта. |
getOpacity() | Получает непрозрачность артефакта. |
getPosition() | Получает позицию артефакта. |
getRectangle() | Получает прямоугольник артефакта. |
getRightMargin() | Получает правый край артефакта. |
getRotation() | Получает угол поворота артефакта. |
getSubtype() | Получает подтип артефакта. |
getText() | Получает текст артефакта. |
getTextState() | Текстовое состояние для текста артефакта. |
getTopMargin() | Получает верхнее поле артефакта. |
getType() | Получает тип артефакта. |
getValue(String name) | Получает пользовательское значение артефакта. |
hashCode() | |
isBackground() | Если правда Артефакт размещается за содержимым страницы. |
notify() | |
notifyAll() | |
removeValue(String name) | Удалить пользовательское значение из артефакта. |
saveUpdates() | Сохраняет в артефакте все обновления, сделанные после вызова BeginUpdates(). |
setArtifactHorizontalAlignment(int value) | Получает горизонтальное выравнивание артефакта. |
setArtifactVerticalAlignment(int value) | Устанавливает вертикальное выравнивание артефакта. |
setBackground(boolean value) | Если правда Артефакт размещается за содержимым страницы. |
setBottomMargin(double value) | Устанавливает нижнее поле артефакта. |
setCustomSubtype(String value) | |
setCustomType(String value) | Устанавливает имя типа артефакта. |
setImage(InputStream imageStream) | Задает изображение артефакта. |
setImage(String imageName) | Задает изображение артефакта. |
setLeftMargin(double value) | Устанавливает левое поле артефакта. |
setLinesAndState(String[] text, TextState textState) | Установите текст и текстовые свойства артефакта. |
setOpacity(double value) | Устанавливает непрозрачность артефакта. |
setPdfPage(Page page) | Устанавливает страницу PDF, которая помещается на страницу документа как артефакт. |
setPosition(Point value) | Устанавливает положение артефакта. |
setRightMargin(double value) | Устанавливает правое поле артефакта. |
setRotation(double value) | Устанавливает угол поворота артефакта. |
setSubtype(int value) | Устанавливает подтип артефакта. |
setText(FormattedText formattedText) | Задает текст артефакта. |
setText(String value) | Задает текст артефакта. |
setTextAndState(String text, TextState textState) | Установите текст и текстовые свойства артефакта. |
setTextState(TextState value) | Текстовое состояние для текста артефакта. |
setTopMargin(double value) | Устанавливает верхнее поле артефакта. |
setType(int value) | Устанавливает тип артефакта. |
setValue(String name, String value) | Устанавливает пользовательское значение артефакта. |
toString() | |
wait() | |
wait(long arg0) | |
wait(long arg0, int arg1) |
FooterArtifact()
public FooterArtifact()
Создает экземпляр артефакта нижнего колонтитула.
beginUpdates()
public void beginUpdates()
Запустить удаленные обновления. Используйте эту функцию, если вам нужно внести несколько изменений в один и тот же артефакт для повышения производительности. Обычно операторы артефакта изменяются всякий раз, когда изменяется свойство артефакта. Это вызывает изменение содержимого страницы каждый раз, когда артефакт был изменен. Чтобы избежать этого эффекта, поместите все обновления артефактов между вызовами StartUpdates/SaveUpdates. Это позволяет изменить содержимое страницы только один раз.
Artifact art = doc.getPages().get_Item(1).getArtifacts().get_Item(1);
art.beginUpdates();
art.setOpacity ( 0.3f);
art.setPosition ( new Point(10,10));
art.setRotation (30);
art.saveUpdates();
close()
public void close()
Закрывает все ресурсы, используемые этим документом.
dispose()
public void dispose()
Утилизируйте артефакт.
Этот метод устарел, вместо него используйте close().
equals(Object arg0)
public boolean equals(Object arg0)
Параметры:
Параметр | Тип | Описание |
---|---|---|
arg0 | java.lang.Object |
Возвращает: логический
getArtifactHorizontalAlignment()
public int getArtifactHorizontalAlignment()
Получает горизонтальное выравнивание артефакта. Если позиция указана явно (в свойстве Position), это значение игнорируется.
Возвращает: int - значение HorizontalAlignment
getArtifactVerticalAlignment()
public int getArtifactVerticalAlignment()
Получает вертикальное выравнивание артефакта. Если позиция указана явно (в свойстве Position), это значение игнорируется.
Возвращает: int — значение вертикального выравнивания.
getBottomMargin()
public double getBottomMargin()
Получает нижнее поле артефакта. Если позиция указана явно (в свойстве Position), это значение игнорируется.
Возвращает: двойное нижнее поле.
getClass()
public final native Class<?> getClass()
Возвращает: java.lang.Класс
getContents()
public List<Operator> getContents()
Получает коллекцию внутренних операторов артефакта.
Возвращает: java.util.List<com.aspose.pdf.Operator> — список внутренних операторов артефакта.
getCustomSubtype()
public String getCustomSubtype()
Получает имя подтипа артефакта. Может использоваться, если подтип артефакта не является стандартным подтипом.
Возвращает: java.lang.String — строковое значение
getCustomType()
public String getCustomType()
Получает имя типа артефакта. Может использоваться, если тип артефакта нестандартный.
Возвращает: java.lang.String — имя строкового артефакта
getForm()
public XForm getForm()
Получает XForm артефакта (если используется XForm).
Возвращает: XForm - XForm объект
getImage()
public XImage getImage()
Получает изображение артефакта (если присутствует).
Возвращает: XImage - XImage объект
getLeftMargin()
public double getLeftMargin()
Получает левое поле артефакта. Если позиция указана явно (в свойстве Position), это значение игнорируется.
Возвращает: double - левое поле артефакта.
getLines()
public final List<String> getLines()
Строки многострочного текстового артефакта.
Возвращает: java.util.List<java.lang.String> — список строк
getOpacity()
public double getOpacity()
Получает непрозрачность артефакта. Возможные значения находятся в диапазоне 0..1.
Возвращает: double - непрозрачность артефакта.
getPosition()
public Point getPosition()
Получает позицию артефакта. Если это свойство указано, поля и выравнивание игнорируются.
Возвращает: Point - положение артефакта.
getRectangle()
public Rectangle getRectangle()
Получает прямоугольник артефакта.
Возвращает: Rectangle - Прямоугольный объект
getRightMargin()
public double getRightMargin()
Получает правый край артефакта. Если позиция указана явно (в свойстве Position), это значение игнорируется.
Возвращает: double - правый край артефакта.
getRotation()
public double getRotation()
Получает угол поворота артефакта.
Возвращает: double - угол поворота артефакта.
getSubtype()
public int getSubtype()
Получает подтип артефакта. Если артефакт имеет нестандартный подтип, имя подтипа можно прочитать через CustomSubtype.
Возвращает: int - подтип артефакта.
getText()
public String getText()
Получает текст артефакта.
Возвращает: java.lang.String — строковое значение
getTextState()
public final TextState getTextState()
Текстовое состояние для текста артефакта.
Возвращает: TextState - Экземпляр TextState
getTopMargin()
public double getTopMargin()
Получает верхнее поле артефакта. Если позиция указана явно (в свойстве Position), это значение игнорируется.
Возвращает: двойное - верхнее поле артефакта.
getType()
public int getType()
Получает тип артефакта.
Возвращает: int - значение типа артефакта.
getValue(String name)
public String getValue(String name)
Получает пользовательское значение артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
name | java.lang.String | Имя значения. |
Возвращает: java.lang.String — значение или ноль, если значение не существует.
hashCode()
public native int hashCode()
Возвращает: инт
isBackground()
public boolean isBackground()
Если правда Артефакт размещается за содержимым страницы.
Возвращает: boolean - логическое значение
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
removeValue(String name)
public void removeValue(String name)
Удалить пользовательское значение из артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
name | java.lang.String | Имя пользовательского значения, которое нужно удалить. |
saveUpdates()
public void saveUpdates()
Сохраняет в артефакте все обновления, сделанные после вызова BeginUpdates().
setArtifactHorizontalAlignment(int value)
public void setArtifactHorizontalAlignment(int value)
Получает горизонтальное выравнивание артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | int | горизонтальное выравнивание артефакта. |
setArtifactVerticalAlignment(int value)
public void setArtifactVerticalAlignment(int value)
Устанавливает вертикальное выравнивание артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | int | вертикальное выравнивание артефакта. |
setBackground(boolean value)
public void setBackground(boolean value)
Если правда Артефакт размещается за содержимым страницы.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | логическое значение |
setBottomMargin(double value)
public void setBottomMargin(double value)
Устанавливает нижнее поле артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | double | нижнее поле. |
setCustomSubtype(String value)
public void setCustomSubtype(String value)
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | java.lang.String |
setCustomType(String value)
public void setCustomType(String value)
Устанавливает имя типа артефакта. Может использоваться, если тип артефакта нестандартный.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | java.lang.String | Строковое имя артефакта |
setImage(InputStream imageStream)
public void setImage(InputStream imageStream)
Задает изображение артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
imageStream | java.io.InputStream | Поток, содержащий данные изображения. |
setImage(String imageName)
public void setImage(String imageName)
Задает изображение артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
imageName | java.lang.String | Имя файла изображения. |
setLeftMargin(double value)
public void setLeftMargin(double value)
Устанавливает левое поле артефакта. Если позиция указана явно (в свойстве Position), это значение игнорируется.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | double | левое поле артефакта. |
setLinesAndState(String[] text, TextState textState)
public void setLinesAndState(String[] text, TextState textState)
Установите текст и текстовые свойства артефакта. Позволяет указать несколько строк.
Параметры:
Параметр | Тип | Описание |
---|---|---|
text | java.lang.String[] | Массив текстовой строки. |
textState | TextState | Свойства текста. |
setOpacity(double value)
public void setOpacity(double value)
Устанавливает непрозрачность артефакта. Возможные значения находятся в диапазоне 0..1.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | double | непрозрачность артефакта. |
setPdfPage(Page page)
public void setPdfPage(Page page)
Устанавливает страницу PDF, которая помещается на страницу документа как артефакт.
Параметры:
Параметр | Тип | Описание |
---|---|---|
page | Page | Страница, размещенная как Artifcact. |
setPosition(Point value)
public void setPosition(Point value)
Устанавливает положение артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | Point | положение артефакта. |
setRightMargin(double value)
public void setRightMargin(double value)
Устанавливает правое поле артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | double | правый край артефакта. |
setRotation(double value)
public void setRotation(double value)
Устанавливает угол поворота артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | double | угол поворота артефакта. |
setSubtype(int value)
public void setSubtype(int value)
Устанавливает подтип артефакта. Если артефакт имеет нестандартный подтип, имя подтипа можно прочитать через CustomSubtype.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | int | подтип артефакта. |
setText(FormattedText formattedText)
public void setText(FormattedText formattedText)
Задает текст артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
formattedText | FormattedText | Объект FormattedText, содержащий артефактный текст. |
setText(String value)
public void setText(String value)
Задает текст артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | java.lang.String | Строковое значение |
setTextAndState(String text, TextState textState)
public void setTextAndState(String text, TextState textState)
Установите текст и текстовые свойства артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
text | java.lang.String | Текстовая строка. |
textState | TextState | Текстовое состояние. |
setTextState(TextState value)
public final void setTextState(TextState value)
Текстовое состояние для текста артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | TextState | Экземпляр TextState |
setTopMargin(double value)
public void setTopMargin(double value)
Устанавливает верхнее поле артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | double | верхнее поле артефакта. |
setType(int value)
public void setType(int value)
Устанавливает тип артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | int | тип артефакта. |
setValue(String name, String value)
public void setValue(String name, String value)
Устанавливает пользовательское значение артефакта.
Параметры:
Параметр | Тип | Описание |
---|---|---|
name | java.lang.String | Имя пользовательского значения. |
value | java.lang.String | Пользовательское значение в артефакте. |
toString()
public String toString()
Возвращает: 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 |