wt.enterprise
Class BasicTemplateProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor

All Implemented Interfaces:

Externalizable, Serializable, TemplateProcessor, ContextHolder, ContextTranslator, Evolvable

Direct Known Subclasses:

DefaultTemplateProcessor, ErrorProcessor, PartDistributionListProcessor, PartReferencesProcessor, PlmConfigurationsProcessor, ProductInstancesProcessor, ReferencedByProcessor, VersionHistoryProcessor

Deprecated.

public abstract class BasicTemplateProcessor
extends Object
implements TemplateProcessor, ContextTranslator, ContextHolder, Evolvable

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. This abstract class implements several methods useful for template processing. It is suggested that most new template processors should extend DefaultTemplateProcessor.

Supported API: true

Extendable: false

See Also:

"'Customizing the HTML Client' in 'Customizer's Guide'", 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	addHTMLHelpLink(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	addToResponseExceptions(Exception newException) Deprecated.
void	addToResponseFooters(LocalizableMessage newFooter) Deprecated.
void	addToResponseHeaders(LocalizableMessage newHeader) Deprecated.
void	addToResponseMessages(LocalizableMessage newMessage) Deprecated.
void	createActionsBar(Properties parameters, Locale locale, OutputStream os) Deprecated. Write a list of links to actions corresponding to the context object to the given OutputStream.
void	createGlobalNavigationBar(Properties parameters, Locale locale, OutputStream os) Deprecated. Output a table of links to global actions.
void	createNavigationBar(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs HTML Navigation Bar specific for object.
void	currentTimestamp(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs HTML that describes the current date and time.
String	getContextAction() Deprecated.
String	getContextClassName() Deprecated.
String[]	getContextListIn() Deprecated.
String[]	getContextListOut() Deprecated.
Object	getContextObj() Deprecated.
Properties	getContextProperties() Deprecated.
String	getEncoding(OutputStream out, Locale locale) Deprecated. Get character encoding that should be used with the template processing output stream.
Properties	getFormData() Deprecated.
void	getHTMLHelpURL(Properties parameters, Locale locale, OutputStream os) Deprecated.
TemplateProcessorTableService	getHTMLTableService() Deprecated.
static PrintWriter	getLocalizedPrintWriter(OutputStream out, Locale locale) Deprecated. Get a PrintWriter for the given output stream and locale.
void	getObjectIcon(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs the icon associated with the context object to the given OutputStream.
PrintWriter	getPrintWriter(OutputStream out, Locale locale) Deprecated. Get a PrintWriter for the given output stream and locale.
Properties	getQueryData() Deprecated.
void	getResourceString(Properties parameters, Locale locale, OutputStream os) Deprecated.
Vector	getResponseExceptions() Deprecated.
Vector	getResponseFooters() Deprecated.
Vector	getResponseHeaders() Deprecated.
Vector	getResponseMessages() Deprecated.
String	getResponseString() Deprecated.
int	getStatus() Deprecated.
void	getURLProcessorLink(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	getWCColor(Properties parameters, Locale locale, OutputStream os) Deprecated. Retrieves the value of a HTML color property from wt.properties and writes it to the HTML page.
static String	getWCColor(String styleClass) Deprecated. Retrieves the value of a HTML color property from wt.properties
void	getWCColorDec(Properties parameters, Locale locale, OutputStream os) Deprecated. Retrieves the value of a HTML color property from wt.properties and writes it to the HTML page as a decimal integer.
static String	getWCFontFamily() Deprecated. Retrieves the list of preferred HTML font faces from wt.properties
void	getWCFontFamily(Properties parameters, Locale locale, OutputStream os) Deprecated. Retrieves the list of preferred HTML font faces from wt.properties.
void	objectActionLink(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs an HTML HREF with a URL to the wt.enterprise.URLProcessor class and its URLTemplateAction method.
void	objectBackground(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs HTML to set the background of the page to a supplied image.
void	objectIdentification(Properties parameters, Locale locale, OutputStream os) Deprecated. Produces HTML which represents identification information for the contextual object of a BasicTemplateProcessor.
void	objectPropertyName(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs HTML which represents the display name of a property.
void	objectPropertyValue(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs HTML which represents the value of a property.
void	processSubTemplate(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	setContextAction(String a_ContextAction) Deprecated.
void	setContextClassName(String a_ContextClassName) Deprecated.
void	setContextListIn(String[] a_ContextListIn) Deprecated.
void	setContextListOut(String[] a_ContextListOut) Deprecated.
void	setContextObj(Object a_ContextObj) Deprecated.
void	setContextProperties(Properties a_ContextProperties) Deprecated.
void	setFormData(Properties a_FormData) Deprecated.
void	setQueryData(Properties a_QueryData) Deprecated.
void	setResponseExceptions(Vector a_ResponseExceptions) Deprecated.
void	setResponseFooters(Vector a_ResponseFooters) Deprecated.
void	setResponseHeaders(Vector a_ResponseHeaders) Deprecated.
void	setResponseMessages(Vector a_ResponseMessages) Deprecated.
void	setResponseString(String a_ResponseString) Deprecated.
void	setStatus(int a_Status) Deprecated.
void	showResponseExceptions(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	tableService(Properties parameters, Locale locale, OutputStream os) Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.enterprise.TemplateProcessor

handleRequest

Method Detail

getContextListIn

public String[] getContextListIn()

Deprecated.

Gets the value of the attribute: contextListIn.

Supported API: true

Specified by:

getContextListIn in interface ContextTranslator

Returns:

String[]

setContextListIn

public void setContextListIn(String[] a_ContextListIn)

Deprecated.

Sets the value of the attribute: contextListIn.

Supported API: true

Specified by:

setContextListIn in interface ContextTranslator

Parameters:

a_ContextListIn -

getContextListOut

public String[] getContextListOut()

Deprecated.

Gets the value of the attribute: contextListOut.

Supported API: true

Specified by:

getContextListOut in interface ContextTranslator

Returns:

String[]

setContextListOut

public void setContextListOut(String[] a_ContextListOut)

Deprecated.

Sets the value of the attribute: contextListOut.

Supported API: true

Specified by:

setContextListOut in interface ContextTranslator

Parameters:

a_ContextListOut -

getContextAction

public String getContextAction()

Deprecated.

Gets the value of the attribute: contextAction; Context Action is the name of the action of the current page

Supported API: true

Specified by:

getContextAction in interface ContextHolder

Returns:

String

setContextAction

public void setContextAction(String a_ContextAction)

Deprecated.

Sets the value of the attribute: contextAction; Context Action is the name of the action of the current page

Supported API: true

Specified by:

setContextAction in interface ContextHolder

Parameters:

a_ContextAction -

getContextObj

public Object getContextObj()

Deprecated.

Gets the value of the attribute: contextObj; Context Object is the reference object of the current page

Supported API: true

Specified by:

getContextObj in interface ContextHolder

Returns:

Object

setContextObj

public void setContextObj(Object a_ContextObj)

Deprecated.

Sets the value of the attribute: contextObj; Context Object is the reference object of the current page

Supported API: true

Specified by:

setContextObj in interface ContextHolder

Parameters:

a_ContextObj -

getContextClassName

public String getContextClassName()

Deprecated.

Gets the value of the attribute: contextClassName; Context Object Name is the name of the class of the current page

Supported API: true

Specified by:

getContextClassName in interface ContextHolder

Returns:

String

setContextClassName

public void setContextClassName(String a_ContextClassName)

Deprecated.

Sets the value of the attribute: contextClassName; Context Object Name is the name of the class of the current page

Supported API: true

Specified by:

setContextClassName in interface ContextHolder

Parameters:

a_ContextClassName -

getContextProperties

public Properties getContextProperties()

Deprecated.

Gets the value of the attribute: contextProperties.

Supported API: true

Specified by:

getContextProperties in interface ContextHolder

Returns:

Properties

setContextProperties

public void setContextProperties(Properties a_ContextProperties)

Deprecated.

Sets the value of the attribute: contextProperties.

Supported API: true

Specified by:

setContextProperties in interface ContextHolder

Parameters:

a_ContextProperties -

getResponseExceptions

public Vector getResponseExceptions()

Deprecated.

Gets the value of the attribute: responseExceptions.

Supported API: true

Specified by:

getResponseExceptions in interface ContextHolder

Returns:

Vector

setResponseExceptions

public void setResponseExceptions(Vector a_ResponseExceptions)

Deprecated.

Sets the value of the attribute: responseExceptions.

Supported API: true

Specified by:

setResponseExceptions in interface ContextHolder

Parameters:

a_ResponseExceptions -

getResponseFooters

public Vector getResponseFooters()

Deprecated.

Gets the value of the attribute: responseFooters.

Supported API: true

Specified by:

getResponseFooters in interface ContextHolder

Returns:

Vector

setResponseFooters

public void setResponseFooters(Vector a_ResponseFooters)

Deprecated.

Sets the value of the attribute: responseFooters.

Supported API: true

Specified by:

setResponseFooters in interface ContextHolder

Parameters:

a_ResponseFooters -

getResponseHeaders

public Vector getResponseHeaders()

Deprecated.

Gets the value of the attribute: responseHeaders.

Supported API: true

Specified by:

getResponseHeaders in interface ContextHolder

Returns:

Vector

setResponseHeaders

public void setResponseHeaders(Vector a_ResponseHeaders)

Deprecated.

Sets the value of the attribute: responseHeaders.

Supported API: true

Specified by:

setResponseHeaders in interface ContextHolder

Parameters:

a_ResponseHeaders -

getResponseMessages

public Vector getResponseMessages()

Deprecated.

Gets the value of the attribute: responseMessages.

Supported API: true

Specified by:

getResponseMessages in interface ContextHolder

Returns:

Vector

setResponseMessages

public void setResponseMessages(Vector a_ResponseMessages)

Deprecated.

Sets the value of the attribute: responseMessages.

Supported API: true

Specified by:

setResponseMessages in interface ContextHolder

Parameters:

a_ResponseMessages -

getResponseString

public String getResponseString()

Deprecated.

Gets the value of the attribute: responseString.

Supported API: true

Specified by:

getResponseString in interface ContextHolder

Returns:

String

setResponseString

public void setResponseString(String a_ResponseString)

Deprecated.

Sets the value of the attribute: responseString.

Supported API: true

Specified by:

setResponseString in interface ContextHolder

Parameters:

a_ResponseString -

getStatus

public int getStatus()

Deprecated.

Gets the value of the attribute: status.

Supported API: true

Specified by:

getStatus in interface ContextHolder

Returns:

int

setStatus

public void setStatus(int a_Status)

Deprecated.

Sets the value of the attribute: status.

Supported API: true

Specified by:

setStatus in interface ContextHolder

Parameters:

a_Status -

getFormData

public Properties getFormData()

Deprecated.

Gets the value of the attribute: formData; Form Data is the data present in the form of the current HTML page.

Supported API: true

Specified by:

getFormData in interface ContextHolder

Returns:

Properties

setFormData

public void setFormData(Properties a_FormData)

Deprecated.

Sets the value of the attribute: formData; Form Data is the data present in the form of the current HTML page.

Supported API: true

Specified by:

setFormData in interface ContextHolder

Parameters:

a_FormData -

getQueryData

public Properties getQueryData()

Deprecated.

Gets the value of the attribute: queryData; Query Data is the information present after the "?" mark on the URL of the current page.

Supported API: true

Specified by:

getQueryData in interface ContextHolder

Returns:

Properties

setQueryData

public void setQueryData(Properties a_QueryData)

Deprecated.

Sets the value of the attribute: queryData; Query Data is the information present after the "?" mark on the URL of the current page.

Supported API: true

Specified by:

setQueryData in interface ContextHolder

Parameters:

a_QueryData -

getLocalizedPrintWriter

public static PrintWriter getLocalizedPrintWriter(OutputStream out,
                                                  Locale locale)

Deprecated.

Get a PrintWriter for the given output stream and locale. Template processing uses a special output stream that allows reuse of a shared print writer and writes to the output stream using a character encoding determined from the locale of the template file resource. Therefore, all template processor methods should call this method when they need a print writer for writing text to their output stream.

Supported API: true

Parameters:

out - the output stream passed to the processing method

locale - the locale passed to the processing method

Returns:

PrintWriter the print writer to use for writing text to the output stream

getPrintWriter

public PrintWriter getPrintWriter(OutputStream out,
                                  Locale locale)

Deprecated.

Get a PrintWriter for the given output stream and locale. Template processing uses a special output stream that allows reuse of a shared print writer and writes to the output stream using a character encoding determined from the locale of the template file resource. Therefore, all template processor methods should call this method when they need a print writer for writing text to their output stream.

Supported API: true

Parameters:

out - the output stream passed to the processing method

locale - the locale passed to the processing method

Returns:

PrintWriter the print writer to use for writing text to the output stream

getEncoding

public String getEncoding(OutputStream out,
                          Locale locale)

Deprecated.

Get character encoding that should be used with the template processing output stream.

Supported API: true

Parameters:

out - the output stream passed to the processing method

locale - the locale passed to the processing method

Returns:

the encoding name

objectIdentification

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

Deprecated.

Produces HTML which represents identification information for the contextual object of a BasicTemplateProcessor.

It is expected that this method will be invoked as a result of an objectIdentification script call in an HTML template file. The format of objectIdentification script calls is:

objectIdentification [mode="Brief"|"Verbose"] [includeURL="url-property-name"]

mode

The mode parameter determines the detail provided by the template file. It defaults to "Verbose".

includeURL

The includeURL parameter is not currently defined. It defaults to "HtmlView".

Example:

objectIdentification mode=Brief

The format of the HTML that is output is determined by an HTML template file. The template that is used is chosen from the templates directory based on the class of the contextual object, the locale and the parameters passed to the objectIdentification script call within a higher level HTML template. Currently the template file is chosen from either the ObjectIdentificationVerbose or ObjectIdentificationBrief directories. Within those directories the template is chosen on the basis of:

   1. the class name of the context object
   2. the wt.enterprise super class of the context object
   3. the default template
 

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

objectPropertyValue

public void objectPropertyValue(Properties parameters,
                                Locale locale,
                                OutputStream os)
                         throws IllegalAccessException,
                                InvocationTargetException,
                                wt.introspection.WTIntrospectionException,
                                WTException

Deprecated.

Outputs HTML which represents the value of a property. The set of available properties are those that can be retrieved by the WTIntrospector class.

It is expected that this method will be invoked as a result of an objectPropertyValue script call in an HTML template file. The format of objectPropertyValue script calls is:

objectPropertyValue propertyName="propertyName"

propertyName

The propertyName parameter is the name of a property.

Example:

objectPropertyValue propertyName=requester

The format of the HTML that is output is dependent on the type of the property value.
Caution: This method will return "&nbsp;" for null property values. Also, if the MethodContext contains the property "preserveFormatting=true", characters with special meaning or treatment in HTML will be encoded to display properly in browsers. For example, '>' will be encoded as "&gt;" and a carriage return will be encoded as "<BR>." The preserveFormatting flag can be set using the Windchill script method DefaultTemplateProcessor.setMethodContextProperty().

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

IllegalAccessException - Description of the Exception

InvocationTargetException - Description of the Exception

wt.introspection.WTIntrospectionException - Description of the Exception

WTException - Description of the Exception

objectPropertyName

public void objectPropertyName(Properties parameters,
                               Locale locale,
                               OutputStream os)
                        throws IllegalAccessException,
                               InvocationTargetException,
                               wt.introspection.WTIntrospectionException,
                               WTException

Deprecated.

Outputs HTML which represents the display name of a property. The set of available properties are those that can be retrieved by the WTIntrospector class.

It is expected that this method will be invoked as a result of an objectPropertyName script call in an HTML template file. The format of objectPropertyName script calls is:

objectPropertyName propertyName="propertyName"

propertyName

The propertyName parameter is the name of a property.

Example:

objectPropertyName propertyName=requester

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

IllegalAccessException - Description of the Exception

InvocationTargetException - Description of the Exception

wt.introspection.WTIntrospectionException - Description of the Exception

WTException - Description of the Exception

objectActionLink

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

Deprecated.

Outputs an HTML HREF with a URL to the wt.enterprise.URLProcessor class and its URLTemplateAction method. The URL will be created with two or three parameters, an action, oid (object ID) and label. The action and label are supplied as input parameters. The oid is that of the context object of the BasicTemplateProcessor instance.

It is expected that this method will be invoked as a result of an objectActionLink script call in an HTML template file. The format of objectActionLink script calls is:

objectActionLink action="action" [label="label"] [labelPropertyName="labelPropertyName"

action

The action parameter is the action to take on the contextual object. The action is defined in the resource service used by the URLProcessor class.

label

By default, the label generated for the URL is the concatenation of the businessType and identity properties of the contextual object. This optional label will override the default.

labelPropertyName

By specifying a labelPropertyName, the value of the property will be used to override the default label.

Example:

objectActionLink action=ObjProps label=Context1

objectActionLink action=ObjProps labelPropertyName=requester

objectActionLink action=ObjProps

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

objectBackground

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

Deprecated.

Outputs HTML to set the background of the page to a supplied image. The image file used must be supplied as a parameter and is expected to be in $(wt.server.codebase)/wt/clients/images/.

It is expected that this method will be invoked as a result of an objectBackground script call in an HTML template file. The format of objectBackground script calls is:

objectBackground image="image"

image

The image parameter is the image file name to use as the background.

Example:

objectBackground image=background_gray.gif

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

currentTimestamp

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

Deprecated.

Outputs HTML that describes the current date and time.

It is expected that this method will be invoked as a result of an currentTimestamp script call in an HTML template file. The format of currentTimestamp script calls is:

currentTimestamp

Example:

currentTimestamp

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

getObjectIcon

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

Deprecated.

Outputs the icon associated with the context object to the given OutputStream. This method will output the image including any glyphs that should be associated with it. DnD may be turned on/off.

Supported API: true

Parameters:

parameters - the Properties passed in when this method is invoked; this parameter is not used by this method

locale - the Locale in which the image will be displayed

os - the OutputStream to write the image to.

createNavigationBar

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

Deprecated.

Outputs HTML Navigation Bar specific for object. Objects must be declared in enterpriseResource.

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

createActionsBar

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

Deprecated.

Write a list of links to actions corresponding to the context object to the given OutputStream. This method retrieves the actions corresponding to the current context object from the UrlLinkResource ResourceBundle, and creates a table of hyperlinks to those actions. This method is typically to be invoked as a script call in an HTML template file. The Windchill script call that invokes this method can contain optional parameters to specify the background color for the table cells and the color of the links: createActionsBar bgcolor=(Background Color) linkcolor=(Link Color) selected_linkcolor=(Selected Link Color)

Supported API: true

Parameters:

parameters - the Properties which contains parameter values specified in the script call. Can contain values for the link color and background color of the table cells.

locale - the locale in which the links will be displayed

os - the OutputStream to write the table of links to.

Throws:

WTException - if an error occurs building the links to the actions

createGlobalNavigationBar

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

Deprecated.

Output a table of links to global actions. This method does not currently support customization, but needs to be updated so that it will support customization.

Supported API: true

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

getHTMLHelpURL

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

Deprecated.

Prints out a String with the HTML for a link to a context dependent Help page to the browser.

The correct Windchill script call is

getHTMLHelpURL HelpContext=<Context to locate Help Page>

The HelpContext parameter is optional. See comments below.

The help page is based on the context of the current HTML page and is found via an entry in a *.properties file. The correct entry in a properties file will look like

wt.services/rsc/default/wt.templateutil.processor.HelpHTMLTemplate/<Context Action>/<Context Class>/0=<Path to HTML Help Page><Anchor>

Where

• Context Action - The current value of getContextAction, unless the HelpContext is passed in the Script call
• Context Class - If getContextObj != null, the class of the contextObj is used, otherwise the value of getContextClassName is used. If both return null, the java.lang.Object is used.
• Path to HTML Help Page - The non-localized path to the HTML Help page relative to codebase. For example, if the HTML Help page was at /wt/helpfiles/federation/help_en /IEServices.html, then the entry in the properties file would be,

  wt.helpfiles.federation.help.IEServices

• Anchor - Optionally you can specify an anchor in the page, so if the wanted to get the anchor,VIEWIESERVICE, in the Help page above, then you would have the following entry in your properties file wt.helpfiles.federation.help.IEServices#VIEWIESERVICE

The current list of options for configuring the Help link, via name/value pairs in the parameters argument is

• HelpContext - Replaces the Context Action that is used to locate the Help Page
  
  Supported API: true

  Parameters:

  parameters - The name/value pairs passed in from the Windchill Script Call

  locale - The current Locale of the browser

  os - The OutputStream to the Browser

  Throws:

  WTException - Description of the Exception

addHTMLHelpLink

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

Deprecated.

Prints the HTML with a link to a context dependent Help page. The help page is based on the context of the current HTML page, namely the contextAction and the contextObj or contextClassName(if the contextObj == null)

The correct Windchill script call is

addHTMLHelpLink <name/value pairs indicating customized options>

Please the javadoc for the method, getHTMLHelpLink, for listing and description of the name/value pairs that specify the options for presenting an HTML help link.

Please the javadoc for the method, getHTMLHelpLink, for description of how register an HTML Help page for the page that the help link is to appear.

Supported API: true

Parameters:

parameters -

locale -

os -

Throws:

WTException

getResourceString

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

Deprecated.

Gets the resourceString attribute of the BasicTemplateProcessor object

Supported API: true

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

getURLProcessorLink

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

Deprecated.

Gets the uRLProcessorLink attribute of the BasicTemplateProcessor object

Supported API: true

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

addToResponseExceptions

public void addToResponseExceptions(Exception newException)

Deprecated.

This method should be used to add to a running list of exceptions kept track of in the HTTPState object.

The stackTraces for the list of exceptions can be presented using the following Windchill Script call

Supported API: true

Specified by:

addToResponseExceptions in interface ContextHolder

Parameters:

newException -

addToResponseMessages

public void addToResponseMessages(LocalizableMessage newMessage)

Deprecated.

This method should be used to add to a running list of LocalizableMessages kept track of in the HTTPState object. This list of LocalizableMessage can be presented using the following Windchill Script call

The messages will be presented in the Locale of the HTML template

Supported API: true

Specified by:

addToResponseMessages in interface ContextHolder

Parameters:

newMessage -

addToResponseHeaders

public void addToResponseHeaders(LocalizableMessage newHeader)

Deprecated.

This method should be used to add to a running list of LocalizableMessages kept track of in the HTTPState object to present at the top of an HTML page. This list of messages can be presented using the following Windchill Script call

The goal of this option is to provide a way to present any information that occured preparing the processing of the page at the top of the page.

The LocalizableMessages will be presented in the locale of the HTML page

Supported API: true

Specified by:

addToResponseHeaders in interface ContextHolder

Parameters:

newHeader -

addToResponseFooters

public void addToResponseFooters(LocalizableMessage newFooter)

Deprecated.

This method should be used to add to a running list of Messages kept track of in the HTTPState object. This list of messages can be presented using the following Windchill Script call The goal of this option is to provide a way to present any information that occured during the processing of the page at the bottom of the page.

Supported API: true

Specified by:

addToResponseFooters in interface ContextHolder

Parameters:

newFooter - The feature to be added to the ToResponseFooters attribute

processSubTemplate

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

Deprecated.

Gets a TemplateProcessor and HTML Template and processes the HTML template in place. That is, the Windchill script call is replaced with the output of the processed HTML template. This allows a more componentized approach to your HTML templates and also allows your template processors to be componentized also.

The correct Windchill script call is

processSubTemplate action=<Context Action for sub-TemplateProcessor> <More name/value pairs>

This entry will look for the following in entry in a properties file

wt.services/rsc/default/wt.templateutil.DefaultHTMLTemplate/<Context Action for sub-TemplateProcessor> /<Current Context Object>/0=<relative path to HTML Template>

The action specified in the Windchill script call and the current context object are used to locate the correct TemplateProcessor and the HTML template via entries in the properties files, as usual.

After getting the TemplateProcessor, the current state is passed off the the sub-TemplateProcessor via the HTTPState object. The action on the HTTPState object is temporalily set to the action in the Windchill script call. The contextAction is restored to its previous value after the processing of the sub-HTML template is finished.

The Locale and OutputStream are passed off to the sub-TemplateProcessor so it knows the current Locale and has access to output stream to the browser. The name/values pairs passed in via the Windchill script are made available to the Sub-TemplateProcessor via contextProperties object of the TemplateProcessor.

Supported API: true

Parameters:

parameters -

locale -

os -

showResponseExceptions

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

Deprecated.

Presents the stackTraces from each Exception in maintained in the HTTPState object. The exceptions are added to the HTTPState object with the call to the addToResponseExceptions method.

The correct Windchill script call is

showResponseExceptions

The goal of this option is to provide a way to present a list of non-fatal stackTraces that occured in the processing of an HTML template or a HTTP Get/Post request.

Supported API: true

Parameters:

parameters -

locale -

os -

getHTMLTableService

public TemplateProcessorTableService getHTMLTableService()

Deprecated.

Gets the TemplateProcessorTableService instance to be used for the Windchill script calls

tableService action=...

If there is not an instance of TemplateProcessorTableService available, lazy initialization is done to present one.

The current state is passed to the TemplateProcessorTableService instance via the HTTPState object.

Supported API: true

Returns:

The hTMLTableService value

tableService

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

Deprecated.

Calls the current TemplateProcessorTableService instance and fires off an HTMLTableServiceEvent to all of the registered HTMLTableServiceEventListeners.

The correct Windchill script call is

tableService action=<A valid action for a HTMLTableServiceEventListener> <More name/value pairs>

The HTMLTableServiceEventListeners are registered in wt.properties in the entry

wt.templateutil.table.HTMLTableServiceEventListeners=...

Please see the Javadoc for the registered HTMLTableServiceEventListeners as to how to use the individual method calls and what parameters they take

Supported API: true

Parameters:

parameters -

locale -

os -

Throws:

WTException - Description of the Exception

getWCColor

public static String getWCColor(String styleClass)

Deprecated.

Retrieves the value of a HTML color property from wt.properties

Parameters:

styleClass - Refers to the name of a wt.html.color property in wt.properties (for example, "bg-body")

Returns:

Unquoted string in the form: #NNNNNN *

Supported API: true

getWCColor

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

Deprecated.

Retrieves the value of a HTML color property from wt.properties and writes it to the HTML page. This is for use as a Windchill script call.

The script call must pass the required parameter "styleClass" which refers to the name of a wt.html.color property in wt.properties.

The optional parameter "quotes" determines what kind of quotes will be included in the output.

The output written to the html page will be a color number string.
If quotes=none, the output will not have quotes: #NNNNNN
If quotes=single, the output will be in single quotes: '#NNNNNN'
If quotes=double or if there is no quotes parameter, the output will be in double quotes: "#NNNNNN"

Example usage in an html template: getWCColor styleClass=bg-navbar >

Supported API: true

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

getWCColorDec

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

Deprecated.

Retrieves the value of a HTML color property from wt.properties and writes it to the HTML page as a decimal integer. This is for use as a Windchill script call.

The script call must pass the required parameter "styleClass" which refers to the name of a wt.html.color property in wt.properties.

The output written to the html page will be an unquoted string in the form: nnnn...

Example usage in an html template: getWCColor styleClass=bg-body >

Supported API: true

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

getWCFontFamily

public static String getWCFontFamily()

Deprecated.

Retrieves the list of preferred HTML font faces from wt.properties

Returns:

Unquoted string in the form: [, , , ...]

Supported API: true

getWCFontFamily

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

Deprecated.

Retrieves the list of preferred HTML font faces from wt.properties. For use as a Windchill script call.

The output written to the HTML page will be a string in the form: "[, , , ...]"

The optional parameter "quotes" determines what kind of quotes will be included in the output.

If quotes=none, the output will not have quotes: [, ,...] If quotes=single, the output will be in single quotes: '[, ,...]' If quotes=double or if there is no quotes parameter, the output will be in double quotes: "[, ,...]"

Supported API: true

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter