|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IOutputContext
Provides access to processing results created by the renderForm
and processFormSubmission
,
such as data content, the transformation result,
and the content type. You do not work with an IOutputContext
object directly.
Instead, you work with a FormsResult
object,
that implements this interface.
FormsResult
Method Summary | |
---|---|
short |
getAction()
Indicates the processing state associated with the Forms service result. |
java.util.List |
getAttachments()
Returns a list of PDF document attachments. |
java.lang.String |
getCharSet()
Returns the character set encoding value; for example, ISO-8859-1 , UTF-8 , SHIFT_JIS . |
java.lang.String |
getClickedBtn()
An XML Architecture Scripting Object Model (SOM) expression identifying the clicked button. |
java.lang.String |
getContentType()
Returns the content type that describes the output content generated by the Forms service. |
java.lang.String |
getFormQuery()
Returns the formQuery value, a parameter belonging to the renderForm
method. |
java.lang.String |
getOption(java.lang.String opt)
Returns the value of a specified run-time option that was set by using a RenderOptionsSpec object. |
java.lang.String |
getOptions()
Returns an ampersand delimited list of options passed to the Forms service by invoking methods that belong to the RenderOptionsSpec object. |
Document |
getOutputContent()
Returns the content generated by the Forms service. |
java.lang.String |
getOutputString()
If the content type is text-based, this method returns the content that is generated by the Forms service as a string; otherwise, it returns an empty string (binary content is accessible using the getOutputContent method). |
Document |
getOutputXML()
If the content type contains XML or HTML data, the transformation result is stored as well-formed XML. |
long |
getPageCount()
Returns the total number of pages within the PDF form. |
long |
getPageNumber()
Returns the current page number in a HTML form. |
java.lang.String |
getTransformationID()
Although a client application indicates an output format preference (as specified by the formPreference
parameter in renderForm ), this value represents the actual
transformation performed. |
Document |
getValidationErrorsList()
Gets a list of validation errors as UTF8-encoded XML. |
Document |
getXMLData()
If the XMLData run-time option is enabled (set using the RenderOptionsSpec object),
this method returns UTF8-encoded XML data from the Forms service. |
void |
setOutputXML(Document sXML)
Sets the output XML retrieved by calling getOutputXML . |
Method Detail |
---|
Document getOutputContent() throws java.io.UnsupportedEncodingException
FSAction
value,
the content may be sent back to the originating client device (such as a web browser)
or may be available for further processing by the client application.
com.adobe.idp.Document
object that contains content generated by the Forms servicee.
The content format may contain XML, HTML, or PDF data.
java.io.UnsupportedEncodingException
IOutputContext.getAction()
java.lang.String getContentType()
text/xml
text/html
application/xml
application/pdf
If the content type is text/html
, the character set value is appended;
for example, text/html; charset="ISO-8859-1"
.
java.lang.String getCharSet()
ISO-8859-1
, UTF-8
, SHIFT_JIS
.
java.lang.String getClickedBtn()
Untitled[0].main[0].ButtonHello[0]
where Untitled
and main
represent the form's XML hierarchy.
The name of the button on the form is ButtonHello
.
For information about the XML Architecture, go to http://partners.adobe.com/asn/tech/pdf/xmlformspec.jsp.
java.lang.String getOutputString()
getOutputContent
method).
IOutputContext.getOutputContent()
Document getOutputXML()
IOutputContext
interface, which updates its state to reflect changes. The setOutputXML
method is used for this purpose.
com.adobe.idp.Document
object that represents the content that is generated by the Forms services.IOutputContext.setOutputXML(Document)
void setOutputXML(Document sXML)
getOutputXML
. The output can be modified by a client
application. For example, it is possible to
enhance HTML transformations by adding elements that are not supported by the Forms service.
An example is changing an input element to be a password type, which is not a support element.
sXML
- A com.adobe.idp.Document
object that contains modified XML data.IOutputContext.getOutputXML()
Document getValidationErrorsList()
<validationerrors>
<!-- page level errors -->
<pages />
<!-- field level errors -->
<fields>
<field>
<name>rootsubform[1].FFField1[1]</name>
<message>Mandatory Field</message>
</field>
</fields>
</validationerrors>
com.adobe.idp.Document
object containing UTF8 encoded XML data.short getAction()
0
(Submit) indicates that validated XML data is available.
In this situation, interaction is complete.
However, if the value is 1
(Calculate), the content contains the results that must
be returned to the client application.
These values are valid:
0
(Submit) - Validated XML data is ready to be processed.1
(Calculate) - Calculation results must be written to the client application.2
(Validate) - Calculations and validations must be written to the client application.3
(Next) - The current page has changed with results that must be written to the client application (valid only for HTML transformations).4
(Previous) - The current page has changed with results that must be written to the client application (valid only for HTML transformations).
java.lang.String getTransformationID()
formPreference
parameter in renderForm
), this value represents the actual
transformation performed. In most cases, these
values match but not always.
If the formPreference
parameter is assigned the value AUTO
,
the transformation is dynamically determined.
java.lang.String getOptions()
RenderOptionsSpec
object. This object is
passed to the
FormsServiceClient
object's renderForm
method or
processFormSubmission
method. For information,
see Rendering Forms.
renderForm()
,
processFormSubmission()
,
RenderOptionsSpec
java.lang.String getOption(java.lang.String opt)
RenderOptionsSpec
object.
opt
- The name of the option for which a value is retrieved.
Document getXMLData()
XMLData
run-time option is enabled (set using the RenderOptionsSpec
object),
this method returns UTF8-encoded XML data from the Forms service. The data is based on
the current processing state of the Forms service and may be the result after calculations are performed
(FSAction
= Calculate
) but may not necessarily be the same result as the data returned after a submit
(FSAction
= Submit
).
com.adobe.idp.Document
object containing the form’s XML data.java.lang.String getFormQuery()
formQuery
value, a parameter belonging to the renderForm
method. For example,
assume cashsale.xdp is rendered to the client device (the value of the formQuery
parameter in renderForm
is cashsale.xdp
).
In this situation, this method returns cashsale.xdp
.
long getPageNumber()
long getPageCount()
java.util.List getAttachments()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |