com.sap.tc.webdynpro.clientserver.uielib.adobe.api

Interface IWDInteractiveForm

All Superinterfaces:

IWDAbstractActiveComponent, IWDUIElement, IWDViewElement

public interface IWDInteractiveForm

extends IWDAbstractActiveComponent

Web Dynpro InteractiveForm API.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Field Summary

static WDInteractiveFormDisplayType	DEFAULT_DISPLAY_TYPE Default value of the displayType property is WDInteractiveFormDisplayType.ACTIVE_X.
static WDInteractiveFormMode	DEFAULT_MODE Default value of the mode property is WDInteractiveFormMode.UPDATE_DATA_IN_PDF.
static Object	DEFAULT_PDF_SOURCE Default value of the pdfSource property is null.
static boolean	DEFAULT_READ_ONLY Default value of the readOnly property is false.
static String	DEFAULT_TEMPLATE_SOURCE Default value of the templateSource property is "".

Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.activecomp.api.IWDAbstractActiveComponent

DEFAULT_ADDITIONAL_ARCHIVES, DEFAULT_HEIGHT, DEFAULT_WIDTH, INVOKE_OK

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindDataSource(IWDNodeInfo nodeInfo) Binds the dataSource property to the context node specified by the given node info.
void	bindDataSource(String path) Binds the dataSource property to the context attribute specified by the given path.
void	bindDisplayType(IWDAttributeInfo attributeInfo) Binds the displayType property to the context attribute specified by the given attribute info.
void	bindDisplayType(String path) Binds the displayType property to the context attribute specified by the given path.
String	bindingOfDataSource() Returns the binding path of the dataSource property.
String	bindingOfDisplayType() Returns the binding path of the displayType property.
String	bindingOfMode() Returns the binding path of the mode property.
String	bindingOfPdfSource() Returns the binding path of the pdfSource property.
String	bindingOfReadOnly() Returns the binding path of the readOnly property.
void	bindMode(IWDAttributeInfo attributeInfo) Binds the mode property to the context attribute specified by the given attribute info.
void	bindMode(String path) Binds the mode property to the context attribute specified by the given path.
void	bindPdfSource(IWDAttributeInfo attributeInfo) Binds the pdfSource property to the context attribute specified by the given attribute info.
void	bindPdfSource(String path) Binds the pdfSource property to the context attribute specified by the given path.
void	bindReadOnly(IWDAttributeInfo attributeInfo) Binds the readOnly property to the context attribute specified by the given attribute info.
void	bindReadOnly(String path) Binds the readOnly property to the context attribute specified by the given path.
void	changesNotAllowed(boolean changesNotAllowed) Deprecated. Instead, make use of the protect method in IWDPDFDocumentInteractiveFormContext or IWDPDFDocumentCreationContext interface. Set the document permission to CHANGES_NOT_ALLOWED.
WDInteractiveFormDisplayType	getDisplayType() Returns the value of the displayType property.
WDInteractiveFormMode	getMode() Returns the value of the mode property.
IWDAction	getOnCheck() Returns the action assigned to event onCheck
IWDAction	getOnSubmit() Returns the action assigned to event onSubmit
Object	getPdfSource() Returns the value of the pdfSource property.
boolean	getReadOnly() Returns the value of the readOnly property.
String	getTemplateSource() Returns the value of the templateSource property.
IWDParameterMapping	mappingOfOnCheck() Returns the parameter mapping for event onCheck.
IWDParameterMapping	mappingOfOnSubmit() Returns the parameter mapping for event onSubmit.
void	setDisplayType(WDInteractiveFormDisplayType value) Sets the displayType property to the given value.
void	setDynamicPDF(boolean isDynamicPDF) Deprecated. Instead, make use of the setDynamic method in IWDPDFDocumentInteractiveFormContext or IWDPDFDocumentCreationContext interface based on your application needs. Set it to true to make the document dynamic.
void	setMode(WDInteractiveFormMode value) Sets the mode property to the given value.
void	setOnCheck(IWDAction action) Assigns the given action to event onCheck.
void	setOnSubmit(IWDAction action) Assigns the given action to event onSubmit.
void	setPdfSource(Object value) Sets the pdfSource property to the given value.
void	setReadOnly(boolean value) Sets the readOnly property to the given value.
void	setTemplateSource(String templateSource) Sets the templateSource property to the given value.
void	suppressPrint(boolean suppress) Deprecated. Instead, make use of the setProtection method in IWDPDFDocumentInteractiveFormContext or IWDPDFDocumentCreationContext interface. Set the document permission to PRINT_NOT_ALLOWED.

Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.activecomp.api.IWDAbstractActiveComponent

bindHeight, bindHeight, bindingOfHeight, bindingOfWidth, bindWidth, bindWidth, getAdditionalArchives, getHeight, getMethodHandler, getTestMethodHandler, getWidth, setAdditionalArchives, setHeight, setWidth

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_DISPLAY_TYPE

public static final WDInteractiveFormDisplayType DEFAULT_DISPLAY_TYPE

Default value of the displayType property is WDInteractiveFormDisplayType.ACTIVE_X.

DEFAULT_MODE

public static final WDInteractiveFormMode DEFAULT_MODE

Default value of the mode property is WDInteractiveFormMode.UPDATE_DATA_IN_PDF.

DEFAULT_PDF_SOURCE

public static final Object DEFAULT_PDF_SOURCE

Default value of the pdfSource property is null.

DEFAULT_READ_ONLY

public static final boolean DEFAULT_READ_ONLY

Default value of the readOnly property is false.

See Also:

Constant Field Values

DEFAULT_TEMPLATE_SOURCE

public static final String DEFAULT_TEMPLATE_SOURCE

Default value of the templateSource property is "".

See Also:

Constant Field Values

Method Detail

getOnCheck

public IWDAction getOnCheck()

Returns the action assigned to event onCheck.

Returns:

the action assigned to event onCheck

See Also:

mappingOfOnCheck()

setOnCheck

public void setOnCheck(IWDAction action)

Assigns the given action to event onCheck.

Parameters:

action - the action assigned to the event

See Also:

getOnCheck()

mappingOfOnCheck

public IWDParameterMapping mappingOfOnCheck()

Returns the parameter mapping for event onCheck.

This event has no parameters.

Returns:

the parameter mapping for event onCheck

See Also:

getOnCheck()

getOnSubmit

public IWDAction getOnSubmit()

Returns the action assigned to event onSubmit.

Returns:

the action assigned to event onSubmit

See Also:

mappingOfOnSubmit()

setOnSubmit

public void setOnSubmit(IWDAction action)

Assigns the given action to event onSubmit.

Parameters:

action - the action assigned to the event

See Also:

getOnSubmit()

mappingOfOnSubmit

public IWDParameterMapping mappingOfOnSubmit()

Returns the parameter mapping for event onSubmit.

This event has no parameters.

Returns:

the parameter mapping for event onSubmit

See Also:

getOnSubmit()

bindDataSource

public void bindDataSource(String path)

Binds the dataSource property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the dataSource property will be bound

bindDataSource

public void bindDataSource(IWDNodeInfo nodeInfo)

Binds the dataSource property to the context node specified by the given node info.

Parameters:

nodeInfo - the info of the context node to which the dataSource property will be bound

bindingOfDataSource

public String bindingOfDataSource()

Returns the binding path of the dataSource property.

Returns:

the path of the context attribute to which the dataSource property is currently bound

bindDisplayType

public void bindDisplayType(String path)

Binds the displayType property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the displayType property will be bound

bindDisplayType

public void bindDisplayType(IWDAttributeInfo attributeInfo)

Binds the displayType property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the displayType property will be bound

bindingOfDisplayType

public String bindingOfDisplayType()

Returns the binding path of the displayType property.

Returns:

the path of the context attribute to which the displayType property is currently bound

getDisplayType

public WDInteractiveFormDisplayType getDisplayType()

Returns the value of the displayType property.

The initial value is WDInteractiveFormDisplayType.ACTIVE_X.

Specifies the display type of the InteractiveForm. Use type native for the newly created forms

Returns:

the current value of the displayType property

See Also:

setDisplayType(WDInteractiveFormDisplayType)

setDisplayType

public void setDisplayType(WDInteractiveFormDisplayType value)

Sets the displayType property to the given value.

Parameters:

value - the new value of the displayType property

See Also:

getDisplayType()

bindMode

public void bindMode(String path)

Binds the mode property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the mode property will be bound

bindMode

public void bindMode(IWDAttributeInfo attributeInfo)

Binds the mode property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the mode property will be bound

bindingOfMode

public String bindingOfMode()

Returns the binding path of the mode property.

Returns:

the path of the context attribute to which the mode property is currently bound

getMode

public WDInteractiveFormMode getMode()

Returns the value of the mode property.

The initial value is WDInteractiveFormMode.UPDATE_DATA_IN_PDF.

Note that the default is to generate a new PDF in case none exists.

Returns:

the current value of the mode property

See Also:

setMode(WDInteractiveFormMode)

setMode

public void setMode(WDInteractiveFormMode value)

Sets the mode property to the given value.

Parameters:

value - the new value of the mode property

See Also:

getMode()

bindPdfSource

public void bindPdfSource(String path)

Binds the pdfSource property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the pdfSource property will be bound

bindPdfSource

public void bindPdfSource(IWDAttributeInfo attributeInfo)

Binds the pdfSource property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the pdfSource property will be bound

bindingOfPdfSource

public String bindingOfPdfSource()

Returns the binding path of the pdfSource property.

Returns:

the path of the context attribute to which the pdfSource property is currently bound

getPdfSource

public Object getPdfSource()

Returns the value of the pdfSource property.

The initial value is null.

This property must usually be bound against a context attribute of type "binary" that contains the initial PDF document. That attribute is later updated when the PDF document is changed e.g. by user input. You can leave this property unbound in case you are not interested in updates to the PDF document, but only in data updates via the dataSource property.

Returns:

the current value of the pdfSource property

See Also:

setPdfSource(Object)

setPdfSource

public void setPdfSource(Object value)

Sets the pdfSource property to the given value.

Parameters:

value - the new value of the pdfSource property

See Also:

getPdfSource()

bindReadOnly

public void bindReadOnly(String path)

Binds the readOnly property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the readOnly property will be bound

bindReadOnly

public void bindReadOnly(IWDAttributeInfo attributeInfo)

Binds the readOnly property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the readOnly property will be bound

bindingOfReadOnly

public String bindingOfReadOnly()

Returns the binding path of the readOnly property.

Returns:

the path of the context attribute to which the readOnly property is currently bound

getReadOnly

public boolean getReadOnly()

Returns the value of the readOnly property.

The initial value is false.

Determines if the interactive form is editable or not.

Returns:

the current value of the readOnly property

See Also:

setReadOnly(boolean)

setReadOnly

public void setReadOnly(boolean value)

Sets the readOnly property to the given value.

Parameters:

value - the new value of the readOnly property

See Also:

getReadOnly()

getTemplateSource

public String getTemplateSource()

Returns the value of the templateSource property. The initial value is "". This property must be set only once, when the interactive form is created. It contains the URL of the template.

Returns:

the value of the templateSource property

See Also:

setTemplateSource(String)

setTemplateSource

public void setTemplateSource(String templateSource)

Sets the templateSource property to the given value.

Parameters:

templateSource - the new value of the templateSource property

See Also:

getTemplateSource()

suppressPrint

public void suppressPrint(boolean suppress)

Deprecated. Instead, make use of the setProtection method in IWDPDFDocumentInteractiveFormContext or IWDPDFDocumentCreationContext interface. Set the document permission to PRINT_NOT_ALLOWED.

Method suppressPrint can be called to avoid the PrintButton within Acrobat Reader. The method could be called in wdDoModifyView of the View. To change the state again, the method must be called again.

Parameters:

suppress -

setDynamicPDF

public void setDynamicPDF(boolean isDynamicPDF)

Deprecated. Instead, make use of the setDynamic method in IWDPDFDocumentInteractiveFormContext or IWDPDFDocumentCreationContext interface based on your application needs. Set it to true to make the document dynamic.

Method setDynamicPDF can be called to turn on/off dynamic generation of PDF. Default is false.

Parameters:

isDynamicPDF - true: dynamic PDF false: static PDF

changesNotAllowed

public void changesNotAllowed(boolean changesNotAllowed)

Deprecated. Instead, make use of the protect method in IWDPDFDocumentInteractiveFormContext or IWDPDFDocumentCreationContext interface. Set the document permission to CHANGES_NOT_ALLOWED.

Method changesNotAllowed should be used to set the "changesNotAllowed" flag to true or false. When set to true, the document can not be changed. Requires a secure communication path to be established.

Parameters:

changesNotAllowed -