com.ptc.windchill.cadx.common
Class HelpGenerationProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          com.ptc.windchill.cadx.common.HelpGenerationProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

Direct Known Subclasses:

JSTableProcessor

public class HelpGenerationProcessor

extends DefaultTemplateProcessor

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

static String	ADD_HELP_ICON
private static String	CLASSNAME
static String	DEFAULT_HELP_LABEL_KEY
static String	DEFAULT_HELP_LABEL_RESOURCE
private static String	defaultCSS
static long	EXTERNALIZATION_VERSION_UID
static String	HELP_CONTEXT
static String	HELP_ICON_FILE
static String	HELP_LABEL
static String	HELP_LABEL_RESOURCE
protected static long	OLD_FORMAT_VERSION_UID
static String	PRESENT_HELP_LABEL
static String	PROJECT_LINK_HELP_CONTEXT_SUFFIX
private static String	RESOURCE
(package private) static long	serialVersionUID
private HTTPState	state
protected static boolean	VERBOSE
private static String	visCreateDialogJavascript

Fields inherited from class wt.templateutil.processor.DefaultTemplateProcessor

ACTION, CLASS, CODEBASE, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR, OID

Fields inherited from class wt.enterprise.BasicTemplateProcessor

ALL_CABINETS, BLANK_SPACE, BREAK_SEPARATOR, BREAK_TAG, componentFactory, CONTAINER_NAME, CONTENT_RESOURCE, contextClass, DEFAULT_CHARSET, DEFAULT_HELP_ICON_SELECTOR, DEFAULT_HELP_LABEL, DEFAULT_PREFERENCE_CONTEXT, DOCFROMTEMPLATE, ENABLE_HELP_ICON_PROPERTY_NAME, ENTERPRISE_SEARCH, FEDERATION_SEARCH, GLOBAL_NAVIGATION_ENABLE_HELP_ICON, globalNavBarHelpIconEnabledDefault, HELP_ICON_POSITION, HELP_ICON_SELECTOR, HELP_WINDOW_NAME, helpContext, helpIconEnabled, helpIconEnabledDefault, HOMEPAGE, IDPREFIX, IMPORT, INTEGRATED_SEARCH, isDndMicroAppletEnabled, isDndMicroAppletEnabledInitialized, LABEL_SEPARATOR, linkPrefix, LOCAL_SEARCH, pageContext, PDMLINK_INSTALL_KEY, PERSONAL_CABINET, PREF_WINDOW_NAME, PREFERENCE_CONTEXT, PROJECTLINK_INSTALL_KEY, SEARCH, SHARE_ICON, TEXT_RESOURCE_BUNDLE, URL_RESOURCE, WORKLIST, wtAttribute, WTCORE_IMAGE_DIR

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

Constructor Summary

HelpGenerationProcessor()

Method Summary

void	getButton(Properties parameters, Locale locale, OutputStream os) Supported API: false
void	getHelpButton(Properties parameters, Locale locale, OutputStream os) Deprecated.
protected String	getHelpContext(Properties props)
static String	getHelpURL(String helpContext, HTTPState state, Locale locale) Generates a fully qualified URL to a help page Supported API: false
protected static String	getHTMLHelpPagePath(String helpContext, HelpHTMLTemplateFactory templateFactory, HTTPState state) Returns HTML Help Page Path based on solution/server/CADX integrated on the server.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(HelpGenerationProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class wt.templateutil.processor.DefaultTemplateProcessor

addHiddenProperty, addToFeedbackCookie, addToFeedbackCookie, getContextPropertyValue, getCurrentUrl, getFeedbackCookieExceptions, getFeedbackCookieMessages, getHtmlTemplateFactory, getMessageSeparator, getPAGE_EXPIRATION, getPageExpirationResource, getTemplate, getTemplateDisplay, handleRequest, hiddenContextString, readVersion, setContextPropertyValue, setHtmlTemplateFactory, setMethodContextProperty, setNameProcessor, setPAGE_EXPIRATION, setPageExpirationResource, writeHiddenContext, writeQueryStringContext

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, addHTMLHelpLink, addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, allVersions, bcwti, buildFormProcessorURL, buildFormProcessorURL, comment, createActionsBar, createFederationNavigationBar, createGlobalNavigationBar, createNavigationBar, createParentFolderLink, currentTimestamp, displayAllCabinets, displayAttributeName, displayAttributesTable, displayAttributeValue, displayFolderContents, displayFolderObject, displayFolderTrail, displayGoToLatestLink, displayOrganizationIdentifier, displayPendingChangeIndicator, displayStyleSheetAttributesTable, displayVisualData, formatDate, getActionPairs, getAllCabinetsURL, getBaselineItems, getCharsetEncoding, getCheckedOutFolderURL, getClassIcon, getClassInfo, getContextAction, getContextClass, getContextClassName, getContextListIn, getContextListOut, getContextObj, getContextProperties, getContextServiceName, getDisplayName, getDomainPath, getEnabledVersion, getEncoding, getFederationSearchURL, getFolderLocation, getFolderPath, getFormData, getGenericInstanceIconImgTag, getGlyphImageTag, getGlyphsArray, getGlyphTagsNoDnD, getHelpContext, getHomepageURL, getHTMLComponentFactory, getHTMLHelpLink, getHTMLHelpURL, getHTMLHelpURL, getHTMLTableService, getIconResource, getIconResource, getIconResource, getIconSelector, getId, getJavaScriptManager, getLocalizedDateFormatMessage, getLocalizedMessage, getLocalizedPrintWriter, getLocalizedString, getObjectDnDIcon, getObjectIcon, getObjectIconDnDTag, getObjectIconGlyphs, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectPropertyValueString, getObjectPropertyValueString, getPageContext, getParentFolderLink, getPersonalCabinet, getPersonalCabinetURL, getPreferenceValue, getPrincipalEmailLink, getPrincipalEmailLink, getPrintWriter, getPropertyFromPropertyFile, getQuery, getQueryData, getReferenceString, getReferenceString, getResourceString, getResourceString, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getResponseString, getSearchCriteriaURL, getSearchCriteriaURL, getSearchResultsURL, getShareImage, getShareImage, getState, getStatus, getStringFromResourceBundle, getStringFromResourceBundle, getTemplateDisplayGeneral, getTrailId, getTrlIdAttribute, getURLActions, getURLActions, getURLActions, getURLActions, getURLActionsString, getURLActionsString, getURLFactory, getURLFromDelegate, getURLProcessorLink, getURLProcessorLink, getURLProcessorLink, getURLProcessorLinkWithLabel, getUsedByLinks, getWCColor, getWCColor, getWCColorDec, getWCColorDec, getWCFontFamily, getWCFontFamily, getWorklistURL, getWTAttribute, getWTContainerByName, getWTContainerRef, handleExceptionTP, handleExceptionTP, handleProcessorException, include, initJavaScriptManager, isDndMicroAppletEnabled, isEqual, listContent, objectActionLink, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectBackground, objectIdentification, objectIdentifier, objectProperties, objectPropertyName, objectPropertyNameAux, objectPropertyNameAux2, objectPropertyValue, objectPropertyValueAux, objectPropertyValueAux2, objectPropertyValueString, outputLink, outputPropertyFromPropertyFile, parameterValue, partUsedBy, PDMLinkIsInstalled, printQueryTable, printTable, printTextArea, processSubTemplate, readContext, readVersion, setColumnProperties, setContextAction, setContextClass, setContextClassName, setContextListIn, setContextListOut, setContextObj, setContextProperties, setFormData, setHelpContext, setHTMLTableService, setJavaScriptManager, setPageContext, setQueryData, setResponseExceptions, setResponseFooters, setResponseHeaders, setResponseMessages, setResponseString, setState, setStatus, showResponseExceptions, showResponseFooters, showResponseHeaders, showResponseMessage, showResponseMessages, showVersions, sortQueryResult, splitStringIntoTokens, tableService, translateToHtml, useProcessorService, visualizationIsEnabled

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

defaultCSS

private static String defaultCSS

state

private HTTPState state

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

VERBOSE

protected static boolean VERBOSE

HELP_CONTEXT

public static final String HELP_CONTEXT

See Also:

Constant Field Values

HELP_LABEL

public static final String HELP_LABEL

See Also:

Constant Field Values

HELP_LABEL_RESOURCE

public static final String HELP_LABEL_RESOURCE

See Also:

Constant Field Values

PRESENT_HELP_LABEL

public static final String PRESENT_HELP_LABEL

See Also:

Constant Field Values

ADD_HELP_ICON

public static final String ADD_HELP_ICON

See Also:

Constant Field Values

DEFAULT_HELP_LABEL_KEY

public static final String DEFAULT_HELP_LABEL_KEY

See Also:

Constant Field Values

DEFAULT_HELP_LABEL_RESOURCE

public static final String DEFAULT_HELP_LABEL_RESOURCE

See Also:

Constant Field Values

HELP_ICON_FILE

public static final String HELP_ICON_FILE

See Also:

Constant Field Values

PROJECT_LINK_HELP_CONTEXT_SUFFIX

public static final String PROJECT_LINK_HELP_CONTEXT_SUFFIX

See Also:

Constant Field Values

visCreateDialogJavascript

private static String visCreateDialogJavascript

Constructor Detail

HelpGenerationProcessor

public HelpGenerationProcessor()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class DefaultTemplateProcessor

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class DefaultTemplateProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(HelpGenerationProcessor thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getHelpButton

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

Deprecated.

Outputs a help button

Supported API: false

Parameters:

parameters - name/value pairs passed via the script call.

• The name "HelpContext" should be used to pass the context key that is used to locate the help page. Optional. If not specified, the current context action will be used.
• The name "PresentHelpLabel" should be used to specify whether the button has text. true/false. Optional. Default is true.
• The name "HelpLabelResource" should be used to pass pathname of the text resource bundle if PresentHelpLabel is true. Optional. If not specified, "com.ptc.core.HTMLtemplateutil.server.processors.processorsResource" will be used.
• The name "HelpLabel" should be used to pass the key for the text in the resource bundle. Optional. If not specified, "HELP" will be used.
• The name "HelpIconFile" should be used to name of the icon file if an icon is desired in the button. Optional. The image is assumed to reside in the directory identified by the wt.property "solutions.images.directory." Ex: HelpIconFile=help.gif
  locale -
  os -
  Throws:
  WTException

getHelpURL

public static String getHelpURL(String helpContext,
                                HTTPState state,
                                Locale locale)
                         throws WTException

Generates a fully qualified URL to a help page

Supported API: false

Parameters:

helpContext -

state -

locale -

Returns:

String

Throws:

WTException

getButton

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

Supported API: false

Parameters:

parameters - name/value pairs passed by the script call

• The name "resourceClass" should be used to pass the resource bundle class for the label. Optional. E.g., resourceClass=wt.part.partResource.
• The name "resourceKey" should be used to pass the key within the bundle for the label string Optional. E.g., resourceKey=GENERATE_REPORT_BUTTON_LABEL
• The name "buttonImg" should be used to pass the name of an image to use for the link. Optional. The image is assumed to reside in the solutions image directory identified by the wt.property "solutions.images.directory." E.g., buttonImg=iconDocGear.gif
• The name "buttonGWMethod" should be used to pass the name of the URLProcessor method that should be used in the link URL. Optional. This will likely be either "URLTemplateAction", "generateForm", or "processForm". Optional. If not specified, "URLTemplateAction" will be used.
• The name "buttonAction" should be used to pass the name of the action to be inserted into the query string of the URL. Optional. If not specified, "ObjProps" will be used. Ex: buttonAction=CreatePart
• The name "buttonOID" should be used to pass the oid of the object to be inserted into the query string of the URL. Optional. If not specified, the current context object will be used.
• The name "buttonClass" should be used to pass the object class to be inserted into the query string of the URL. Optional. Ex: buttonClass=wt.doc.WTDocument
• The name "buttonURL" should be used to pass the fully qualified URL for the button link. Optional.
• The name "buttonLinkTarget" should be used to pass the target for the button link. Optional. E.g., buttonLinkTarget=CreateWindow
• The name "buttonLinkEvent" should be used to pass an event for which the button link should listen. Optional. E.g., buttonLinkEvent=onClick
• The name "buttonLinkEventHandler" should be used to pass the method that to be called for the event passed in buttonLinkEvent. Required if buttonLinkEvent is specified. E.g., buttonLinkEventHandler=submitForm (where submitForm is the name of a javascript method)

If buttonURL is not specified, the URL will be constructed from buttonGWMethod, buttonAction, and buttonClass or buttonOID, using the default values for those parameters if not specified.

getHelpContext

protected String getHelpContext(Properties props)

getHTMLHelpPagePath

protected static String getHTMLHelpPagePath(String helpContext,
                                            HelpHTMLTemplateFactory templateFactory,
                                            HTTPState state)
                                     throws WTException

Returns HTML Help Page Path based on solution/server/CADX integrated on the server.

Currently Project Link with any server (i.e., Classic, PDMLink) and CADX is supported.

If Project Link is installed then an attempt is made to get the help page path using help context with a PJPROJECT_LINK_HELP_CONTEXT_SUFFIX. If it is found then it's help page path is returned. If Project Link is not installed or a path using help context with a PROJECT_LINK_HELP_CONTEXT_SUFFIX is not found then an attempt is made to get the help page path using helpContext.

Throws:

WTException