An interface class for an interactive form, which tracks a tree of IFormFields and widgets. More...

#include <interactive.h>

Inheritance diagram for JawsMako::IForm:

Public Member Functions
virtual IFormPtr	clone () const =0
	Clone the form field, which includes a deep clone of any child IFormFields. More...

virtual CFormFieldVect	getFields () const =0
	Get the top level fields in a vector. More...

virtual CAnnotationReferenceVect	getWidgets () const =0
	Get references to the top level widgets in a vector. More...

virtual void	clearFields ()=0
	Clear the top level fields list.

virtual void	addField (const IFormFieldPtr &field)=0
	Add a field at the top level. An exception will be thrown if the field to be inserted has the same partial name or id as an existing field at the top level. More...

virtual void	removeField (const IFormFieldPtr &field)=0
	Remove a top level field. More...

virtual void	clearWidgets ()=0
	Clear the top level widgets list.

virtual void	addWidget (const IWidgetAnnotationPtr &widget)=0
	Add a top level widget. An exception will be thrown if an annotation with the same reference is already. More...

virtual void	addWidget (const IAnnotationReferencePtr &widgetReference)=0
	Add a top level widget by reference. An exception will be thrown if an annotation with the same reference is already present at this level. More...

virtual void	removeWidget (const IWidgetAnnotationPtr &widget)=0
	Remove the given top level widget. More...

virtual void	removeWidget (const IAnnotationReferencePtr &widgetReference)=0
	Remove the given top level widget, by reference. More...

virtual bool	fieldInTree (const IFormFieldPtr &field) const =0
	Search the field tree for a field that has the same id as the given field. The search recurses through the children. More...

virtual CFormFieldVect	getPathToField (const IFormFieldPtr &field) const =0
	Find the path to a field with the same id that is present in the field tree. More...

virtual bool	widgetInTree (const IWidgetAnnotationPtr &widget) const =0
	Search the field sub for a widget. The search recurses through the child fields. More...

virtual bool	widgetInTree (const IAnnotationReferencePtr &widgetReference) const =0
	Search the field sub for a widget, by reference The search recurses through the child fields. More...

virtual CFormFieldVect	getPathToWidget (const IWidgetAnnotationPtr &widget) const =0
	Find the path to a widget with the same reference as the given widget. More...

virtual CFormFieldVect	getPathToWidget (const IAnnotationReferencePtr &widgetReference) const =0
	Find the path to a widget with the given reference. More...

virtual eFieldType	getWidgetFieldType (const IWidgetAnnotationPtr &widget) const =0
	Determine the type for the given widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form. More...

virtual uint32	getWidgetFieldFlags (const IWidgetAnnotationPtr &widget) const =0
	Determine the flags for the given widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form. More...

virtual U8String	getWidgetDefaultAppearanceString (const IWidgetAnnotationPtr &widget) const =0
	Determine the default appearance string for the given widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form. More...

virtual CU8StringVect	getWidgetValue (const IWidgetAnnotationPtr &widget) const =0
	Determine the value for the widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form. More...

virtual CU8StringVect	getWidgetDefaultValue (const IWidgetAnnotationPtr &widget) const =0
	Determine the default value for the widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form. More...

virtual CU8StringVect	getFieldValue (const IFormFieldPtr &field) const =0
	Determine the value for the field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form. More...

virtual CU8StringVect	getFieldDefaultValue (const IFormFieldPtr &field) const =0
	Determine the default value for field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form. More...

virtual CFieldOptionVect	getWidgetOptions (const IWidgetAnnotationPtr &widget) const =0
	Determine the options value for the widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form. More...

virtual eQuadding	getWidgetQuadding (const IWidgetAnnotationPtr &widget) const =0
	Determine the quadding for the given widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form. More...

virtual bool	getNeedAppearances () const =0
	Get whether a viewer should construct its own appearances for the widgets in this form. More...

virtual void	setNeedAppearances (bool needAppearances)=0
	Set whether a viewer should construct its own appearances for the widgets in this field. More...

virtual CXFAPacketVect	getXfaPacketData () const =0
	Get the XFA packet data, if present, for this form. This information is not currently used by Mako, but is preserved. More...

virtual void	setXfaPacketData (const CXFAPacketVect &xfaPacketData)=0
	Set the XFA packet data for this form. More...

Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.

virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to. More...

virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to. More...

Static Public Member Functions
static JAWSMAKO_API IFormPtr	create (const IJawsMakoPtr &jawsMako)
	Create a new form. More...

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

An interface class for an interactive form, which tracks a tree of IFormFields and widgets.

Member Function Documentation

◆ addField()

virtual void JawsMako::IForm::addField ( const IFormFieldPtr & field )

pure virtual

Add a field at the top level. An exception will be thrown if the field to be inserted has the same partial name or id as an existing field at the top level.

Parameters

field Field too be added

◆ addWidget() [1/2]

virtual void JawsMako::IForm::addWidget ( const IAnnotationReferencePtr & widgetReference )

pure virtual

Add a top level widget by reference. An exception will be thrown if an annotation with the same reference is already present at this level.

Parameters

widgetReference The widget, by reference, to be added

◆ addWidget() [2/2]

virtual void JawsMako::IForm::addWidget ( const IWidgetAnnotationPtr & widget )

pure virtual

Add a top level widget. An exception will be thrown if an annotation with the same reference is already.

Parameters

widget The widget to be added

◆ clone()

virtual IFormPtr JawsMako::IForm::clone ( ) const

pure virtual

Clone the form field, which includes a deep clone of any child IFormFields.

Returns: IFormPtr The cloned form field

◆ create()

static JAWSMAKO_API IFormPtr JawsMako::IForm::create ( const IJawsMakoPtr & jawsMako )

static

Create a new form.

Parameters

jawsMako The Mako instance

Returns: IFormPtr The new form

◆ fieldInTree()

virtual bool JawsMako::IForm::fieldInTree ( const IFormFieldPtr & field ) const

pure virtual

Search the field tree for a field that has the same id as the given field. The search recurses through the children.

Parameters

field The field to be matched

Returns: bool True if field was found, otherwise false

◆ getFieldDefaultValue()

virtual CU8StringVect JawsMako::IForm::getFieldDefaultValue ( const IFormFieldPtr & field ) const

pure virtual

Determine the default value for field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form.

Parameters

field The field to inspect

Returns: CU8StringVect The value(s)

◆ getFields()

virtual CFormFieldVect JawsMako::IForm::getFields ( ) const

pure virtual

Get the top level fields in a vector.

Returns: CFormFieldVect The vector of fields

◆ getFieldValue()

virtual CU8StringVect JawsMako::IForm::getFieldValue ( const IFormFieldPtr & field ) const

pure virtual

Determine the value for the field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form.

Parameters

field The field to inspect

Returns: CU8StringVect The value(s)

◆ getNeedAppearances()

virtual bool JawsMako::IForm::getNeedAppearances ( ) const

pure virtual

Get whether a viewer should construct its own appearances for the widgets in this form.

Returns: bool True if viewer should construct its own appearances

◆ getPathToField()

virtual CFormFieldVect JawsMako::IForm::getPathToField ( const IFormFieldPtr & field ) const

pure virtual

Find the path to a field with the same id that is present in the field tree.

This returns a vector of IFormFields representing the branches of the field tree that lead to the given field. That is, the last entry in the returned vector is the immediate parent of the desired field, the second last entry is the grandparent of the desired field, and so forth leading back to the top level.

This is useful in particular for determining the fully qualified name of a field.

An empty vector is returned if the requested field is at the top level of the form and therefore has no parents.

An exception is thrown if the field is not present in the tree.

Parameters

field The field to be matched

Returns: CFormFieldVect A vector of IFormFields

◆ getPathToWidget() [1/2]

virtual CFormFieldVect JawsMako::IForm::getPathToWidget ( const IAnnotationReferencePtr & widgetReference ) const

pure virtual

Find the path to a widget with the given reference.

This returns a vector of IFormFields representing the branches of the field tree that lead to the given widget. That is, the last entry in the returned vector is the immediate parent of the desired widget, the second last entry is the grandparent of the desired widget, and so forth leading back to the top level.

This is useful in particular for determining the fully qualified name of a field.

An empty vector is returned if the requested widget is at the top level of the form and therefore has no parents.

An exception is thrown if the widget is not present in the tree.

Parameters

widgetReference The widget, by reference, to be matched

Returns: CFormFieldVect A vector of IFormFields

◆ getPathToWidget() [2/2]

virtual CFormFieldVect JawsMako::IForm::getPathToWidget ( const IWidgetAnnotationPtr & widget ) const

pure virtual

Find the path to a widget with the same reference as the given widget.

This returns a vector of IFormFields representing the branches of the field tree that lead to the given widget. That is, the last entry in the returned vector is the immediate parent of the desired widget, the second last entry is the grandparent of the desired widget, and so forth leading back to the top level.

This is useful in particular for determining the fully qualified name of a field.

An empty vector is returned if the requested widget is at the top level of the form and therefore has no parents.

An exception is thrown if the widget is not present in the tree.

Parameters

widget The widget to be matched

Returns: CFormFieldVect A vector of IFormFields

◆ getWidgetDefaultAppearanceString()

virtual U8String JawsMako::IForm::getWidgetDefaultAppearanceString ( const IWidgetAnnotationPtr & widget ) const

pure virtual

Determine the default appearance string for the given widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form.

Parameters

widget The widget to inspect

Returns: U8String The default apperance string

◆ getWidgetDefaultValue()

virtual CU8StringVect JawsMako::IForm::getWidgetDefaultValue ( const IWidgetAnnotationPtr & widget ) const

pure virtual

Determine the default value for the widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form.

Parameters

widget The widget to inspect

Returns: CU8StringVect The value(s)

◆ getWidgetFieldFlags()

virtual uint32 JawsMako::IForm::getWidgetFieldFlags ( const IWidgetAnnotationPtr & widget ) const

pure virtual

Determine the flags for the given widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form.

Parameters

widget The widget to inspect

Returns: uint32 The field flags

◆ getWidgetFieldType()

virtual eFieldType JawsMako::IForm::getWidgetFieldType ( const IWidgetAnnotationPtr & widget ) const

pure virtual

Determine the type for the given widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form.

Parameters

widget The widget to inspect

Returns: fieldType The field type

◆ getWidgetOptions()

virtual CFieldOptionVect JawsMako::IForm::getWidgetOptions ( const IWidgetAnnotationPtr & widget ) const

pure virtual

Determine the options value for the widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form.

Parameters

widget The widget to inspect

Returns: CFormFieldVect The options

◆ getWidgetQuadding()

virtual eQuadding JawsMako::IForm::getWidgetQuadding ( const IWidgetAnnotationPtr & widget ) const

pure virtual

Determine the quadding for the given widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form.

Parameters

widget The widget to inspect

Returns: eQuadding The quadding

◆ getWidgets()

virtual CAnnotationReferenceVect JawsMako::IForm::getWidgets ( ) const

pure virtual

Get references to the top level widgets in a vector.

Returns: CAnnotationReferenceVect The vector of annotation references

◆ getWidgetValue()

virtual CU8StringVect JawsMako::IForm::getWidgetValue ( const IWidgetAnnotationPtr & widget ) const

pure virtual

Determine the value for the widget field, resolving inherited values. Convenience. An exception is thrown if the widget is not present in the form.

Parameters

widget The widget to inspect

Returns: CU8StringVect The value(s)

◆ getXfaPacketData()

virtual CXFAPacketVect JawsMako::IForm::getXfaPacketData ( ) const

pure virtual

Get the XFA packet data, if present, for this form. This information is not currently used by Mako, but is preserved.

Returns: CXFAPacketVect The XFA packet data, or an empty vector if not present.

◆ removeField()

virtual void JawsMako::IForm::removeField ( const IFormFieldPtr & field )

pure virtual

Remove a top level field.

Parameters

field Field to be removed

◆ removeWidget() [1/2]

virtual void JawsMako::IForm::removeWidget ( const IAnnotationReferencePtr & widgetReference )

pure virtual

Remove the given top level widget, by reference.

Parameters

widgetReference The widget, by reference, to be removed

◆ removeWidget() [2/2]

virtual void JawsMako::IForm::removeWidget ( const IWidgetAnnotationPtr & widget )

pure virtual

Remove the given top level widget.

Parameters

widget The widget to be removed

◆ setNeedAppearances()

virtual void JawsMako::IForm::setNeedAppearances ( bool needAppearances )

pure virtual

Set whether a viewer should construct its own appearances for the widgets in this field.

Parameters

needAppearances True or false

◆ setXfaPacketData()

virtual void JawsMako::IForm::setXfaPacketData ( const CXFAPacketVect & xfaPacketData )

pure virtual

Set the XFA packet data for this form.

Parameters

xfaPacketData The packet data to use, or an empty vector to clear.

◆ widgetInTree() [1/2]

virtual bool JawsMako::IForm::widgetInTree ( const IAnnotationReferencePtr & widgetReference ) const

pure virtual

Search the field sub for a widget, by reference The search recurses through the child fields.

Parameters

widgetReference The widget, by reference, to be matched

Returns: bool True if widget was found, otherwise false

◆ widgetInTree() [2/2]

virtual bool JawsMako::IForm::widgetInTree ( const IWidgetAnnotationPtr & widget ) const

pure virtual

Search the field sub for a widget. The search recurses through the child fields.

Parameters

widget The widget to be matched

Returns: bool True if widget was found, otherwise false

The documentation for this class was generated from the following file:

interactive.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addField()

◆ addWidget() [1/2]

◆ addWidget() [2/2]

◆ clone()

◆ create()

◆ fieldInTree()

◆ getFieldDefaultValue()

◆ getFields()

◆ getFieldValue()

◆ getNeedAppearances()

◆ getPathToField()

◆ getPathToWidget() [1/2]

◆ getPathToWidget() [2/2]

◆ getWidgetDefaultAppearanceString()

◆ getWidgetDefaultValue()

◆ getWidgetFieldFlags()

◆ getWidgetFieldType()

◆ getWidgetOptions()

◆ getWidgetQuadding()

◆ getWidgets()

◆ getWidgetValue()

◆ getXfaPacketData()

◆ removeField()

◆ removeWidget() [1/2]

◆ removeWidget() [2/2]

◆ setNeedAppearances()

◆ setXfaPacketData()

◆ widgetInTree() [1/2]

◆ widgetInTree() [2/2]