Package net.webpdf.wsclient.openapi

Class MetadataFormDocument

java.lang.Object

net.webpdf.wsclient.openapi.MetadataFormDocument

public class MetadataFormDocument
extends Object

Describes the properties of the document's form. (Should the document contain a form.)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataFormDocument.FormTypeEnum	When set to another value than \"none\", the document does contain a PDF form in the hereby given format

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_DEFAULT_APPEARANCE
static String	JSON_PROPERTY_FIELD
static String	JSON_PROPERTY_FORM_TYPE
static String	JSON_PROPERTY_NEED_APPEARANCES
static String	JSON_PROPERTY_OBJECT_KEY

Constructor Summary

Constructors

Constructor	Description
MetadataFormDocument()

Method Summary

Modifier and Type	Method	Description
MetadataFormDocument	addFieldItem(MetadataField fieldItem)
MetadataFormDocument	defaultAppearance(String defaultAppearance)
boolean	equals(Object o)
MetadataFormDocument	field(List<MetadataField> field)
MetadataFormDocument	formType(MetadataFormDocument.FormTypeEnum formType)
@Nullable String	getDefaultAppearance()	If present, this contains the default appearance of the form's fields.
@Nullable List<MetadataField>	getField()	Get field
@Nullable MetadataFormDocument.FormTypeEnum	getFormType()	When set to another value than \"none\", the document does contain a PDF form in the hereby given format
@Nullable Boolean	getNeedAppearances()	When set to \"true\" the displaying Application shall generate appearances for all widgets defining the document's form.
@Nullable String	getObjectKey()	The object ID of the form.
int	hashCode()
MetadataFormDocument	needAppearances(Boolean needAppearances)
MetadataFormDocument	objectKey(String objectKey)
void	setDefaultAppearance(String defaultAppearance)
void	setField(List<MetadataField> field)
void	setFormType(MetadataFormDocument.FormTypeEnum formType)
void	setNeedAppearances(Boolean needAppearances)
void	setObjectKey(String objectKey)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_DEFAULT_APPEARANCE

public static final String JSON_PROPERTY_DEFAULT_APPEARANCE

See Also:

Constant Field Values

JSON_PROPERTY_FIELD

public static final String JSON_PROPERTY_FIELD

See Also:

Constant Field Values

JSON_PROPERTY_FORM_TYPE

public static final String JSON_PROPERTY_FORM_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_NEED_APPEARANCES

public static final String JSON_PROPERTY_NEED_APPEARANCES

See Also:

Constant Field Values

JSON_PROPERTY_OBJECT_KEY

public static final String JSON_PROPERTY_OBJECT_KEY

See Also:

Constant Field Values

Constructor Detail

MetadataFormDocument

public MetadataFormDocument()

Method Detail

defaultAppearance

public MetadataFormDocument defaultAppearance(String defaultAppearance)

getDefaultAppearance

@Nullable
public @Nullable String getDefaultAppearance()

If present, this contains the default appearance of the form's fields. This shall be a string containing graphics and text state operators for example defining text colors, sizes etc.

Returns:

defaultAppearance

setDefaultAppearance

public void setDefaultAppearance(String defaultAppearance)

field

public MetadataFormDocument field(List<MetadataField> field)

addFieldItem

public MetadataFormDocument addFieldItem(MetadataField fieldItem)

getField

@Nullable
public @Nullable List<MetadataField> getField()

Get field

Returns:

field

setField

public void setField(List<MetadataField> field)

formType

public MetadataFormDocument formType(MetadataFormDocument.FormTypeEnum formType)

getFormType

@Nullable
public @Nullable MetadataFormDocument.FormTypeEnum getFormType()

When set to another value than \"none\", the document does contain a PDF form in the hereby given format. * none = The document does not contain a form. * acroForm = The document contains a standard PDF Acroform. * staticXFA = The document contains a \"XML Forms Architecture\" form with a fixed layout (static). * dynamicXFA = The document contains a \"XML Forms Architecture\" form with an adaptable/interactive layout (dynamic).

Returns:

formType

setFormType

public void setFormType(MetadataFormDocument.FormTypeEnum formType)

needAppearances

public MetadataFormDocument needAppearances(Boolean needAppearances)

getNeedAppearances

@Nullable
public @Nullable Boolean getNeedAppearances()

When set to \"true\" the displaying Application shall generate appearances for all widgets defining the document's form.

Returns:

needAppearances

setNeedAppearances

public void setNeedAppearances(Boolean needAppearances)

objectKey

public MetadataFormDocument objectKey(String objectKey)

getObjectKey

@Nullable
public @Nullable String getObjectKey()

The object ID of the form. **Info:** A PDF object ID consists of two numbers, where the first number selects the object's number and the second the \"generation\" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.

Returns:

objectKey

setObjectKey

public void setObjectKey(String objectKey)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object