wt.templateutil.processor
Class TutorialTemplateFactory

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

All Implemented Interfaces:

ApplicationContextChild, ContextHolder, Serializable, TemplateNameProcessor

public class TutorialTemplateFactory

extends HelpHTMLTemplateFactory

implements Serializable

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private static String	RESOURCE
private static boolean	VERBOSE

Fields inherited from class wt.templateutil.processor.HelpHTMLTemplateFactory

PDM_HELP_HOME

Fields inherited from class wt.templateutil.processor.DefaultHTMLTemplateFactory

CODEBASE, newFileSeparator, oldFileSeparator

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

TutorialTemplateFactory()
Deprecated.

Method Summary

boolean	getHelpDirectory(String localeString, HelpDirectoryGenerator directoryGenerator) Returns a valid, localized directory based on The locale passed in The relative path read in from the entry in the property file The instance of HelpDirectoryGenerator.
String	getHelpLink() Uses the currently selected, localized relative directory and the file name to see is an HTML file with that path and name exists.
protected LocalizedResource	newLocalizedResource(String resourceName, String[] alternateExtensions) Returns a new initialized wt.util.LocalizedResource for use in the getHelpLink() method.

Methods inherited from class wt.templateutil.processor.HelpHTMLTemplateFactory

getDirectoryCache, getFileKey, getFileName, getHELP_HOME, getHTMLHelpPagePath, getRelativeFilePath, getRelativeURL, getTrueFilePath, getWt_home, initFileInfo, initLocale, isVERBOSE, main, setDirectoryCache, setFileKey, setFileName, setHELP_HOME, setRelativeFilePath, setRelativeURL, setTrueFilePath, setVERBOSE, setWt_home

Methods inherited from class wt.templateutil.processor.DefaultHTMLTemplateFactory

getHTMLTemplate, getNameProcessor, processTemplateName, setNameProcessor

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

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

VERBOSE

private static boolean VERBOSE

Constructor Detail

TutorialTemplateFactory

public TutorialTemplateFactory()
                        throws UnableToLoadServiceProperties

Deprecated.

Initializes the service name to "wt.templateutil.processor.TutorialTemplate".

Supported API: true

Throws:

UnableToLoadServiceProperties

Method Detail

newLocalizedResource

protected LocalizedResource newLocalizedResource(String resourceName,
                                                 String[] alternateExtensions)
                                          throws WTException

Returns a new initialized wt.util.LocalizedResource for use in the getHelpLink() method.

Supported API: false

Overrides:

newLocalizedResource in class HelpHTMLTemplateFactory

Parameters:

resourceName -

alternateExtensions -

Returns:

LocalizedResource

Throws:

WTException

getHelpLink

public String getHelpLink()

Description copied from class: HelpHTMLTemplateFactory

Uses the currently selected, localized relative directory and the file name to see is an HTML file with that path and name exists. If one exists, a String representing the relative path and name of that HMTL file is returned.

If there is not an HTML file matching that relative file path and file name, a WTException is thrown.

Supported API: true

Overrides:

getHelpLink in class HelpHTMLTemplateFactory

Returns:

String

getHelpDirectory

public boolean getHelpDirectory(String localeString,
                                HelpDirectoryGenerator directoryGenerator)

Description copied from class: HelpHTMLTemplateFactory

Returns a valid, localized directory based on

• The locale passed in
• The relative path read in from the entry in the property file
• The instance of HelpDirectoryGenerator. Currently there is an R4.0 and an R5.0 generator

Based on the HelpDirectoryGenerator used, the locale passed in and the relative file path are combined to give a localized directory.

If there is not a directory corresponding the locale passed in, the locale is reduced until a directory is found. If after reducing the locale no directory is found, the default localized directory is a directory localized to _en_US.

Supported API: true

Overrides:

getHelpDirectory in class HelpHTMLTemplateFactory

Parameters:

localeString -

directoryGenerator -

Returns:

boolean