wt.templateutil.processor
Class DefaultHTMLTemplateFactory

java.lang.Object
  wt.templateutil.processor.AbstractHTMLTemplateFactory
      wt.templateutil.processor.DefaultHTMLTemplateFactory

All Implemented Interfaces:

ApplicationContextChild, ContextHolder, TemplateNameProcessor

Direct Known Subclasses:

HelpHTMLTemplateFactory

public class DefaultHTMLTemplateFactory

extends AbstractHTMLTemplateFactory

implements TemplateNameProcessor

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: false

Field Summary

private static String	CLASSNAME Deprecated.
protected static String	CODEBASE Deprecated.
private TemplateNameProcessor	nameProcessor Deprecated.
protected char	newFileSeparator Deprecated.
protected char	oldFileSeparator Deprecated.
private static String	RESOURCE Deprecated.
protected static boolean	VERBOSE Deprecated.

Fields inherited from class wt.templateutil.processor.AbstractHTMLTemplateFactory

Fields inherited from interface wt.services.applicationcontext.ApplicationContextChild

APPLICATION_CONTEXT

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

DefaultHTMLTemplateFactory()
Deprecated.

Method Summary

HTMLTemplate	getHTMLTemplate() Deprecated. Returns a localized instance of an HTMLTemplate object based on an entry in a *.properties file that was selected based on the locale, the service name, and the action/class pair.
TemplateNameProcessor	getNameProcessor() Deprecated. Gets the object for the association that plays role: nameProcessor.
String	processTemplateName(String templateFileName) Deprecated.
void	setNameProcessor(TemplateNameProcessor a_NameProcessor) Deprecated. Sets the object for the association that plays role: nameProcessor.

Methods inherited from class wt.templateutil.processor.AbstractHTMLTemplateFactory

addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, copyContextFrom, getApplicationContext, getContextAction, getContextClassName, getContextObj, getContextProperties, getFormData, getLanguagePreferences, getLocale, getQueryData, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getResponseString, getServiceName, getState, getStatus, setApplicationContext, setContextAction, setContextClassName, setContextObj, setContextProperties, setFormData, setLanguagePreferences, setLanguagePreferences, setLanguagePreferences, setLocale, setQueryData, setResponseExceptions, setResponseFooters, setResponseHeaders, setResponseMessages, setResponseString, setServiceName, setState, setStatus

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.

nameProcessor

private TemplateNameProcessor nameProcessor

Deprecated.

CODEBASE

protected static String CODEBASE

Deprecated.

VERBOSE

protected static boolean VERBOSE

Deprecated.

oldFileSeparator

protected char oldFileSeparator

Deprecated.

newFileSeparator

protected char newFileSeparator

Deprecated.

Constructor Detail

DefaultHTMLTemplateFactory

public DefaultHTMLTemplateFactory()
                           throws UnableToLoadServiceProperties

Deprecated.

Supported API: true

Throws:

UnableToLoadServiceProperties

Method Detail

getNameProcessor

public TemplateNameProcessor getNameProcessor()

Deprecated.

Gets the object for the association that plays role: nameProcessor.

This instance of TemplateNameProcessor is used to process/manipulate the String returned from the *.properties file before the String is used by the HTMLTemplate object to find the template.

Lazy initialization is used here. DefaultHTMLTemplateFactory implements the TemplateNameProcessor interface. If no instance of a TemplateNameProcessor is is set, a reference to the current instance of the DefaultHTMLTemplateFactory is returned.

Supported API: false

Returns:

TemplateNameProcessor

setNameProcessor

public void setNameProcessor(TemplateNameProcessor a_NameProcessor)

Deprecated.

Sets the object for the association that plays role: nameProcessor.

Set the instance of the TemplateNameProcessor that will be used to process the String returned from the *.properties file.

Supported API: true

Parameters:

a_NameProcessor -

getHTMLTemplate

public HTMLTemplate getHTMLTemplate()
                             throws WTException

Deprecated.

Returns a localized instance of an HTMLTemplate object based on an entry in a *.properties file that was selected based on the locale, the service name, and the action/class pair.

Supported API: true

Specified by:

getHTMLTemplate in class AbstractHTMLTemplateFactory

Returns:

wt.htmlutil.HTMLTemplate

Throws:

WTException

processTemplateName

public String processTemplateName(String templateFileName)

Deprecated.

Supported API: true

Specified by:

processTemplateName in interface TemplateNameProcessor

Parameters:

templateFileName -

Returns:

String