wt.templateutil.processor
Class AbstractHTMLTemplateFactory

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

All Implemented Interfaces:

ApplicationContextChild, ContextHolder

Direct Known Subclasses:

DefaultHTMLTemplateFactory

public abstract class AbstractHTMLTemplateFactory

extends Object

implements ApplicationContextChild, ContextHolder

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. Parent class of the HTML Template Factories. This class provides the the basic methods and the basic services that an HTML Template Factory needs. This class implements the ContextHolder interface so that this service may be state driven. This class also implements the ApplicationContextChild interface so that a properties file may be used as a registry for the HTML Templates.

The getHTMLTemplate needs to be implemented by the concrete subclass.

Please see the Customizer's Guide or the HTML Template Factory HOWTO for more details of using this service

Supported API: true

Extendable: false

Field Summary

private ApplicationContext	applicationContext Deprecated.
private static String	CLASSNAME Deprecated.
private Vector	languagePreferences Deprecated.
private Locale	locale Deprecated.
private static String	RESOURCE Deprecated.
private String	serviceName Deprecated.
private HTTPState	theState Deprecated.
protected static boolean	VERBOSE Deprecated.

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

AbstractHTMLTemplateFactory()
Deprecated.

Method Summary

void	addToResponseExceptions(Exception newException) Deprecated. Adds a LocalizableMessage message to the list of stackTraces that can be presented with the Windchill Script call
void	addToResponseFooters(LocalizableMessage newFooter) Deprecated. Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call
void	addToResponseHeaders(LocalizableMessage newHeader) Deprecated. Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call
void	addToResponseMessages(LocalizableMessage newMessage) Deprecated. Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call
void	copyContextFrom(ContextHolder contextHolder) Deprecated.
ApplicationContext	getApplicationContext() Deprecated.
String	getContextAction() Deprecated.
String	getContextClassName() Deprecated.
Object	getContextObj() Deprecated.
Properties	getContextProperties() Deprecated.
Properties	getFormData() Deprecated.
abstract HTMLTemplate	getHTMLTemplate() Deprecated.
Vector	getLanguagePreferences() Deprecated.
Locale	getLocale() Deprecated.
Properties	getQueryData() Deprecated.
Vector	getResponseExceptions() Deprecated.
Vector	getResponseFooters() Deprecated.
Vector	getResponseHeaders() Deprecated.
Vector	getResponseMessages() Deprecated.
String	getResponseString() Deprecated.
String	getServiceName() Deprecated.
HTTPState	getState() Deprecated.
int	getStatus() Deprecated.
void	setApplicationContext(ApplicationContext a_ApplicationContext) Deprecated.
void	setContextAction(String a_ContextAction) Deprecated.
void	setContextClassName(String a_ContextClassName) Deprecated.
void	setContextObj(Object a_ContextObj) Deprecated.
void	setContextProperties(Properties a_ContextProperties) Deprecated.
void	setFormData(Properties a_FormData) Deprecated.
void	setLanguagePreferences(HTTPRequest request) Deprecated.
void	setLanguagePreferences(String languagePrefStr) Deprecated.
void	setLanguagePreferences(Vector a_LanguagePreferences) Deprecated.
void	setLocale(Locale a_Locale) 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	setServiceName(String a_ServiceName) Deprecated.
void	setState(HTTPState a_State) Deprecated.
void	setStatus(int a_Status) Deprecated.

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.

languagePreferences

private Vector languagePreferences

Deprecated.

serviceName

private String serviceName

Deprecated.

locale

private Locale locale

Deprecated.

theState

private HTTPState theState

Deprecated.

applicationContext

private ApplicationContext applicationContext

Deprecated.

VERBOSE

protected static boolean VERBOSE

Deprecated.

Constructor Detail

AbstractHTMLTemplateFactory

public AbstractHTMLTemplateFactory()
                            throws UnableToLoadServiceProperties

Deprecated.

Supported API: true

Throws:

UnableToLoadServiceProperties

Method Detail

getLanguagePreferences

public Vector getLanguagePreferences()

Deprecated.

Gets the value of the attribute: languagePreferences.

Supported API: true

Returns:

Vector

setLanguagePreferences

public void setLanguagePreferences(Vector a_LanguagePreferences)

Deprecated.

Sets the value of the attribute: languagePreferences.

Supported API: true

Parameters:

a_LanguagePreferences -

getServiceName

public String getServiceName()

Deprecated.

Gets the value of the attribute: serviceName.

Supported API: true

Returns:

String

setServiceName

public void setServiceName(String a_ServiceName)

Deprecated.

Sets the value of the attribute: serviceName.

Supported API: true

Parameters:

a_ServiceName -

getLocale

public Locale getLocale()

Deprecated.

Gets the value of the attribute: locale; The locale to use when retrieving localized resources.

Supported API: true

Returns:

Locale

setLocale

public void setLocale(Locale a_Locale)

Deprecated.

Sets the value of the attribute: locale; The locale to use when retrieving localized resources.

Supported API: true

Parameters:

a_Locale -

getState

public HTTPState getState()

Deprecated.

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

Supported API: false

Returns:

HTTPState

setState

public void setState(HTTPState a_State)

Deprecated.

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

Supported API: false

Parameters:

a_State -

getHTMLTemplate

public abstract HTMLTemplate getHTMLTemplate()
                                      throws WTException

Deprecated.

Selects an HTML Template based on the the current locale and the current HTTPState, i.e. the current "action" and the current "class". The class is based on the current context object, if any is set. If not context object is set, then the class is based on the value of the contextClassName attribute of the HTTPState object. If neither is set, the default value of java.lang.Object is used as the class.

This method must be overriden by a concrete subclass.

Supported API: true

Returns:

HTMLTemplate

Throws:

WTException

setLanguagePreferences

public void setLanguagePreferences(String languagePrefStr)

Deprecated.

Supported API: true

Parameters:

languagePrefStr -

setLanguagePreferences

public void setLanguagePreferences(HTTPRequest request)

Deprecated.

Supported API: true

Parameters:

request -

copyContextFrom

public void copyContextFrom(ContextHolder contextHolder)

Deprecated.

Copies the "context" from an implementor of the ContextHolder interface,like HTTPState, into the aggregated HTTPState object in this class.

Supported API: true

Parameters:

contextHolder -

getApplicationContext

public ApplicationContext getApplicationContext()

Deprecated.

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

Supported API: false

Specified by:

getApplicationContext in interface ApplicationContextChild

Returns:

ApplicationContext

setApplicationContext

public void setApplicationContext(ApplicationContext a_ApplicationContext)
                           throws WTPropertyVetoException

Deprecated.

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

Supported API: false

Specified by:

setApplicationContext in interface ApplicationContextChild

Parameters:

a_ApplicationContext -

Throws:

WTPropertyVetoException

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 -

addToResponseExceptions

public void addToResponseExceptions(Exception newException)

Deprecated.

Description copied from interface: ContextHolder

Adds a LocalizableMessage message to the list of stackTraces that can be presented with the Windchill Script call

showResponseExceptions

Supported API: true

Specified by:

addToResponseExceptions in interface ContextHolder

Parameters:

newException -

addToResponseMessages

public void addToResponseMessages(LocalizableMessage newMessage)

Deprecated.

Description copied from interface: ContextHolder

Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

showResponseMessages

Supported API: true

Specified by:

addToResponseMessages in interface ContextHolder

Parameters:

newMessage -

addToResponseHeaders

public void addToResponseHeaders(LocalizableMessage newHeader)

Deprecated.

Description copied from interface: ContextHolder

Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

showResponseHeaders

Supported API: true

Specified by:

addToResponseHeaders in interface ContextHolder

Parameters:

newHeader -

addToResponseFooters

public void addToResponseFooters(LocalizableMessage newFooter)

Deprecated.

Description copied from interface: ContextHolder

Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

showResponseFooters

Supported API: true

Specified by:

addToResponseFooters in interface ContextHolder

Parameters:

newFooter -