wt.templateutil.processor
Class GenerateFormProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

Direct Known Subclasses:

ActionPageFormProcessor, ActionStatusTemplateProcessor, AddAttachmentProcessor, AddEffFormProcessor, AdHocActivitiesProcessor, AssociateFormProcessor, AutoAssociateFormProcessor, CancelCheckoutTemplateProcessor, ChangeAssociationLocalSearchProcessor, ChangeManagementFormProcessor, ChangeSignatureFormProcessor, CheckinFormProcessor, CheckinFormProcessor, CheckoutDownloadTemplateProcessor, CompareModelProcessor, ConsolePrefFormProcessor, CreateWSTemplateProcessor, CSMFuncEqFormProcessor, CSMQueryFormProcessor, CSMResultsFormProcessor, CustomFilterProcessor, DateProcessor, DefinePartReplacementsProcessor, DisassociateFormProcessor, EDACompare, EDACompareTemplateProcessor, EditAttachmentsFormProcessor, EditAttributesFormProcessor, EffHistoryProcessor, FamTabPrefProcessor, FindUsersFormProcessor, ForumNotificationProcessor, GatherObjectsProcessor, LayoutProcessor, LogTemplateProcessor, MultilevelBomCompareQueryProcessor, MultiReviseFormProcessor, MyWorkspaceFormProcessor, NavigateFormProcessor, NewCadDocTemplateProcessor, NewPartFormProcessor, OpenInProeFormProcessor, OpenInProeFormProcessor, PageProcessor, PartLocalSearchProcessor, PickerFindUsersFormProcessor, PickerFormProcessor, PreferencesProcessor, PreferencesProcessor, RedirectPageProcessor, RemoveFormProcessor, RenameFormProcessor, ReplaceMissDepFormProcessor, ReportTemplateExecuteFormGenerator, ReviseAllFormProcessor, ReviseFormProcessor, RulesCollectionSectionProcessor, RulesConfigurationSectionProcessor, RulesDependencyProcessor, RulesJavaScriptProcessor, RulesSectionProcessor, SaveAsFormProcessor, SetConfigurationProcessor, SubscriptionFormProcessor, TablePreferenceProcessor, UploadFormProcessor, WfReassignProcessor, WfUpdDueDateProcessor, WizardFormProcessor, WizardProcessor, WorkflowProcessor, WorkspaceFormProcessor, WsConfigSpecPrefTemplateProcessor, WsprefTemplateProcessor

public class GenerateFormProcessor

extends DefaultTemplateProcessor

Deprecation Notice: This class is still valid for this release, however this serves as advance notice that it will be removed in the future. All user interfaces built using the Windchill HTML Template Processing client architecture will be rewritten using a different framework in an upcoming release.

Supported API: true

Extendable: true

See Also:

Serialized Form

Field Summary

private static String	ATTRIBUTE Deprecated.
private static String	CHECKSUM Deprecated.
private static String	CLASSNAME Deprecated.
private FormatContentHolder	contentHolder Deprecated.
static String	DEFAULT_LIFECYCLE Deprecated.
private static String	DEFAULTPATH Deprecated.
private static String	DELIM Deprecated.
private static String	DOWNLOADURL Deprecated.
static long	EXTERNALIZATION_VERSION_UID Deprecated.
private static String	FILENAME Deprecated.
private static String	FORMAT Deprecated.
private static String	LASTUPDATED Deprecated.
private static String	OIDSTRING Deprecated.
protected static long	OLD_FORMAT_VERSION_UID Deprecated.
static String	ON_CHANGE_EVENT_NAME Deprecated.
private static String	PRIMARY Deprecated.
private static String	RESOURCE Deprecated.
(package private) static long	serialVersionUID Deprecated.
private static String	SIZE Deprecated.
private static String	TARGETTYPE Deprecated.
static String	TEAMTEMPLATE_INPUT_NAME Deprecated.
private static String	UPLOADEDFROMPATH Deprecated.
private static String	UPLOADURL Deprecated.

Fields inherited from class wt.templateutil.processor.DefaultTemplateProcessor

ACTION, CLASS, CODEBASE, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR, OID, VERBOSE

Fields inherited from class wt.enterprise.BasicTemplateProcessor

ADD_HELP_ICON, ALL_CABINETS, BLANK_SPACE, BREAK_SEPARATOR, BREAK_TAG, componentFactory, CONTAINER_NAME, CONTENT_RESOURCE, contextClass, DEFAULT_CHARSET, DEFAULT_HELP_ICON_SELECTOR, DEFAULT_HELP_LABEL, DEFAULT_PREFERENCE_CONTEXT, DOCFROMTEMPLATE, ENABLE_HELP_ICON_PROPERTY_NAME, ENTERPRISE_SEARCH, FEDERATION_SEARCH, GLOBAL_NAVIGATION_ENABLE_HELP_ICON, globalNavBarHelpIconEnabledDefault, HELP_CONTEXT, HELP_ICON_POSITION, HELP_ICON_SELECTOR, HELP_LABEL, HELP_LABEL_RESOURCE, HELP_WINDOW_NAME, helpContext, helpIconEnabled, helpIconEnabledDefault, HOMEPAGE, IDPREFIX, IMPORT, INTEGRATED_SEARCH, isDndMicroAppletEnabled, isDndMicroAppletEnabledInitialized, LABEL_SEPARATOR, linkPrefix, LOCAL_SEARCH, pageContext, PDMLINK_INSTALL_KEY, PERSONAL_CABINET, PREF_WINDOW_NAME, PREFERENCE_CONTEXT, PRESENT_HELP_LABEL, PROJECTLINK_INSTALL_KEY, SEARCH, SHARE_ICON, TEXT_RESOURCE_BUNDLE, URL_RESOURCE, WORKLIST, wtAttribute, WTCORE_IMAGE_DIR

Fields inherited from interface wt.templateutil.processor.ContextTranslator

CONTEXT_LIST_IN, CONTEXT_LIST_OUT

Fields inherited from interface wt.templateutil.processor.ContextHolder

CONTEXT_ACTION, CONTEXT_CLASS_NAME, CONTEXT_OBJ, CONTEXT_PROPERTIES, FORM_DATA, QUERY_DATA, RESPONSE_EXCEPTIONS, RESPONSE_FOOTERS, RESPONSE_HEADERS, RESPONSE_MESSAGES, RESPONSE_STRING, STATUS

Constructor Summary

GenerateFormProcessor()
Deprecated.

Method Summary

void	addHiddenProperties(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	changedContextualValue(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	contextualValue(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	contextualValueEncoded(Properties parameters, Locale locale, OutputStream os) Deprecated.
private String	createHTMLTagParam(String nameAttribute, Properties parameters) Deprecated. From the specified parameters list, look for additional tag parameters.
void	currentFolderId(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	currentFolderPath(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	enumeratedTypeMenu(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	enumeratedTypeMenuForClass(Properties parameters, Locale locale, OutputStream os) Deprecated. This Windchill script call displays a dropdown menu for an object attribute of type EnumeratedType.
void	generateAction(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	generatePostURL(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	generateUpdatePostURL(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	getButtonText(Properties parameters, Locale locale, OutputStream os) Deprecated.
FormatContentHolder	getContentHolder() Deprecated.
String	getContextualValue(String propertyName, Properties scriptProps, Locale locale) Deprecated.
void	getDefaultPath(Properties params, Locale locale, OutputStream os) Deprecated. Retrieves a default path for use by the file locator.
void	getDelim(Properties params, Locale locale, OutputStream os) Deprecated.
void	getDnDAppletTags(Properties parameters, Locale locale, OutputStream os) Deprecated.
protected void	getEnumeratedTypeMenu(Properties parameters, Locale locale, OutputStream os, String contextEnumValue) Deprecated.
private String	getFileSize(ApplicationData file) Deprecated. Returns a String containing the size of the given file in Kilobytes.
protected void	getFormat(Properties params, Locale locale, OutputStream os) Deprecated.
void	getFormValueFromSession(Properties parameters, Locale locale, OutputStream os) Deprecated. This Windchill script call retrieves an input value for a wizard form from session context.
String	getFormValueFromSession(String formName, String inputFieldName, String defaultValue) Deprecated. This method retrieves an input value for a wizard form from session context.
void	getFormValueFromSessionWithEnumeratedPropertyDefault(Properties parameters, Locale locale, OutputStream os) Deprecated. This Windchill script call displays a dropdown menu for an attribute of type EnumeratedType belonging to the current context object or context class.
void	getFormValueFromSessionWithPropertyDefault(Properties parameters, Locale locale, OutputStream os) Deprecated. This Windchill script call retrieves an input value for a wizard form from session context.
protected void	getLastUpdated(Properties params, Locale locale, OutputStream os) Deprecated.
void	getMessageURL(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	getObjectIdentity(Properties parameters, Locale locale, OutputStream os) Deprecated.
private String	getObjectIdentity(String resourceKey, String resourceClass, Locale locale) Deprecated.
void	getPreferenceValue(Properties params, Locale locale, OutputStream os) Deprecated.
protected void	getPrimary(Properties params, Locale locale, OutputStream os) Deprecated.
protected String	getPrimary(String purpose) Deprecated.
void	getPrimaryAttribute(Properties params, Locale locale, OutputStream os) Deprecated.
String	getPrimaryChecksum() Deprecated.
protected void	getPrimaryChecksum(Properties params, Locale locale, OutputStream os) Deprecated.
String	getPrimaryDownloadURL() Deprecated.
void	getPrimaryDownloadURL(Properties parameters, Locale locale, OutputStream os) Deprecated.
String	getPrimaryFileName() Deprecated.
protected void	getPrimaryFileName(Properties params, Locale locale, OutputStream os) Deprecated.
String	getPrimaryOidString() Deprecated.
protected void	getPrimaryOidString(Properties params, Locale locale, OutputStream os) Deprecated.
String	getPrimaryUploadedFromPath() Deprecated.
protected void	getPrimaryUploadedFromPath(Properties params, Locale locale, OutputStream os) Deprecated.
String	getPrimaryUploadURL() Deprecated.
void	getPrimaryUploadURL(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	getResponseExceptions(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	getResponseFooters(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	getResponseHeaders(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	getResponseMessages(Properties parameters, Locale locale, OutputStream os) Deprecated.
protected void	getSize(Properties params, Locale locale, OutputStream os) Deprecated.
protected void	getTargetType(Properties params, Locale locale, OutputStream os) Deprecated.
void	getURLTabLink(Properties params, Locale locale, OutputStream os) Deprecated.
WTContainerRef	getWTContainerRef(Properties parameters, Locale locale) Deprecated. Get container value as contextual value.
void	handleRequest(HTTPRequest req, HTTPResponse resp) Deprecated. Does the processing of the HTML Template.
void	holderUploadTable(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	listLifeCycles(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	listTeamTemplates(Properties parameters, Locale locale, OutputStream os) Deprecated.
protected Method	obtainFromCovertProperty(PropertyDescriptor pd) Deprecated.
void	parentFolderPath(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	readExternal(ObjectInput input) Deprecated.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated. Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(GenerateFormProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated.
private float	roundToTwoDecimals(float number) Deprecated. Returns the given float rounded to two decimal places.
void	selectFolderMenu(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	selectFolderMenuForContainers(Properties parameters, Locale locale, OutputStream os) Deprecated. This method is used to print the select box for the available folders and cabinets within a container.
void	setContentHolder(FormatContentHolder contentHolder) Deprecated.
void	writeExternal(ObjectOutput output) Deprecated.

Methods inherited from class wt.templateutil.processor.DefaultTemplateProcessor

addHiddenProperty, addToFeedbackCookie, addToFeedbackCookie, getContextPropertyValue, getCurrentUrl, getFeedbackCookieExceptions, getFeedbackCookieMessages, getHtmlTemplateFactory, getMessageSeparator, getPAGE_EXPIRATION, getPageExpirationResource, getTemplate, getTemplateDisplay, hiddenContextString, readVersion, setContextPropertyValue, setHtmlTemplateFactory, setMethodContextProperty, setNameProcessor, setPAGE_EXPIRATION, setPageExpirationResource, writeHiddenContext, writeQueryStringContext

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, addHTMLHelpLink, addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, allVersions, bcwti, buildFormProcessorURL, buildFormProcessorURL, comment, createActionsBar, createFederationNavigationBar, createGlobalNavigationBar, createNavigationBar, createParentFolderLink, currentTimestamp, displayAllCabinets, displayAttributeName, displayAttributesTable, displayAttributeValue, displayFolderContents, displayFolderObject, displayFolderTrail, displayGoToLatestLink, displayOrganizationIdentifier, displayPendingChangeIndicator, displayStyleSheetAttributesTable, displayVisualData, formatDate, getActionPairs, getAllCabinetsURL, getBaselineItems, getCharsetEncoding, getCheckedOutFolderURL, getClassIcon, getClassInfo, getContextAction, getContextClass, getContextClassName, getContextListIn, getContextListOut, getContextObj, getContextProperties, getContextServiceName, getDisplayName, getDomainPath, getEnabledVersion, getEncoding, getFederationSearchURL, getFolderLocation, getFolderPath, getFormData, getGenericInstanceIconImgTag, getGlyphImageTag, getGlyphsArray, getGlyphTagsNoDnD, getHelpContext, getHomepageURL, getHTMLComponentFactory, getHTMLHelpLink, getHTMLHelpURL, getHTMLHelpURL, getHTMLTableService, getIconResource, getIconResource, getIconResource, getIconSelector, getId, getJavaScriptManager, getLocalizedDateFormatMessage, getLocalizedMessage, getLocalizedPrintWriter, getLocalizedString, getObjectDnDIcon, getObjectIcon, getObjectIconDnDTag, getObjectIconGlyphs, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectPropertyValueString, getObjectPropertyValueString, getPageContext, getParentFolderLink, getPersonalCabinet, getPersonalCabinetURL, getPreferenceValue, getPrincipalEmailLink, getPrincipalEmailLink, getPrintWriter, getPropertyFromPropertyFile, getQuery, getQueryData, getReferenceString, getReferenceString, getResourceString, getResourceString, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getResponseString, getSearchCriteriaURL, getSearchCriteriaURL, getSearchResultsURL, getShareImage, getShareImage, getState, getStatus, getStringFromResourceBundle, getStringFromResourceBundle, getTemplateDisplayGeneral, getTrailId, getTrlIdAttribute, getURLActions, getURLActions, getURLActions, getURLActions, getURLActionsString, getURLActionsString, getURLFactory, getURLFromDelegate, getURLProcessorLink, getURLProcessorLink, getURLProcessorLink, getURLProcessorLinkWithLabel, getUsedByLinks, getWCColor, getWCColor, getWCColorDec, getWCColorDec, getWCFontFamily, getWCFontFamily, getWorklistURL, getWTAttribute, getWTContainerByName, handleExceptionTP, handleExceptionTP, handleProcessorException, include, initJavaScriptManager, isDndMicroAppletEnabled, isEqual, listContent, objectActionLink, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectBackground, objectIdentification, objectIdentifier, objectProperties, objectPropertyName, objectPropertyNameAux, objectPropertyNameAux2, objectPropertyValue, objectPropertyValueAux, objectPropertyValueAux2, objectPropertyValueString, outputLink, outputPropertyFromPropertyFile, parameterValue, partUsedBy, PDMLinkIsInstalled, printQueryTable, printTable, printTextArea, processSubTemplate, readContext, readVersion, setColumnProperties, setContextAction, setContextClass, setContextClassName, setContextListIn, setContextListOut, setContextObj, setContextProperties, setFormData, setHelpContext, setHTMLTableService, setJavaScriptManager, setPageContext, setQueryData, setResponseExceptions, setResponseFooters, setResponseHeaders, setResponseMessages, setResponseString, setState, setStatus, showResponseExceptions, showResponseFooters, showResponseHeaders, showResponseMessage, showResponseMessages, showVersions, sortQueryResult, splitStringIntoTokens, tableService, translateToHtml, useProcessorService, visualizationIsEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

Deprecated.

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Deprecated.

serialVersionUID

static final long serialVersionUID

Deprecated.

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

Deprecated.

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

Deprecated.

See Also:

Constant Field Values

TEAMTEMPLATE_INPUT_NAME

public static final String TEAMTEMPLATE_INPUT_NAME

Deprecated.

See Also:

Constant Field Values

DEFAULT_LIFECYCLE

public static String DEFAULT_LIFECYCLE

Deprecated.

DELIM

private static String DELIM

Deprecated.

PRIMARY

private static String PRIMARY

Deprecated.

ATTRIBUTE

private static String ATTRIBUTE

Deprecated.

contentHolder

private FormatContentHolder contentHolder

Deprecated.

LASTUPDATED

private static String LASTUPDATED

Deprecated.

FORMAT

private static String FORMAT

Deprecated.

SIZE

private static String SIZE

Deprecated.

TARGETTYPE

private static String TARGETTYPE

Deprecated.

DEFAULTPATH

private static String DEFAULTPATH

Deprecated.

DOWNLOADURL

private static String DOWNLOADURL

Deprecated.

UPLOADURL

private static String UPLOADURL

Deprecated.

UPLOADEDFROMPATH

private static String UPLOADEDFROMPATH

Deprecated.

FILENAME

private static String FILENAME

Deprecated.

CHECKSUM

private static String CHECKSUM

Deprecated.

OIDSTRING

private static String OIDSTRING

Deprecated.

ON_CHANGE_EVENT_NAME

public static final String ON_CHANGE_EVENT_NAME

Deprecated.

See Also:

Constant Field Values

Constructor Detail

GenerateFormProcessor

public GenerateFormProcessor()

Deprecated.

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Deprecated.

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class DefaultTemplateProcessor

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Deprecated.

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class DefaultTemplateProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(GenerateFormProcessor thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Deprecated.

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Deprecated.

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

handleRequest

public void handleRequest(HTTPRequest req,
                          HTTPResponse resp)
                   throws WTException

Deprecated.

Description copied from class: DefaultTemplateProcessor

Does the processing of the HTML Template. This method is implemented using the GoF "Template Method". There are several actions that can be overriden by overriding certain methods in a subclass.

• getTemplate - this retrieves the HTML Template to be processed
• readContext - sets instance variables to be used in the template processing
• setState - initializes the HTTPState object to be used for the current state

Specified by:

handleRequest in interface TemplateProcessor

Overrides:

handleRequest in class DefaultTemplateProcessor

Parameters:

req -

resp -

Throws:

WTException

contextualValue

public void contextualValue(Properties parameters,
                            Locale locale,
                            OutputStream os)
                     throws WTException,
                            InvocationTargetException,
                            IllegalAccessException,
                            ClassNotFoundException,
                            InstantiationException

Deprecated.

This call is used to output the value of the attribute identified by the property "propertyName" in the parameters argument. If this property is found in the form data or query data, that value will be used otherwise the value from the database will be used.

Supported API: true

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

contextualValueEncoded

public void contextualValueEncoded(Properties parameters,
                                   Locale locale,
                                   OutputStream os)
                            throws WTException,
                                   InvocationTargetException,
                                   IllegalAccessException,
                                   ClassNotFoundException,
                                   InstantiationException

Deprecated.

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

changedContextualValue

public void changedContextualValue(Properties parameters,
                                   Locale locale,
                                   OutputStream os)
                            throws WTException,
                                   InvocationTargetException,
                                   IllegalAccessException,
                                   ClassNotFoundException,
                                   InstantiationException

Deprecated.

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

enumeratedTypeMenu

public void enumeratedTypeMenu(Properties parameters,
                               Locale locale,
                               OutputStream os)
                        throws WTException,
                               InvocationTargetException,
                               IllegalAccessException,
                               ClassNotFoundException,
                               InstantiationException

Deprecated.

This Windchill script call displays a dropdown menu for an attribute of type EnumeratedType belonging to the current context object or context class. The following are searched for the current value of the attribute, in this order: form data using attribute name as key, query data using attribute name as the key, database value of the attribute for the current contextObj if set.

Supported API: false

Parameters:

parameters - name/value pairs passed by the script call

• The name "propertyName" should be used to pass the name of the object property. Required.
• The name "elementName" should be used to pass the value of the name parameter on the SELECT tag. Optional. If not passed, propertyName will be used for the name parameter.
• The name "useStringValue" should be set to true if the value of the OPTION tags should be the full name of the enumerated type value, e.g., "wt.part.PartType.inseparable". Optional. Default is false, in which case the OPTION tags will have ordinal values, e.g. "0", "1".
• The name "useShortStringValue" should be set to "true" if the value of the OPTION tags should be the short name of the enumerated type value, e.g., "inseparable". Optional. Default is false, in which case the OPTION tags will have ordinal values, e.g. "0", "1". The parameters "useStringValue" and "useShortStringValue" are mutually exclusive.
• The name "displayNonSelectable" should be set to "true" if values marked as nonselectable in the definition of the EnumeratedType should be displayed in the menu. Optional. Default is false.

locale - locale to use for localization

os - the output stream

Supported API: true

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

enumeratedTypeMenuForClass

public void enumeratedTypeMenuForClass(Properties parameters,
                                       Locale locale,
                                       OutputStream os)
                                throws WTException,
                                       Exception

Deprecated.

This Windchill script call displays a dropdown menu for an object attribute of type EnumeratedType. Functions the same as getFormValueFromSessionWithEnumeratedPropertyDefault() except the menu is for a given class instead of the current context obj or context class. The following are searched for the current value of the attribute, in this order: ServletSessionCookie for form, form data using attribute name as key, query data using attribute name as the key.

Supported API: false

Parameters:

parameters - name/value pairs passed by the script call

• The name "contextClass" should be used to pass the name of class to which the attribute belongs. Optional. If not passed the current context obj or context class will be used.
• The name "propertyName" should be used to pass the name of the object property. Required.
• The name "formName" should be used to pass the key used to identify your form in session. Required if you want the current value to be retrieved from the ServletSessionCookie for the form
• The name "formFieldName" should be used to pass the name of the input field. Either this parameter or "elementName" must be passed if you want the current value to be retrieved from the ServletSessionCookie for the form.
• The name "elementName" should be used to pass the value of the name parameter on the SELECT tag. Optional. If not passed, propertyName will be used for the name parameter.
• The name "useStringValue" should be set to "true" if the value of the OPTION tags should be the full name of the enumerated type value, e.g., "wt.part.PartType.inseparable". Optional. Default is false, in which case the OPTION tags will have ordinal values, e.g. "0", "1".
• The name "useShortStringValue" should be set to "true" if the value of the OPTION tags should be the short name of the enumerated type value, e.g., "inseparable". Optional. Default is false, in which case the OPTION tags will have ordinal values, e.g. "0", "1". The parameters "useStringValue" and "useShortStringValue" are mutually exclusive.
• The name "displayNonSelectable" should be set to "true" if values marked as nonselectable in the definition of the EnumeratedType should be displayed in the menu. Optional. Default is false.

locale - locale to use for localization

os - the output stream

Throws:

WTException

Exception

listLifeCycles

public void listLifeCycles(Properties parameters,
                           Locale locale,
                           OutputStream os)
                    throws WTException,
                           InvocationTargetException,
                           IllegalAccessException,
                           ClassNotFoundException,
                           InstantiationException

Deprecated.

Dynamically generates a HTML drop down menu of the valid lifecycles based on the lifeCycleTemplate associated with the context class or the context object.

Supported API: true

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

listTeamTemplates

public void listTeamTemplates(Properties parameters,
                              Locale locale,
                              OutputStream os)
                       throws WTException,
                              InvocationTargetException,
                              IllegalAccessException,
                              ClassNotFoundException,
                              InstantiationException

Deprecated.

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

selectFolderMenu

public void selectFolderMenu(Properties parameters,
                             Locale locale,
                             OutputStream os)
                      throws WTException

Deprecated.

Throws:

WTException

selectFolderMenuForContainers

public void selectFolderMenuForContainers(Properties parameters,
                                          Locale locale,
                                          OutputStream os)
                                   throws WTException

Deprecated.

This method is used to print the select box for the available folders and cabinets within a container. At this time, this method is not container compliant (ie. it will show all cabinets) and should not be used with Solutions. passing the onlySharedCabinets=true on the template processor call will cause only Shared Cabinets to be displayed. This method is used by the "FolderNavigateImproved.html" templates

Throws:

WTException

parentFolderPath

public void parentFolderPath(Properties parameters,
                             Locale locale,
                             OutputStream os)
                      throws WTException

Deprecated.

Throws:

WTException

currentFolderPath

public void currentFolderPath(Properties parameters,
                              Locale locale,
                              OutputStream os)
                       throws WTException

Deprecated.

Throws:

WTException

currentFolderId

public void currentFolderId(Properties parameters,
                            Locale locale,
                            OutputStream os)
                     throws WTException

Deprecated.

Throws:

WTException

holderUploadTable

public void holderUploadTable(Properties parameters,
                              Locale locale,
                              OutputStream os)
                       throws WTException,
                              IOException

Deprecated.

Throws:

WTException

IOException

generateAction

public void generateAction(Properties parameters,
                           Locale locale,
                           OutputStream os)
                    throws WTException

Deprecated.

Throws:

WTException

obtainFromCovertProperty

protected Method obtainFromCovertProperty(PropertyDescriptor pd)

Deprecated.

getButtonText

public void getButtonText(Properties parameters,
                          Locale locale,
                          OutputStream os)
                   throws WTException,
                          IOException

Deprecated.

Throws:

WTException

IOException

generatePostURL

public void generatePostURL(Properties parameters,
                            Locale locale,
                            OutputStream os)
                     throws WTException

Deprecated.

Throws:

WTException

addHiddenProperties

public void addHiddenProperties(Properties parameters,
                                Locale locale,
                                OutputStream os)
                         throws WTException

Deprecated.

Throws:

WTException

getResponseHeaders

public void getResponseHeaders(Properties parameters,
                               Locale locale,
                               OutputStream os)

Deprecated.

getResponseMessages

public void getResponseMessages(Properties parameters,
                                Locale locale,
                                OutputStream os)

Deprecated.

getResponseFooters

public void getResponseFooters(Properties parameters,
                               Locale locale,
                               OutputStream os)

Deprecated.

getResponseExceptions

public void getResponseExceptions(Properties parameters,
                                  Locale locale,
                                  OutputStream os)

Deprecated.

getContextualValue

public String getContextualValue(String propertyName,
                                 Properties scriptProps,
                                 Locale locale)
                          throws WTException

Deprecated.

Throws:

WTException

getMessageURL

public void getMessageURL(Properties parameters,
                          Locale locale,
                          OutputStream os)

Deprecated.

getObjectIdentity

public void getObjectIdentity(Properties parameters,
                              Locale locale,
                              OutputStream os)

Deprecated.

getObjectIdentity

private String getObjectIdentity(String resourceKey,
                                 String resourceClass,
                                 Locale locale)

Deprecated.

getURLTabLink

public void getURLTabLink(Properties params,
                          Locale locale,
                          OutputStream os)
                   throws WTException

Deprecated.

Throws:

WTException

getDnDAppletTags

public void getDnDAppletTags(Properties parameters,
                             Locale locale,
                             OutputStream os)

Deprecated.

getDelim

public void getDelim(Properties params,
                     Locale locale,
                     OutputStream os)

Deprecated.

getDefaultPath

public void getDefaultPath(Properties params,
                           Locale locale,
                           OutputStream os)
                    throws WTException,
                           PropertyVetoException

Deprecated.

Retrieves a default path for use by the file locator. Returns empty string if the workspacePath preference hasn't been set.

Supported API: false

Throws:

WTException

PropertyVetoException

getPrimaryAttribute

public void getPrimaryAttribute(Properties params,
                                Locale locale,
                                OutputStream os)
                         throws WTException

Deprecated.

Throws:

WTException

setContentHolder

public void setContentHolder(FormatContentHolder contentHolder)

Deprecated.

getContentHolder

public FormatContentHolder getContentHolder()

Deprecated.

getPrimary

protected void getPrimary(Properties params,
                          Locale locale,
                          OutputStream os)
                   throws WTException,
                          PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getPrimary

protected String getPrimary(String purpose)
                     throws WTException,
                            PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getPrimaryChecksum

protected void getPrimaryChecksum(Properties params,
                                  Locale locale,
                                  OutputStream os)
                           throws WTException,
                                  PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getPrimaryChecksum

public String getPrimaryChecksum()
                          throws WTException,
                                 PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getPrimaryOidString

protected void getPrimaryOidString(Properties params,
                                   Locale locale,
                                   OutputStream os)
                            throws WTException,
                                   PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getPrimaryOidString

public String getPrimaryOidString()
                           throws WTException,
                                  PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getPrimaryFileName

protected void getPrimaryFileName(Properties params,
                                  Locale locale,
                                  OutputStream os)
                           throws WTException,
                                  PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getPrimaryFileName

public String getPrimaryFileName()
                          throws WTException,
                                 PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getPrimaryUploadedFromPath

protected void getPrimaryUploadedFromPath(Properties params,
                                          Locale locale,
                                          OutputStream os)
                                   throws WTException,
                                          PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getPrimaryUploadedFromPath

public String getPrimaryUploadedFromPath()
                                  throws WTException,
                                         PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getLastUpdated

protected void getLastUpdated(Properties params,
                              Locale locale,
                              OutputStream os)
                       throws WTException,
                              PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getFormat

protected void getFormat(Properties params,
                         Locale locale,
                         OutputStream os)
                  throws WTException,
                         PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getSize

protected void getSize(Properties params,
                       Locale locale,
                       OutputStream os)
                throws WTException,
                       PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getFileSize

private String getFileSize(ApplicationData file)

Deprecated.

Description copied from class: BasicTemplateProcessor

Returns a String containing the size of the given file in Kilobytes. The string returned also contains the units (e.g "100 KB").

Supported API: false

roundToTwoDecimals

private float roundToTwoDecimals(float number)

Deprecated.

Description copied from class: BasicTemplateProcessor

Returns the given float rounded to two decimal places.

Supported API: false

getTargetType

protected void getTargetType(Properties params,
                             Locale locale,
                             OutputStream os)
                      throws WTException,
                             PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getPrimaryUploadURL

public void getPrimaryUploadURL(Properties parameters,
                                Locale locale,
                                OutputStream os)
                         throws WTException

Deprecated.

Throws:

WTException

getPrimaryUploadURL

public String getPrimaryUploadURL()
                           throws WTException

Deprecated.

Throws:

WTException

getPrimaryDownloadURL

public void getPrimaryDownloadURL(Properties parameters,
                                  Locale locale,
                                  OutputStream os)
                           throws WTException

Deprecated.

Throws:

WTException

getPrimaryDownloadURL

public String getPrimaryDownloadURL()
                             throws WTException

Deprecated.

Throws:

WTException

getFormValueFromSession

public void getFormValueFromSession(Properties parameters,
                                    Locale locale,
                                    OutputStream os)
                             throws WTException

Deprecated.

This Windchill script call retrieves an input value for a wizard form from session context. It is designed to be used with multi-page wizards which store the user-entered values for the input fields of a page in a session cookie before switching pages. With this method, the value the user previously entered for a field can be retrieved if the user returns to a wizard page. If there is no value for a field stored in session context, this method outputs the defaultValue, if provided, or does nothing, otherwise.

Supported API: false

Parameters:

parameters - name/value pairs passed by the script call

• The name "formName" should be used to pass the key used to identify your form in session. Required.
• The name "formFieldName" should be used to pass the name of the input field. Required.
• The name "defaultValue" can be used to pass the name of a default value that should be returned if there is no value for the field in the session context. Optional.

locale - locale to use for localization

os - the output stream

Throws:

WTException

getFormValueFromSession

public String getFormValueFromSession(String formName,
                                      String inputFieldName,
                                      String defaultValue)
                               throws WTException

Deprecated.

This method retrieves an input value for a wizard form from session context. It is designed to be used with multi-page wizards which store the user-entered values for the input fields of a page in a session cookie before switching pages. With this method, the value the user previously entered for a field can be retrieved if the user returns to a wizard page. If there is no value for a field stored in session context, this method returns the defaultValue, if provided, or does nothing, otherwise.

Supported API: false

Parameters:

formName - the key used to identify the form in session. Required.

defaultValue - the name of a default value that should be returned if there is no value for the field in the session context. Optional.

Throws:

WTException

getPreferenceValue

public void getPreferenceValue(Properties params,
                               Locale locale,
                               OutputStream os)
                        throws WTException,
                               PropertyVetoException

Deprecated.

Throws:

WTException

PropertyVetoException

getEnumeratedTypeMenu

protected void getEnumeratedTypeMenu(Properties parameters,
                                     Locale locale,
                                     OutputStream os,
                                     String contextEnumValue)
                              throws WTException,
                                     InvocationTargetException,
                                     IllegalAccessException,
                                     ClassNotFoundException,
                                     InstantiationException

Deprecated.

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

getFormValueFromSessionWithPropertyDefault

public void getFormValueFromSessionWithPropertyDefault(Properties parameters,
                                                       Locale locale,
                                                       OutputStream os)
                                                throws WTException

Deprecated.

This Windchill script call retrieves an input value for a wizard form from session context. It is designed to be used with multi-page wizards which store the user-entered values for the input fields of a page in a session cookie before switching pages. With this method, the value the user previously entered for a field can be retrieved if the user returns to a wizard page. If there is no value for a field stored in session context, this method outputs the object property value, if there is context onject, or does nothing, otherwise.

Supported API: false

Parameters:

parameters - name/value pairs passed by the script call

• The name "formName" should be used to pass the key used to identify your form in session. Required.
• The name "formFieldName" should be used to pass the name of the input field. Required.
• The name "propertyName" can be used to pass the property name whose value will be used as dedault value when there is no data in session .

locale - locale to use for localization

os - the output stream

Throws:

WTException

getFormValueFromSessionWithEnumeratedPropertyDefault

public void getFormValueFromSessionWithEnumeratedPropertyDefault(Properties parameters,
                                                                 Locale locale,
                                                                 OutputStream os)
                                                          throws WTException,
                                                                 InvocationTargetException,
                                                                 IllegalAccessException,
                                                                 ClassNotFoundException,
                                                                 InstantiationException

Deprecated.

This Windchill script call displays a dropdown menu for an attribute of type EnumeratedType belonging to the current context object or context class. The following are searched for the current value of the attribute, in this order: ServletSessionCookie for form using elementName as key,, form data with attribute name as key, query data with attribute name as key, database value of attribute for contextObj if set. This method is the same as enumeratedTypeMenu() except that the ServletSessionCookie is searched for the current value of the attribute.

Supported API: false

Parameters:

parameters - name/value pairs passed by the script call

• The name "formName" should be used to pass the name used to identify your form in session. Required if you want the current value to be retrieved from the ServletSessionCookie for the form.
• The name "formFieldName" is used to pass the name attribute on the SELECT tag.. This is a deprecated parameter. Use "elementName" instead in new applications.
• The name "propertyName" should be used to pass the name of the object property. Required.
• The name "elementName" should be used to pass the value of the name attribute on the SELECT tag. Optional. If not passed, propertyName will be used for the name parameter.
• The name "useStringValue" should be set to true if the value of the OPTION tags should be the full name of the enumerated type value, e.g., "wt.part.PartType.inseparable". Optional. Default is false, in which case the OPTION tags will have ordinal values, e.g. "0", "1".
• The name "useShortStringValue" should be set to true if the value of the OPTION tags should be the short name of the enumerated type value, e.g., "inseparable". Optional. Default is false, in which case the OPTION tags will have ordinal values, e.g. "0", "1". The parameters "useStringValue" and "useShortStringValue" are mutually exclusive.
• The name "displayNonSelectable" should be set to true if values marked as nonselectable in the definition of the EnumeratedType should be displayed in the menu. Optional. Default is false.

locale - locale to use for localization

os - the output stream

Throws:

WTException

InvocationTargetException

IllegalAccessException

ClassNotFoundException

InstantiationException

generateUpdatePostURL

public void generateUpdatePostURL(Properties parameters,
                                  Locale locale,
                                  OutputStream os)
                           throws WTException

Deprecated.

Throws:

WTException

getWTContainerRef

public WTContainerRef getWTContainerRef(Properties parameters,
                                        Locale locale)
                                 throws WTException

Deprecated.

Get container value as contextual value.

Overrides:

getWTContainerRef in class BasicTemplateProcessor

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

Returns:

The wTContainerRef value

Throws:

WTException - Description of the Exception

createHTMLTagParam

private String createHTMLTagParam(String nameAttribute,
                                  Properties parameters)

Deprecated.

From the specified parameters list, look for additional tag parameters. The following parameters are looked: - onChange representing onChange javascript event handler e.g. onchange=xxx() where xxx is some javascript event handler - id representing the id attribute for the tag e.g. id=multirevise_teamtemplate