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!

Field Summary

static WDInteractiveFormMode	DEFAULT_MODE Default value of property mode.
static java.lang.Object	DEFAULT_PDF_SOURCE Default value of property pdfSource.
static java.lang.String	DEFAULT_TEMPLATE_SOURCE Default value of property templateSource.

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

DEFAULT_HEIGHT, DEFAULT_WIDTH

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindDataSource(IWDNodeInfo nodeInfo) Note: This property must be bound to the context! Binds property dataSource to the context node specified by the given node info.
void	bindDataSource(java.lang.String path) Note: This property must be bound to the context! Binds property dataSource to the context attribute specified by path.
java.lang.String	bindingOfDataSource() Note: This property must be bound to the context! Binding path of property dataSource.
java.lang.String	bindingOfMode() Binding path of property mode.
java.lang.String	bindingOfPdfSource() Binding path of property pdfSource.
void	bindMode(IWDAttributeInfo attributeInfo) Binds property mode to the context attribute specified by the given attribute info.
void	bindMode(java.lang.String path) Binds property mode to the context attribute specified by path.
void	bindPdfSource(IWDAttributeInfo attributeInfo) Binds property pdfSource to the context attribute specified by the given attribute info.
void	bindPdfSource(java.lang.String path) Binds property pdfSource to the context attribute specified by path.
WDInteractiveFormMode	getMode() Returns the value of the mode property.
IWDAction	getOnCheck() Returns the action to which the event onCheck is mapped.
IWDAction	getOnSubmit() Returns the action to which the event onSubmit is mapped.
java.lang.Object	getPdfSource() Returns the value of the pdfSource property.
java.lang.String	getTemplateSource() Returns the value of the templateSource property.
IWDParameterMapping	mappingOfOnCheck() Returns the parameter mapping of event onCheck.
IWDParameterMapping	mappingOfOnSubmit() Returns the parameter mapping of event onSubmit.
void	setMode(WDInteractiveFormMode value) Sets property mode to the new value.
void	setOnCheck(IWDAction action) Maps the event onCheck to the given action.
void	setOnSubmit(IWDAction action) Maps the event onSubmit to the given action.
void	setPdfSource(java.lang.Object value) Sets property pdfSource to the new value.
void	suppressPrint(boolean suppress) Method suppressPrint can be called to avoid the PrintButton within Acrobat Reader.

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

bindHeight, bindHeight, bindingOfHeight, bindingOfWidth, bindWidth, bindWidth, getHeight, getWidth, 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

getId, getView, requestFocus

Field Detail

DEFAULT_MODE

public static final WDInteractiveFormMode DEFAULT_MODE

Default value of property mode.

DEFAULT_PDF_SOURCE

public static final java.lang.Object DEFAULT_PDF_SOURCE

Default value of property pdfSource.

DEFAULT_TEMPLATE_SOURCE

public static final java.lang.String DEFAULT_TEMPLATE_SOURCE

Default value of property templateSource.

Method Detail

getOnCheck

public IWDAction getOnCheck()

Returns the action to which the event onCheck is mapped.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnCheck()

setOnCheck

public void setOnCheck(IWDAction action)

Maps the event onCheck to the given action.

Parameters:

action - the action for the event

See Also:

getOnCheck()

mappingOfOnCheck

public IWDParameterMapping mappingOfOnCheck()

Returns the parameter mapping of event onCheck.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• none

Returns:

parameter mapping list.

See Also:

getOnCheck()

getOnSubmit

public IWDAction getOnSubmit()

Returns the action to which the event onSubmit is mapped.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnSubmit()

setOnSubmit

public void setOnSubmit(IWDAction action)

Maps the event onSubmit to the given action.

Parameters:

action - the action for the event

See Also:

getOnSubmit()

mappingOfOnSubmit

public IWDParameterMapping mappingOfOnSubmit()

Returns the parameter mapping of event onSubmit.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• none

Returns:

parameter mapping list.

See Also:

getOnSubmit()

bindDataSource

public void bindDataSource(java.lang.String path)

Note: This property must be bound to the context! Binds property dataSource to the context attribute specified by path.

Parameters:

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

bindDataSource

public void bindDataSource(IWDNodeInfo nodeInfo)

Note: This property must be bound to the context! Binds property dataSource to the context node specified by the given node info.

Parameters:

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

bindingOfDataSource

public java.lang.String bindingOfDataSource()

Note: This property must be bound to the context! Binding path of property dataSource.

Returns:

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

bindMode

public void bindMode(java.lang.String path)

Binds property mode to the context attribute specified by path.

Parameters:

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

bindMode

public void bindMode(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfMode

public java.lang.String bindingOfMode()

Binding path of property mode.

Returns:

the path of the context attribute to which the mode 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 property mode to the new value.

Parameters:

value - the new value of the mode property

See Also:

getMode()

bindPdfSource

public void bindPdfSource(java.lang.String path)

Binds property pdfSource to the context attribute specified by path.

Parameters:

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

bindPdfSource

public void bindPdfSource(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfPdfSource

public java.lang.String bindingOfPdfSource()

Binding path of property pdfSource.

Returns:

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

getPdfSource

public java.lang.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(java.lang.Object value)

Sets property pdfSource to the new value.

Parameters:

value - the new value of the pdfSource property

See Also:

getPdfSource()

getTemplateSource

public java.lang.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)

suppressPrint

public void suppressPrint(boolean suppress)

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 -