Web Dynpro API Documentation

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

java.lang.Object
  |
  +--com.sap.tc.webdynpro.clientserver.uielib.adobe.api.WDInteractiveFormMode

public final class WDInteractiveFormMode
extends java.lang.Object

Enumeration type WDInteractiveFormMode. Certain modes how an interactive form uses its data source, template, and PDF document.

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


Field Summary
static WDInteractiveFormMode GENERATE_PDF
          Use this mode to generate a new PDF document from the data source and template.
static WDInteractiveFormMode UPDATE_DATA_IN_PDF
          Use this mode to update the PDF document's data with those found via the data source.
static WDInteractiveFormMode USE_PDF
          Use this mode to ignore data source and template in favor of the PDF document.
 
Method Summary
static java.util.Iterator iterateValues()
          Returns an iterator over the values of the WDInteractiveFormMode type.
 int ordinal()
          Returns the ordinal of this enumeration value (its position in its enum declaration, where the first value is assigned an ordinal of zero).
 java.lang.String toString()
          Returns the string representation of this enumeration value.
static WDInteractiveFormMode valueOf(int ordinal)
          Returns the enumeration value for the given ordinal.
static WDInteractiveFormMode valueOf(java.lang.String name)
          Returns the enumeration value for the given name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

GENERATE_PDF

public static final WDInteractiveFormMode GENERATE_PDF
Use this mode to generate a new PDF document from the data source and template.

UPDATE_DATA_IN_PDF

public static final WDInteractiveFormMode UPDATE_DATA_IN_PDF
Use this mode to update the PDF document's data with those found via the data source. Generates a new PDF document from data source and template in case no document exists.

USE_PDF

public static final WDInteractiveFormMode USE_PDF
Use this mode to ignore data source and template in favor of the PDF document.
Method Detail

ordinal

public int ordinal()
Returns the ordinal of this enumeration value (its position in its enum declaration, where the first value is assigned an ordinal of zero). Most programmers will have no use for this method. It is designed for use by sophisticated enum-based data structures.
Returns:
the ordinal of this enumeration value

toString

public java.lang.String toString()
Returns the string representation of this enumeration value.
Overrides:
toString in class java.lang.Object
Returns:
the string value of this enumeration value

valueOf

public static WDInteractiveFormMode valueOf(int ordinal)
Returns the enumeration value for the given ordinal.
Parameters:
ordinal - an ordinal
Returns:
the enumeration value for the given ordinal

valueOf

public static WDInteractiveFormMode valueOf(java.lang.String name)
Returns the enumeration value for the given name. Ignores case.
Parameters:
name - a name
Returns:
the enumeration value for the given name

iterateValues

public static java.util.Iterator iterateValues()
Returns an iterator over the values of the WDInteractiveFormMode type.
Returns:
a read-only iterator over the values of this enumeration type

Web Dynpro API Documentation

Copyright © 2004 SAP AG. Automatically generated Thu Mar 3 2005, 22:15