CheckboxField

Огляд

CheckboxField є клас в Aspose.PDF FOSS для Java. Наследники від: Field.

Поле для відтиску (/FT /Btn) (ISO 32000-1:2008, §12.7.4.2.3).

Цей клас надає 91 метод для роботи з об’єктами CheckboxField в програмах Java. Доступні методи включають: CheckboxField, WidgetAnnotation, addOption, flatten, fromDictionary, get, getActions, getAllowedStates, getAlternateName, getAnnotationIndex, getAppearance, getAppearanceCharacteristics, і 77 додаткових методів. Всі публічні члени доступні будь-якій додаткові Java після встановлення FOSS для пакету Java. Свойства: actions, allowedStates, alternateName, annotationIndex, appearance, appearanceCharacteristics, і ще 49 осіб.

Свойства

Назва:	Тип	Access	Опис
`style`	`BoxStyle`	Читати.	Повертає стиль знака відтиску для цього ящика.
`checked`	`boolean`	Читати.	Повертає, чи є це орієнтовано.
`exportValue`	`String`	Читати.	Повертає експортну вартість (назва в стані) цього ящика.
`allowedStates`	`List<String>`	Читати.	Повертає всі дозволені стани, включаючи “Оф” та будь-які наявності в словнику нормального вигляду імена.
`border`	`Border`	Читати.	Повертає межу поля форми.
`actions`	`org.aspose.pdf.annotations.AnnotationActionCollection`	Читати.	Повертає колекцію дій для цього поля.
`partialName`	`String`	Читати.	Повертає назву частини поля (/В).
`fullName`	`String`	Читати.	Повертає повністю кваліфіковану точкову назву цього поля.
`alternateName`	`String`	Читати.	Повертає альтернативну (код інструментів) назву (/упис ТУ).
`value`	`String`	Читати.	Повертає значення поля (/V) як струнку.
`defaultValue`	`String`	Читати.	Повертає значення по умові (/DV) як ряд.
`fieldFlags`	`int`	Читати.	Повертає знаки поля (/Ff запис).
`readOnly`	`boolean`	Читати.	Повертає, чи є це поле тільки для читання (біт 1 /Ff).
`required`	`boolean`	Читати.	Повертає, чи потрібне це поле (біт 2 /Ff).
`noExport`	`boolean`	Читати.	Повертає, чи виключено це поле з експорту (біт 3 /Ff).
`defaultAppearance`	`String`	Читати.	Повертає по умові струнку з’ясування (/ DA вхід).
`characteristics`	`AppearanceCharacteristics`	Читати.	Повертає помічник характеристик зовнішнього вигляду, який підтримується словником /MK.
`appearance`	`AppearanceDictionary`	Читати.	Повертає вписані види на {@code /AP} зовнішній словник цього поля (ISO 32000-1:2008 §12.5.5).
`count`	`int`	Читати.	Повертає кількість дитячих полей (підвиджетів) цього поля.
`pageIndex`	`int`	Читати.	Повертає 1-оснований індекс сторінки, на якому знаходиться анотация віджету цього поля.
`annotationIndex`	`int`	Читати.	Повертає індекс анотації на основі 0 цього поля в масиві анонтацій його сторінки.
`fieldType`	`String`	Читати.	Повертає тип поля (/FT), наприклад:.
`fieldValue`	`PdfBase`	Читати.	Повертає значення нерозробленого поля (/V).
`fieldName`	`String`	Читати.	Повертає назву частини поля (/T).
`highlightMode`	`String`	Читати.	Повертає режим підсвічування (/H).
`appearanceCharacteristics`	`PdfDictionary`	Читати.	Повертає словник характеристик зовнішнього вигляду (/MK).
`widgetAction`	`PdfAction`	Читати.	Повертає дійсність (/A), пов’язану з цим віджетом.
`subtype`	`String`	Читати.	Повертає підтип анотації (наприклад,.
`rect`	`Rectangle`	Читати.	Повертає прямокутник, що визначає його місце на сторінці.
`contents`	`String`	Читати.	Повертає текст аннотації (/Вхід змісту).
`name`	`String`	Читати.	Повертає унікальне ім’я анотації (/NM вхід).
`modified`	`String`	Читати.	Повертає дату та час останньої зміни анотації (/M запис).
`flags`	`int`	Читати.	Повертає знаки анотації (/F) як біт-маску.
`flagsAsEnum`	`java.util.EnumSet<AnnotationFlags>`	Читати.	Повертає флаги анотації як вписану {@link java.util.EnumSet} .
`invisible`	`boolean`	Читати.	Повертає, встановлено чи невидимий значок (біт 1).
`hidden`	`boolean`	Читати.	Повертає, встановлено чи не “Сприйдений” (біт 2).
`print`	`boolean`	Читати.	Повертає, встановлено ли значок “Відтворення” (бітовий 3).
`noZoom`	`boolean`	Читати.	Повертає, встановлено ли значок NoZoom (біт 4).
`noRotate`	`boolean`	Читати.	Повертає, встановлено ли значок NoRotate (біт 5).
`noView`	`boolean`	Читати.	Повертає, встановлено ли значок NoView (біт 6).
`locked`	`boolean`	Читати.	Повертає, встановлено ли значок “Заключений” (бит 8).
`color`	`Color`	Читати.	Повертає колір анотації (/C вхід).
`normalAppearanceStream`	`PdfStream`	Читати.	Повертає потік нормального вигляду (/AP /N) для цієї анотації (ISO 32000-1:2008, §12.5.5).
`normalAppearance`	`XForm`	Читати.	Повертає нормальний вигляд як {@link XForm}, відображаючи властивість C# { @ code Annotation.NormalAppearance} .
`opacity`	`double`	Читати.	Повертає непрозорість анотації (0,0 = повністю прозоре, 1,0 = цілком непрозорі).
`zIndex`	`int`	Читати.	Повертає Z-індекс (порядку малювання) цієї анотації.
`page`	`Page`	Читати.	Повертає сторінку, до якої належить ця аннотация.
`pdfDictionary`	`PdfDictionary`	Читати.	Повертає базовий словник PDF для цієї анотації.
`margin`	`MarginInfo`	Читати.	Отримає інформацію про маржі для цього пункту.
`horizontalAlignment`	`HorizontalAlignment`	Читати.	Отримає горизонтальне вирівнювання цього параграфа в його контейнері.
`inLineParagraph`	`boolean`	Читати.	Повертає, чи є цей абзац елементом в лінії.
`keptWithNext`	`boolean`	Читати.	Повертає, чи слід зберігати цей абзац разом з наступним абзацем на одній сторінці під час оформлення.
`firstParagraphInColumn`	`boolean`	Читати.	Повертає, чи є цей абзац першим у своєму колоні.
`inNewPage`	`boolean`	Читати.	Повертає, чи повинен цей абзац починатися на новій сторінці під час оформлення.
`hyperlink`	`Hyperlink`	Читати.	Повертає гіперзв’язок, що прикріплений до цього параграфа (веб-сайт, локальний або файл-цільовий), або {@code null} якщо параграф не є кликабельним.

Методи

Signature	Опис
`CheckboxField(dict: PdfDictionary, page: Page, fullName: String)`	Створює поле для відтиску з існуючого словника PDF.
`CheckboxField()`	Створює нове поле порожнього ящика.
`CheckboxField(page: Page, rect: Rectangle)`	Створює нове поле для орієнтації на зазначеному сторінці з даним прямокутником.
`regenerateAppearance()`	Відбудує потоки {@code /AP/N/Yes} та { @code 'AP') з актуального прямокутного, стилю і ім’я експортного значення.
`getStyle()` → `BoxStyle`	Повертає стиль знака відтиску для цього ящика.
`setStyle(style: BoxStyle)`	Налаштовує стиль відмітки цього ящика і регенерує потоки {@code /AP/N}, щоб відображався новий гліф.
`setWidth(width: double)`	Налаштує ширину цього ящика, оновлюючи запис /Rect.
`setHeight(height: double)`	Налаштує висоту цього ящика за допомогою оновлення запису /Rect.
`isChecked()` → `boolean`	Повертає, чи є це орієнтовано.
`setChecked(checked: boolean)`	Налаштовує зауважений стан цього ящика.
`getExportValue()` → `String`	Повертає експортну вартість (назва в стані) цього ящика.
`setExportValue(exportValue: String)`	Назначення експортного значення (назва в режимі) цього ящика.
`addOption(optionValue: String)`	Додає ще один дозволений на стан для Aspose-сумісних робочих потоків.
`getAllowedStates()` → `List<String>`	Повертає всі дозволені стани, включаючи “Оф” та будь-які наявності в словнику нормального вигляду імена.
`setValue(value: String)`	Налаштовує значення.
`getBorder()` → `Border`	Повертає межу поля форми.
`setBorder(border: Border)`	Налаштовує межу поля форми.
`getActions()` → `org.aspose.pdf.annotations.AnnotationActionCollection`	Повертає колекцію дій для цього поля.
`getPartialName()` → `String`	Повертає назву частини поля (/В).
`setPartialName(name: String)`	Назначення загального полі (/В).
`getFullName()` → `String`	Повертає повністю кваліфіковану точкову назву цього поля.
`getAlternateName()` → `String`	Повертає альтернативну (код інструментів) назву (/упис ТУ).
`getValue()` → `String`	Повертає значення поля (/V) як струнку.
`getDefaultValue()` → `String`	Повертає значення по умові (/DV) як ряд.
`getFieldFlags()` → `int`	Повертає знаки поля (/Ff запис).
`setFieldFlags(flags: int)`	Налаштує знаки поля (/Ff запис).
`isReadOnly()` → `boolean`	Повертає, чи є це поле тільки для читання (біт 1 /Ff).
`isRequired()` → `boolean`	Повертає, чи потрібне це поле (біт 2 /Ff).
`isNoExport()` → `boolean`	Повертає, чи виключено це поле з експорту (біт 3 /Ff).
`getDefaultAppearance()` → `String`	Повертає по умові струнку з’ясування (/ DA вхід).
`setDefaultAppearance(da: String)`	Налаштовує по умові струнку зовнішнього вигляду поля (/Вставка DA).
`getCharacteristics()` → `AppearanceCharacteristics`	Повертає помічник характеристик зовнішнього вигляду, який підтримується словником /MK.
`getAppearance()` → `AppearanceDictionary`	Повертає вписані види на {@code /AP} зовнішній словник цього поля (ISO 32000-1:2008 §12.5.5).
`fromDictionary(dict: PdfDictionary, ftObj: PdfBase, fullName: String, page: Page, parser: PDFParser)` → `Field`	Метод Factory: створює відповідний підклас {@link Field} з словника PDF.
`getCount()` → `int`	Повертає кількість дитячих полей (підвиджетів) цього поля.
`get(index: int)` → `Field`	Повертає дитяче поле при даному 1-базовому індексі.
`iterator()` → `Iterator<Field>`	Повертає ітератор над дітьми полей (субвиджетів) цього поля.
`getPageIndex()` → `int`	Повертає 1-оснований індекс сторінки, на якому знаходиться анотация віджету цього поля.
`getAnnotationIndex()` → `int`	Повертає індекс анотації на основі 0 цього поля в масиві анонтацій його сторінки.
`WidgetAnnotation(dict: PdfDictionary, page: Page)`	Створює анотацію віджету з існуючого словника PDF.
`getFieldType()` → `String`	Повертає тип поля (/FT), наприклад:.
`getFieldValue()` → `PdfBase`	Повертає значення нерозробленого поля (/V).
`getFieldName()` → `String`	Повертає назву частини поля (/T).
`getHighlightMode()` → `String`	Повертає режим підсвічування (/H).
`getAppearanceCharacteristics()` → `PdfDictionary`	Повертає словник характеристик зовнішнього вигляду (/MK).
`getWidgetAction()` → `PdfAction`	Повертає дійсність (/A), пов’язану з цим віджетом.
`getSubtype()` → `String`	Повертає підтип анотації (наприклад,.
`getRect()` → `Rectangle`	Повертає прямокутник, що визначає його місце на сторінці.
`setRect(rect: Rectangle)`	Налаштовує прямокутник анотації (ISO 32000-1:2008 §12.5.2, таблиця 164, {@code /Rect} entry).
`getContents()` → `String`	Повертає текст аннотації (/Вхід змісту).
`setContents(contents: String)`	Налаштовує зміст тексту анотації (/Вставка вмісту).
`getName()` → `String`	Повертає унікальне ім’я анотації (/NM вхід).
`setName(name: String)`	Назначення унікальної назви анотації (/NM запис).
`getModified()` → `String`	Повертає дату та час останньої зміни анотації (/M запис).
`setModified(date: String)`	Назначає дату та час останньої зміни анотації (/M запис).
`getFlags()` → `int`	Повертає знаки анотації (/F) як біт-маску.
`setFlags(flags: int)`	Налаштовує знаки анотації (/F) як біт-маску.
`getFlagsAsEnum()` → `java.util.EnumSet<AnnotationFlags>`	Повертає флаги анотації як вписану {@link java.util.EnumSet} .
`isInvisible()` → `boolean`	Повертає, встановлено чи невидимий значок (біт 1).
`isHidden()` → `boolean`	Повертає, встановлено чи не “Сприйдений” (біт 2).
`isPrint()` → `boolean`	Повертає, встановлено ли значок “Відтворення” (бітовий 3).
`isNoZoom()` → `boolean`	Повертає, встановлено ли значок NoZoom (біт 4).
`isNoRotate()` → `boolean`	Повертає, встановлено ли значок NoRotate (біт 5).
`isNoView()` → `boolean`	Повертає, встановлено ли значок NoView (біт 6).
`isLocked()` → `boolean`	Повертає, встановлено ли значок “Заключений” (бит 8).
`getColor()` → `Color`	Повертає колір анотації (/C вхід).
`setColor(color: Color)`	Налаштовує колір анотації (/C вхід) як масив кольорів RGB.
`getNormalAppearanceStream()` → `PdfStream`	Повертає потік нормального вигляду (/AP /N) для цієї анотації (ISO 32000-1:2008, §12.5.5).
`getNormalAppearance()` → `XForm`	Повертає нормальний вигляд як {@link XForm}, відображаючи властивість C# { @ code Annotation.NormalAppearance} .
`flatten()`	Сплавлює цю анотацію в потоку змісту сторінки.
`getOpacity()` → `double`	Повертає непрозорість анотації (0,0 = повністю прозоре, 1,0 = цілком непрозорі).
`setOpacity(opacity: double)`	Налаштовує непрозорість анотації (0,0 = повністю прозоре, 1,0 = цілком непрозорі).
`getZIndex()` → `int`	Повертає Z-індекс (порядку малювання) цієї анотації.
`setZIndex(zIndex: int)`	Налаштовує Z-індекс (порядку черкування) цієї анотації.
`getPage()` → `Page`	Повертає сторінку, до якої належить ця аннотация.
`setPage(page: Page)`	Назначає сторінку, до якої належить ця аннотація.
`getPdfDictionary()` → `PdfDictionary`	Повертає базовий словник PDF для цієї анотації.
`getMargin()` → `MarginInfo`	Отримає інформацію про маржі для цього пункту.
`setMargin(margin: MarginInfo)`	Назначення інформації про маржі для цього пункту.
`getHorizontalAlignment()` → `HorizontalAlignment`	Отримає горизонтальне вирівнювання цього параграфа в його контейнері.
`setHorizontalAlignment(horizontalAlignment: HorizontalAlignment)`	Назначає горизонтальне вирівнювання цього пункту в його контейнері.
`isInLineParagraph()` → `boolean`	Повертає, чи є цей абзац елементом в лінії.
`setInLineParagraph(inLineParagraph: boolean)`	Визначить, чи слід розглядати цей пункт як встрочений елемент.
`isKeptWithNext()` → `boolean`	Повертає, чи слід зберігати цей абзац разом з наступним абзацем на одній сторінці під час оформлення.
`setKeptWithNext(keptWithNext: boolean)`	Назначає, чи слід зберігати цей абзац разом з наступним абзацем на одній сторінці під час оформлення.
`isFirstParagraphInColumn()` → `boolean`	Повертає, чи є цей абзац першим у своєму колоні.
`setFirstParagraphInColumn(firstParagraphInColumn: boolean)`	Визначає, чи є цей пункт першим у колонці.
`isInNewPage()` → `boolean`	Повертає, чи повинен цей абзац починатися на новій сторінці під час оформлення.
`setInNewPage(inNewPage: boolean)`	Налаштовує, чи повинен цей абзац починатися на новій сторінці під час оформлення.
`getHyperlink()` → `Hyperlink`	Повертає гіперзв’язок, що прикріплений до цього параграфа (веб-сайт, локальний або файл-цільовий), або {@code null} якщо параграф не є кликабельним.
`setHyperlink(hyperlink: Hyperlink)`	Прикріпляє гіперпосилку до цього пункту.

Див. також

Aspose.PDF for Java — Enterprise API Reference