listItems = new ArrayList<>();
in.readTypedList(listItems, ListItem.CREATOR);
mListItems = Collections.unmodifiableList(listItems);
}
/** Returns the type of this widget */
@WidgetType
public int getWidgetType() {
return mWidgetType;
}
/** Returns the index of the widget within the page's "Annot" array in the PDF document */
@IntRange(from = 0)
public int getWidgetIndex() {
return mWidgetIndex;
}
/**
* Returns the {@link Rect} in page coordinates occupied by the widget
*/
@NonNull
public Rect getWidgetRect() {
return mWidgetRect;
}
/** Returns {@code true} if the widget is read-only */
public boolean isReadOnly() {
return mReadOnly;
}
/**
* Returns the field's text value, if present
*
* Note: Comes from the "V" value in the annotation dictionary. See PDF
* Spec 1.7 Table 8.69
* Table 8.69
*/
@Nullable
public String getTextValue() {
return mTextValue;
}
/**
* Returns the field's accessibility label, if present
*
*
Note: Comes from the "TU" value in the annotation dictionary, if present,
* or else the "T" value. See PDF Spec 1.7 Table 8.69
*/
@Nullable
public String getAccessibilityLabel() {
return mAccessibilityLabel;
}
/** Returns {@code true} if the widget is editable text */
public boolean isEditableText() {
return mEditableText;
}
/**
* Returns {@code true} if the widget supports selecting multiple values
*/
public boolean isMultiSelect() {
return mMultiSelect;
}
/**
* Returns true if the widget supports multiple lines of text input
*/
public boolean isMultiLineText() {
return mMultiLineText;
}
/**
* Returns the maximum length of text supported by a text input widget, or -1 for text inputs
* without a maximum length and widgets that are not text inputs.
*/
@IntRange(from = -1)
public int getMaxLength() {
return mMaxLength;
}
/**
* Returns the font size in pixels for text input, or 0 for text inputs without a specified font
* size and widgets that are not text inputs.
*/
@FloatRange(from = 0f)
public float getFontSize() {
return mFontSize;
}
/**
* Returns the list of choice options in the order that it was passed in, or an empty list for
* widgets without choice options.
*/
@NonNull
public List getListItems() {
return mListItems;
}
@Override
public int hashCode() {
return Objects.hash(
mWidgetType,
mWidgetIndex,
mWidgetRect,
mReadOnly,
mTextValue,
mAccessibilityLabel,
mEditableText,
mMultiSelect,
mMultiLineText,
mMaxLength,
mFontSize,
mListItems);
}
@Override
public boolean equals(Object obj) {
if (obj instanceof FormWidgetInfo other) {
return mWidgetType == other.mWidgetType
&& mWidgetIndex == other.mWidgetIndex
&& Objects.equals(mWidgetRect, other.mWidgetRect)
&& mReadOnly == other.mReadOnly
&& Objects.equals(mTextValue, other.mTextValue)
&& Objects.equals(mAccessibilityLabel, other.mAccessibilityLabel)
&& mEditableText == other.mEditableText
&& mMultiSelect == other.mMultiSelect
&& mMultiLineText == other.mMultiLineText
&& mMaxLength == other.mMaxLength
&& mFontSize == other.mFontSize
&& mListItems.equals(other.mListItems);
}
return false;
}
@Override
public String toString() {
return "FormWidgetInfo{"
+ "\n\ttype=" + mWidgetType + "\n\tindex=" + mWidgetIndex + "\n\trect="
+ mWidgetRect + "\n\treadOnly=" + mReadOnly + "\n\ttextValue=" + mTextValue
+ "\n\taccessibilityLabel=" + mAccessibilityLabel + "\n\teditableText="
+ mEditableText + "\n\tmultiSelect=" + mMultiSelect + "\n\tmultiLineText="
+ mMultiLineText + "\n\tmaxLength=" + mMaxLength + "\n\tfontSize=" + mFontSize
+ "\n\tmChoiceOptions=" + mListItems + "\n}";
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(@NonNull Parcel dest, int flags) {
dest.writeInt(mWidgetType);
dest.writeInt(mWidgetIndex);
dest.writeParcelable(mWidgetRect, flags);
dest.writeInt(mReadOnly ? 1 : 0);
dest.writeString(mTextValue);
dest.writeString(mAccessibilityLabel);
dest.writeInt(mEditableText ? 1 : 0);
dest.writeInt(mMultiSelect ? 1 : 0);
dest.writeInt(mMultiLineText ? 1 : 0);
dest.writeInt(mMaxLength);
dest.writeFloat(mFontSize);
dest.writeTypedList(mListItems);
}
/**
* Represents the type of a form widget
*
* @hide
*/
@IntDef({
WIDGET_TYPE_UNKNOWN,
WIDGET_TYPE_PUSHBUTTON,
WIDGET_TYPE_CHECKBOX,
WIDGET_TYPE_RADIOBUTTON,
WIDGET_TYPE_COMBOBOX,
WIDGET_TYPE_LISTBOX,
WIDGET_TYPE_TEXTFIELD,
WIDGET_TYPE_SIGNATURE
})
@Retention(RetentionPolicy.SOURCE)
public @interface WidgetType {
}
/** Builder for {@link FormWidgetInfo} */
public static final class Builder {
private final @WidgetType int mWidgetType;
private final int mWidgetIndex;
private final Rect mWidgetRect;
private final String mTextValue;
private final String mAccessibilityLabel;
private boolean mReadOnly = false;
private boolean mEditableText = false; // Combobox only.
private boolean mMultiSelect = false; // Listbox only.
private boolean mMultiLineText = false; // Text Field only.
private int mMaxLength = -1; // Text Field only.
private float mFontSize = 0f; // Editable Text only.
private List mListItems = List.of(); // Combo/Listbox only.
/**
* Creates an instance
*
* @param widgetType the type of widget
* @param widgetIndex the index of the widget in the page's "Annot" array in the PDF
* @param widgetRect the {@link Rect} in page coordinates occupied by the widget
* @param textValue the widget's text value
* @param accessibilityLabel the field's accessibility label
* @throws NullPointerException if any of {@code widgetRect}, {@code textValue}, or {@code
* accessibilityLabel} are null
*/
public Builder(
@WidgetType int widgetType,
@IntRange(from = 0) int widgetIndex,
@NonNull Rect widgetRect,
@NonNull String textValue,
@NonNull String accessibilityLabel) {
mWidgetType = widgetType;
mWidgetIndex = widgetIndex;
mWidgetRect = Preconditions.checkNotNull(widgetRect, "widgetRect cannot be null");
mTextValue = Preconditions.checkNotNull(textValue, "textValue cannot be null");
mAccessibilityLabel = Preconditions.checkNotNull(accessibilityLabel,
"accessibilityLabel cannot be null");
}
/** Sets whether this widget is read-only */
@NonNull
public Builder setReadOnly(boolean readOnly) {
mReadOnly = readOnly;
return this;
}
/**
* Sets whether this widget contains editable text. Only supported for comboboxes and
* text fields
*
* @throws IllegalArgumentException if this is not a combobox or text field type widget
*/
@NonNull
public Builder setEditableText(boolean editableText) {
Preconditions.checkArgument(mWidgetType == WIDGET_TYPE_COMBOBOX
|| mWidgetType == WIDGET_TYPE_TEXTFIELD,
"Editable text is only supported on comboboxes and text fields");
mEditableText = editableText;
return this;
}
/**
* Sets whether this widget supports multiple choice selections. Only supported for
* list boxes
*
* @throws IllegalArgumentException if this is not a list box
*/
@NonNull
public Builder setMultiSelect(boolean multiSelect) {
Preconditions.checkArgument(mWidgetType == WIDGET_TYPE_LISTBOX,
"Multi-select is only supported on list boxes");
mMultiSelect = multiSelect;
return this;
}
/**
* Sets whether this widget supports multi-line text input. Only supported for text fields
*
* @throws IllegalArgumentException if this is not a text field
*/
@NonNull
public Builder setMultiLineText(boolean multiLineText) {
Preconditions.checkArgument(mWidgetType == WIDGET_TYPE_TEXTFIELD,
"Multiline text is only supported on text fields");
mMultiLineText = multiLineText;
return this;
}
/**
* Sets the maximum character length of input text supported by this widget. Only supported
* for text fields
*
* @throws IllegalArgumentException if this is not a text field, or if a negative max length
* is supplied
*/
@NonNull
public Builder setMaxLength(@IntRange(from = 0) int maxLength) {
Preconditions.checkArgument(maxLength > 0, "Invalid max length");
Preconditions.checkArgument(mWidgetType == WIDGET_TYPE_TEXTFIELD,
"Max length is only supported on text fields");
mMaxLength = maxLength;
return this;
}
/**
* Sets the font size for this widget. Only supported for text fields and comboboxes
*
* @throws IllegalArgumentException if this is not a combobox or text field, or if a
* negative font size is supplied
*/
@NonNull
public Builder setFontSize(@FloatRange(from = 0f) float fontSize) {
Preconditions.checkArgument(fontSize > 0, "Invalid font size");
Preconditions.checkArgument(mWidgetType == WIDGET_TYPE_COMBOBOX
|| mWidgetType == WIDGET_TYPE_TEXTFIELD,
"Font size is only supported on comboboxes and text fields");
mFontSize = fontSize;
return this;
}
/**
* Sets the choice options for this widget. Only supported for comboboxes and list boxes
*
* @throws IllegalArgumentException if this is not a combobox or list box
* @throws NullPointerException if {@code choiceOptions} is null
*/
@NonNull
public Builder setListItems(@NonNull List listItems) {
Preconditions.checkNotNull(listItems, "choiceOptions cannot be null");
Preconditions.checkArgument(mWidgetType == WIDGET_TYPE_COMBOBOX
|| mWidgetType == WIDGET_TYPE_LISTBOX,
"Choice options are only supported on comboboxes and list boxes");
mListItems = listItems;
return this;
}
/** Builds a {@link FormWidgetInfo} */
@NonNull
public FormWidgetInfo build() {
return new FormWidgetInfo(
mWidgetType,
mWidgetIndex,
mWidgetRect,
mReadOnly,
mTextValue,
mAccessibilityLabel,
mEditableText,
mMultiSelect,
mMultiLineText,
mMaxLength,
mFontSize,
mListItems);
}
}
}