wt.content
Class ObjectContentProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.content.ObjectContentProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class ObjectContentProcessor

extends BasicTemplateProcessor

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. This class provides support for generating the HTML page to display the contents of a ContentHolder object.

Supported API: false

Extendable: false

See Also:

"'Customizing the HTML Client' in 'Customizer's Guide'", BasicTemplateProcessor, ContentHolder, Serialized Form

Field Summary

private static String	CODEBASE Deprecated.
private Object	contextObj Deprecated.
private String	pOid Deprecated.
private static String	RESOURCE Deprecated.
private static boolean	VERBOSE Deprecated.

Fields inherited from class wt.enterprise.BasicTemplateProcessor

ACTION, ADD_HELP_ICON, ALL_CABINETS, BLANK_SPACE, BREAK_SEPARATOR, BREAK_TAG, CLASS, 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, EXTERNALIZATION_VERSION_UID, 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, LINE_FEED_DELIMITER, linkPrefix, LOCAL_SEARCH, OID, OLD_FORMAT_VERSION_UID, 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

ObjectContentProcessor()
Deprecated. A no argument constructor with no side effects.

Method Summary

Object	getContextObj() Deprecated. Returns the object providing the context for this template.
String	getObjectOid() Deprecated. Returns a String representation of the Object ID of the object providing the context for this processor.
HTMLTemplate	getTemplate(Vector preferences) Deprecated. Return an initialized HTMLTemplate for displaying the content of an object.
void	handleRequest(HTTPRequest req, HTTPResponse resp) Deprecated. This method handles HTTP GET requests to produce and HTML page which describes properties of the contextual object of aObjectPropertiesProcessor instance.
void	setContextObj(Object context) Deprecated. Sets the object which provides the context for this processor.
void	setObjectOid(String oid) Deprecated. Sets the object ID of the object providing the context for this processor.

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, addHiddenProperty, 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, 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, hiddenContextString, 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, readExternal, readVersion, setColumnProperties, setContextAction, setContextClass, setContextClassName, setContextListIn, setContextListOut, 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, writeExternal, writeHiddenContext, writeQueryStringContext

Methods inherited from class java.lang.Object

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

Field Detail

contextObj

private Object contextObj

Deprecated.

pOid

private String pOid

Deprecated.

CODEBASE

private static String CODEBASE

Deprecated.

VERBOSE

private static boolean VERBOSE

Deprecated.

RESOURCE

private static final String RESOURCE

Deprecated.

See Also:

Constant Field Values

Constructor Detail

ObjectContentProcessor

public ObjectContentProcessor()

Deprecated.

A no argument constructor with no side effects.

Method Detail

handleRequest

public void handleRequest(HTTPRequest req,
                          HTTPResponse resp)
                   throws WTException

Deprecated.

This method handles HTTP GET requests to produce and HTML page which describes properties of the contextual object of aObjectPropertiesProcessor instance.

It is expected that this method will be called via an objectActionLink (defined by the URLProcessor class) by script call within an HTML file.

The format of the HTML that is output is determined by an HTML template file. The template that is used is chosen from the templates directory based on the class of the contextual object, the locale and the parameters passed to the objectProperties call Currently the template file is chosen from the ObjectProperties directory. Within that directory the template is chosen on the basis of:

   1. the class name of the context object
   2. the wt.enterprise super class of the context object
   3. the default template
 

Watch this space for more information regarding the determination of template files.

Parameters:

req - HTTPRequest

resp - HTTPResponse

Throws:

WTException

See Also:

URLProcessor

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Deprecated.

Return an initialized HTMLTemplate for displaying the content of an object.

Parameters:

preferences - a Vector of language preferences

Returns:

an initialized HTMLTemplate

Throws:

WTException - if an error occurs initializing the template

getContextObj

public Object getContextObj()

Deprecated.

Returns the object providing the context for this template.

Specified by:

getContextObj in interface ContextHolder

Overrides:

getContextObj in class BasicTemplateProcessor

Returns:

the context Object for this template

setContextObj

public void setContextObj(Object context)

Deprecated.

Sets the object which provides the context for this processor.

Specified by:

setContextObj in interface ContextHolder

Overrides:

setContextObj in class BasicTemplateProcessor

Parameters:

context -

getObjectOid

public String getObjectOid()

Deprecated.

Returns a String representation of the Object ID of the object providing the context for this processor.

Returns:

the string object ID of the context object

setObjectOid

public void setObjectOid(String oid)

Deprecated.

Sets the object ID of the object providing the context for this processor.

Parameters:

oid - a String object ID corresponding to the object providing the context for this processor.