wt.change2.htmlclient
Class ChangeManagementFormProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              wt.change2.htmlclient.ChangeManagementFormProcessor

All Implemented Interfaces:

Externalizable, Serializable, TemplateProcessor, ContextHolder, ContextTranslator, Evolvable

Direct Known Subclasses:

DefaultChangeTaskProcessor

Deprecated. 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 on a JSP framework in an upcoming release. The form processor supports HTML generation for Windchill Change Management. Please refer to the chapter "Customizing Change Management" in the Windchill Customizer's Guide.

public class ChangeManagementFormProcessor
extends GenerateFormProcessor
implements Externalizable

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

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

Method Summary

void	createFormConstruct(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	displayChangeTask(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	pageTitle(Properties parameters, Locale locale, OutputStream os) Deprecated.

Methods inherited from class wt.templateutil.processor.GenerateFormProcessor

listLifeCycles

Methods inherited from class wt.templateutil.processor.DefaultTemplateProcessor

displayAttributeLabel, displayAttributeVal, getAttributes, getContextPropertyValue, getHtmlTemplateFactory, getPAGE_EXPIRATION, getPageExpirationResource, getTemplate, setContextPropertyValue, setNameProcessor, setPAGE_EXPIRATION, setPageExpirationResource

Methods inherited from class wt.enterprise.BasicTemplateProcessor

addHTMLHelpLink, addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, createActionsBar, createGlobalNavigationBar, createNavigationBar, currentTimestamp, getContextAction, getContextClassName, getContextListIn, getContextListOut, getContextObj, getContextProperties, getEncoding, getFormData, getHTMLHelpURL, getHTMLTableService, getLocalizedPrintWriter, getObjectIcon, getPrintWriter, getQueryData, getResourceString, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getResponseString, getStatus, getURLProcessorLink, getWCColor, getWCColor, getWCColorDec, getWCFontFamily, getWCFontFamily, objectActionLink, objectBackground, objectIdentification, objectPropertyName, objectPropertyValue, processSubTemplate, setContextAction, setContextClassName, setContextListIn, setContextListOut, setContextObj, setContextProperties, setFormData, setQueryData, setResponseExceptions, setResponseFooters, setResponseHeaders, setResponseMessages, setResponseString, setStatus, showResponseExceptions, tableService

Methods inherited from class java.lang.Object

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

Method Detail

createFormConstruct

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

Deprecated.

(Windchill Script method) Initialize various elements necessary for the Change Management HTML user interface. This script method is one of the first methods invoked for any Change Management HTML page. It performs the following activities:

1. Move all information following the "?" in the browser location bar (called QueryString) to the form data. This is necessary if an update or create page immediately followed this page because the IntermediateAction.html template causes all of the form data to be moved to the QueryString.
2. Obtain the context object and reset it to be the parent Change Request This allows the user interface to always display the parent Change Request first. The FindChangeRequestDelegate is used to determine the parent Change Request.
3. Call FindChangeRequestDelegate.setHtmlClientState using the original context object. In the standard Windchill delegates this causes the original context object to be pre-expanded when the page is displayed in the browser.
4. Set the "update" form data property to the object reference for the original context object if the context action indicates update mode. This displays the original context object in an updatable mode.
5. Output the FORM tag to the browser. The name of the form is obtained from the value of the "name" parameter passed to this script call.
6. Output the following hidden form fields to the browser. These values are used by the JavaScript methods, which perform HTTP POST operations and cause the server to process the forms.
   • refreshAction - value is set to "ObjProps" if the original context action was an update action, the original context action otherwise
   • refreshOid - value is set to the object reference string of the parent change request
   • refreshClass - value is set to he class of the object being created. This will be null if there is a parent change request.

Supported API: true

Parameters:

parameters -

locale -

os -

Throws:

WTException

displayChangeTask

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

Deprecated.

(Windchill Script method) Invokes a subtemplate at the current point in the HTML template. This script method inserts a template using one of the following context actions:

• CreateRequestTask, if the context object is null
• DefaultUpdateTask, if the current context action is AutoUpdateChangeObject
• DefaultViewTask, otherwise

Refer to codebase.change2.change2.properties to determine the HTML template and template processor used for each context action.

Supported API: true

Parameters:

parameters -

locale -

os -

Throws:

WTException

pageTitle

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

Deprecated.

(Windchill Script method) This script method sets the browser page title for the Change Management HTML user interface. The page title reflects the current task that the user is performing.

Supported API: true

Parameters:

parameters -

locale -

os -

Throws:

WTException