wt.templateutil.processor
Class NewHelpDirectoryGenerator

java.lang.Object
  wt.templateutil.processor.NewHelpDirectoryGenerator

All Implemented Interfaces:

HelpDirectoryGenerator

Deprecated.

public class NewHelpDirectoryGenerator
extends Object
implements HelpDirectoryGenerator

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. Generates relative directories based on the Windchill R5.0 convention for localizing the path to an HTML Online Help page. This convention is the following :

Given the locale neutral base path,

/wt/helpfiles/help/Search/

the localization is performed on the subdirectory help. For example, if the locale is _en_US, then the localized directory would be

/wt/helpfiles/help_en_US/Search/

Supported API: true

Extendable: false

Method Summary

String	getCandidateDirectory(String localeString, String relativeFilePath) Deprecated.
String	getCandidateRelativePath(String localeString, String relativeFilePath) Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

getCandidateDirectory

public String getCandidateDirectory(String localeString,
                                    String relativeFilePath)

Deprecated.

Returns a Full path that is a localized, candidate path. The Full path is generated from the value of wt.home, the relative path, and the locale.

Supported API: true

Specified by:

getCandidateDirectory in interface HelpDirectoryGenerator

Parameters:

localeString -

relativeFilePath -

Returns:

String

getCandidateRelativePath

public String getCandidateRelativePath(String localeString,
                                       String relativeFilePath)

Deprecated.

Returns a relative path that is a localized, candidate path from codebase to the help directory. The relative path is based on the value of the relative path passed in and the locale that is passed in.

Supported API: true

Specified by:

getCandidateRelativePath in interface HelpDirectoryGenerator

Parameters:

localeString -

relativeFilePath -

Returns:

String