wt.clients.library
Class LibraryProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.clients.library.LibraryProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class LibraryProcessor

extends DefaultTemplateProcessor

Processor for the Library page.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

static String[]	adminHTMLPathKeys
static String[]	adminPDFPathKeys
static String[]	adminTitleKeys
static String[]	customizationHTMLPathKeys
static String[]	customizationPDFPathKeys
static String[]	customizationTitleKeys
private static boolean	docInst
static String[]	engFactorAdminHTMLPathKeys
static String[]	engFactorAdminPDFPathKeys
static String[]	engFactorAdminTitleKeys
static String[]	engFactorUseHTMLPathKeys
static String[]	engFactorUsePDFPathKeys
static String[]	engFactorUseTitleKeys
private static boolean	gwCoCreateInst
private static boolean	IEDocInst
private static boolean	optGatewayInst
private static boolean	PFInst
static String[]	productionFactorHTMLPathKeys
static String[]	productionFactorPDFPathKeys
static String[]	productionFactorTitleKeys
private static boolean	proIGatewayInst
private static String	RESOURCE
static String[]	sectionTitleKeys
private static boolean	showWGMCustomizationGuide
static String[]	sourcingFactorHTMLPathKeys
static String[]	sourcingFactorPDFPathKeys
static String[]	sourcingFactorTitleKeys
private URLFactory	urlFactory
static String[]	userHTMLPathKeys
static String[]	userPDFPathKeys
static String[]	userTitleKeys
private static boolean	VERBOSE
private static boolean	WEFAdminInst
private static boolean	WEFUseInst
private static boolean	wgmAutoCADInst
private static boolean	wgmCADAMInst
private static boolean	wgmCADDSInst
private static boolean	wgmCadenceInst
private static boolean	wgmCatia5Inst
private static boolean	wgmCatiaInst
private static boolean	wgmHelixInst
private static boolean	wgmI3Inst
private static boolean	wgmIDEASInst
private static boolean	wgmInventorInst
private static boolean	wgmMentorInst
private static boolean	wgmProEInst
private static boolean	wgmSolidWorksInst
private static boolean	wgmUGInst
private static boolean	WSFInst

Fields inherited from class wt.templateutil.processor.DefaultTemplateProcessor

ACTION, CLASS, CODEBASE, EXTERNALIZATION_VERSION_UID, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR, OID, OLD_FORMAT_VERSION_UID

Fields inherited from class wt.enterprise.BasicTemplateProcessor

ADD_HELP_ICON, 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_CONTEXT, HELP_ICON_POSITION, HELP_ICON_SELECTOR, HELP_LABEL, HELP_LABEL_RESOURCE, 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, PRESENT_HELP_LABEL, 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

LibraryProcessor()

Method Summary

void	closePage(Properties parameters, Locale locale, OutputStream os) Flush page
void	displayAdminDoc(Properties parameters, Locale locale, OutputStream os) Displays Windchill Administration Documentation
void	displayBlankRow(PrintWriter out) Displays blank row in table
void	displayCustomizationDoc(Properties parameters, Locale locale, OutputStream os) Displays Windchill Customization Documentation
void	displayDoc(PrintWriter out, String titleKey, String PDFPathKey, String HTMLPathKey, Locale locale) Displays one document
void	displayDoc2(PrintWriter out, String title, String translatedTitle, String pdfPath, String htmlPath) Displays title and link(s) of one manual
void	displayDocSection(PrintWriter out, int nManuals, String[] titleKeys, String[] PDFPathKeys, String[] HTMLPathKeys, Locale locale) Displays the manuals of one documentation section
void	displayEFAdminDoc(Properties parameters, Locale locale, OutputStream os) Displays Windchill Engineering Factor Admin Documentation
void	displayEFUseDoc(Properties parameters, Locale locale, OutputStream os) Displays Windchill Engineering Factor Use Documentation
void	displayHeader(PrintWriter out, String header) Displays the header for a section
void	displayNavigationLinks(Properties parameters, Locale locale, OutputStream os) Displays navigation links row
void	displayPFDoc(Properties parameters, Locale locale, OutputStream os) Displays Windchill Prouction Factor Documentation
void	displaySFDoc(Properties parameters, Locale locale, OutputStream os) Displays Windchill Sourcing Factor Documentation
void	displayUserDoc(Properties parameters, Locale locale, OutputStream os) Displays Windchill User Documentation
void	getLibraryHeader(Properties parameters, Locale locale, OutputStream os) Prints the title for the page
void	initializeLibrary(Properties parameters, Locale locale, OutputStream os) Initializes variables
String	italizeFactor(String text) Italicizes "Factor!" if present in a string
void	notInstalled(Properties parameters, Locale locale, OutputStream os) Display Not Installed Message

Methods inherited from class wt.templateutil.processor.DefaultTemplateProcessor

addHiddenProperty, addToFeedbackCookie, addToFeedbackCookie, getContextPropertyValue, getCurrentUrl, getFeedbackCookieExceptions, getFeedbackCookieMessages, getHtmlTemplateFactory, getMessageSeparator, getPAGE_EXPIRATION, getPageExpirationResource, getTemplate, getTemplateDisplay, handleRequest, hiddenContextString, readExternal, readVersion, setContextPropertyValue, setHtmlTemplateFactory, setMethodContextProperty, setNameProcessor, setPAGE_EXPIRATION, setPageExpirationResource, writeExternal, 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

VERBOSE

private static boolean VERBOSE

docInst

private static boolean docInst

WSFInst

private static boolean WSFInst

WEFUseInst

private static boolean WEFUseInst

WEFAdminInst

private static boolean WEFAdminInst

IEDocInst

private static boolean IEDocInst

PFInst

private static boolean PFInst

wgmI3Inst

private static boolean wgmI3Inst

wgmProEInst

private static boolean wgmProEInst

wgmCatiaInst

private static boolean wgmCatiaInst

wgmCatia5Inst

private static boolean wgmCatia5Inst

wgmCADDSInst

private static boolean wgmCADDSInst

wgmHelixInst

private static boolean wgmHelixInst

wgmAutoCADInst

private static boolean wgmAutoCADInst

wgmCADAMInst

private static boolean wgmCADAMInst

wgmUGInst

private static boolean wgmUGInst

wgmIDEASInst

private static boolean wgmIDEASInst

wgmMentorInst

private static boolean wgmMentorInst

wgmSolidWorksInst

private static boolean wgmSolidWorksInst

wgmCadenceInst

private static boolean wgmCadenceInst

gwCoCreateInst

private static boolean gwCoCreateInst

wgmInventorInst

private static boolean wgmInventorInst

optGatewayInst

private static boolean optGatewayInst

proIGatewayInst

private static boolean proIGatewayInst

showWGMCustomizationGuide

private static boolean showWGMCustomizationGuide

urlFactory

private URLFactory urlFactory

sectionTitleKeys

public static final String[] sectionTitleKeys

userTitleKeys

public static final String[] userTitleKeys

adminTitleKeys

public static final String[] adminTitleKeys

customizationTitleKeys

public static final String[] customizationTitleKeys

productionFactorTitleKeys

public static final String[] productionFactorTitleKeys

sourcingFactorTitleKeys

public static final String[] sourcingFactorTitleKeys

engFactorAdminTitleKeys

public static final String[] engFactorAdminTitleKeys

engFactorUseTitleKeys

public static final String[] engFactorUseTitleKeys

userPDFPathKeys

public static final String[] userPDFPathKeys

adminPDFPathKeys

public static final String[] adminPDFPathKeys

customizationPDFPathKeys

public static final String[] customizationPDFPathKeys

productionFactorPDFPathKeys

public static final String[] productionFactorPDFPathKeys

sourcingFactorPDFPathKeys

public static final String[] sourcingFactorPDFPathKeys

engFactorUsePDFPathKeys

public static final String[] engFactorUsePDFPathKeys

engFactorAdminPDFPathKeys

public static final String[] engFactorAdminPDFPathKeys

userHTMLPathKeys

public static final String[] userHTMLPathKeys

adminHTMLPathKeys

public static final String[] adminHTMLPathKeys

customizationHTMLPathKeys

public static final String[] customizationHTMLPathKeys

productionFactorHTMLPathKeys

public static final String[] productionFactorHTMLPathKeys

sourcingFactorHTMLPathKeys

public static final String[] sourcingFactorHTMLPathKeys

engFactorUseHTMLPathKeys

public static final String[] engFactorUseHTMLPathKeys

engFactorAdminHTMLPathKeys

public static final String[] engFactorAdminHTMLPathKeys

Constructor Detail

LibraryProcessor

public LibraryProcessor()

Method Detail

initializeLibrary

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

Initializes variables

closePage

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

Flush page

getLibraryHeader

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

Prints the title for the page

displayBlankRow

public void displayBlankRow(PrintWriter out)

Displays blank row in table

displayNavigationLinks

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

Displays navigation links row

italizeFactor

public String italizeFactor(String text)

Italicizes "Factor!" if present in a string

displayHeader

public void displayHeader(PrintWriter out,
                          String header)

Displays the header for a section

displayDoc2

public void displayDoc2(PrintWriter out,
                        String title,
                        String translatedTitle,
                        String pdfPath,
                        String htmlPath)

Displays title and link(s) of one manual

displayDocSection

public void displayDocSection(PrintWriter out,
                              int nManuals,
                              String[] titleKeys,
                              String[] PDFPathKeys,
                              String[] HTMLPathKeys,
                              Locale locale)

Displays the manuals of one documentation section

displayDoc

public void displayDoc(PrintWriter out,
                       String titleKey,
                       String PDFPathKey,
                       String HTMLPathKey,
                       Locale locale)

Displays one document

notInstalled

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

Display Not Installed Message

displayAdminDoc

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

Displays Windchill Administration Documentation

displayUserDoc

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

Displays Windchill User Documentation

displayCustomizationDoc

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

Displays Windchill Customization Documentation

displayPFDoc

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

Displays Windchill Prouction Factor Documentation

displayEFUseDoc

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

Displays Windchill Engineering Factor Use Documentation

displayEFAdminDoc

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

Displays Windchill Engineering Factor Admin Documentation

displaySFDoc

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

Displays Windchill Sourcing Factor Documentation