wt.enterprise
Class BasicTemplateProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

Direct Known Subclasses:

ActionItemNotificationProcessor, AdminHomepageProcessor, AllocateProcessor, AugmentRolesProcessor, BOMTemplateProcessor, BuildRuleBuildSourceProcessor, CabinetsTemplateProcessor, CalendarProcessor, ChooserHtml, ConfigurationsProcessor, ContentHtml, CreateProxyProcessor, DefaultTemplateProcessor, DoConfirmUnitProcessor, DocumentStructureProcessor, DoExportUnitProcessor, DoFederationSearchProcessor, DoImportUnitProcessor, DoIntegratedSearchProcessor, DoReceiveUnitProcessor, DoSearchProcessor, DoSendUnitProcessor, ErrorProcessor, ExportStatusUnitProcessor, ExportUnitProcessor, FamilyinstProcessor, FederationSearchProcessor, FormProcessor, HistoryProcessor, HistoryRowProcessor, ImportStatusUnitProcessor, ImportUnitProcessor, InitiateWorkflowProcessor, InvitationTemplateProcessor, IterationHistoryProcessor, JavaScriptTemplateProcessor, LatestContentProcessor, ListPartsUnitProcessor, LocalSearchProcessor, MadeFromProcessor, MeetingNotificationProcessor, NmActionItemNotificationProcessor, NmMeetingNotificationProcessor, NotificationMessageProcessor, NotificationRobotProcessor, ObjectComparisonProcessor, ObjectContentProcessor, ObjectNotificationProcessor, ObjectPropertiesProcessor, PageGenerationProcessor, PartDistributionListProcessor, PartOccurrenceProcessor, PartReferencesProcessor, PartUsedByProcessor, PartUsesProcessor, PlmConfigurationsProcessor, PolicyNotificationProcessor, ProductInstancesProcessor, ProductStructureProcessor, ProjectNotificationProcessor, ReceiveStatusUnitProcessor, ReceiveUnitProcessor, ReferencedByProcessor, RoleContentsParticipantRowProcessor, SaveProxyProcessor, ScheduleLinksProcessor, ScheduleStatusProcessor, SendStatusUnitProcessor, SendUnitNextProcessor, SendUnitProcessor, StdDataFormatService, VersionHistoryProcessor, ViewLogUnitProcessor, WfAdministratorProcessor, WfTemplateProcessor, WfWlActionProcessor

public abstract class BasicTemplateProcessor

extends Object

implements TemplateProcessor, ContextTranslator, ContextHolder, Evolvable

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 abstract class implements several methods useful for template processing. It is suggested that most new template processors should extend DefaultTemplateProcessor.

Supported API: true

Extendable: false

See Also:

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

Field Summary

protected static String	ACTION Deprecated. Description of the Field
String	ADD_HELP_ICON Deprecated. Description of the Field
static String	ALL_CABINETS Deprecated. Description of the Field
protected static String	BLANK_SPACE Deprecated. Description of the Field
protected static String	BREAK_SEPARATOR Deprecated. Description of the Field
protected static String	BREAK_TAG Deprecated. Description of the Field
private static String	CHECKOUT_FOLDER Deprecated.
protected static String	CLASS Deprecated. Description of the Field
private static Hashtable	classInfos Deprecated.
private static String	CLASSNAME Deprecated.
private static String	CODEBASE Deprecated.
protected HTMLComponentFactory	componentFactory Deprecated. Description of the Field
static String	CONTAINER_NAME Deprecated. Description of the Field
static String	CONTENT_RESOURCE Deprecated. Description of the Field
protected String	contextClass Deprecated. Description of the Field
private String[]	contextListIn Deprecated.
private String[]	contextListOut Deprecated.
static String	DEFAULT_CHARSET Deprecated. Description of the Field
String	DEFAULT_HELP_ICON_SELECTOR Deprecated. Description of the Field
String	DEFAULT_HELP_LABEL Deprecated. Description of the Field
String	DEFAULT_PREFERENCE_CONTEXT Deprecated. Description of the Field
private static String	DND_CHECKED_FROM_PDM_AND_SHARED_FROM_GLYPH Deprecated.
private static String	DND_GLYPH_IMG Deprecated.
private static String	DND_WIP_CHECKED_OUT_AND_CHECKED_FROM_PDM_GLYPH Deprecated.
private static String	DND_WIP_CHECKED_OUT_AND_CHECKED_OUT_FROM_PDM_AND_SHARED_FROM_GLYPH Deprecated.
private static String	DND_WIP_CHECKED_OUT_AND_SHARED_FROM_GLYPH Deprecated.
private static String	DND_WIP_CHECKED_OUT_AND_SHARED_TO_GLYPH Deprecated.
private static String	DND_WIP_WORKCOPY_AND_CHKOUT_FROM_PDM_GLYPH Deprecated.
static String	DOCFROMTEMPLATE Deprecated. Description of the Field
static String	ENABLE_HELP_ICON_PROPERTY_NAME Deprecated. Description of the Field
static String	ENTERPRISE_SEARCH Deprecated. Description of the Field
static long	EXTERNALIZATION_VERSION_UID Deprecated.
private static String	FEDERATION_RESOURCE Deprecated.
static String	FEDERATION_SEARCH Deprecated. Description of the Field
static String	GLOBAL_NAVIGATION_ENABLE_HELP_ICON Deprecated. Description of the Field
protected static boolean	globalNavBarHelpIconEnabledDefault Deprecated. Description of the Field
private static String[][]	glyphImages Deprecated.
String	HELP_CONTEXT Deprecated. Description of the Field
String	HELP_ICON_POSITION Deprecated. Description of the Field
String	HELP_ICON_SELECTOR Deprecated. Description of the Field
String	HELP_LABEL Deprecated. Description of the Field
String	HELP_LABEL_RESOURCE Deprecated. Description of the Field
String	HELP_WINDOW_NAME Deprecated. Description of the Field
protected String	helpContext Deprecated. Description of the Field
protected boolean	helpIconEnabled Deprecated. Description of the Field
protected static boolean	helpIconEnabledDefault Deprecated. Description of the Field
static String	HOMEPAGE Deprecated. Description of the Field
private static String	HTML_GATEWAY Deprecated.
private static String	HTML_TEMPLATE_ACTION Deprecated.
private TemplateProcessorTableService	htmlTableService Deprecated.
static String	IDPREFIX Deprecated. Constant for ID key property key.
static String	IMPORT Deprecated. Description of the Field
static String	INTEGRATED_SEARCH Deprecated. Description of the Field
protected static boolean	isDndMicroAppletEnabled Deprecated. Description of the Field
protected static boolean	isDndMicroAppletEnabledInitialized Deprecated. Description of the Field
private static Method	isWildfireIconDelegateMethod Deprecated.
static String	LABEL_SEPARATOR Deprecated. Description of the Field
static String	LINE_FEED_DELIMITER Deprecated. Description of the Field
protected String	linkPrefix Deprecated. Description of the Field
static String	LOCAL_SEARCH Deprecated. Description of the Field
private static int	MAXLENGTH Deprecated.
protected static String	OID Deprecated. Description of the Field
protected static long	OLD_FORMAT_VERSION_UID Deprecated.
protected PageContext	pageContext Deprecated. Description of the Field
static String	PDMLINK_INSTALL_KEY Deprecated. Description of the Field
private static boolean	PDMLinkInstalled Deprecated.
static String	PERSONAL_CABINET Deprecated. Description of the Field
String	PREF_WINDOW_NAME Deprecated. Description of the Field
String	PREFERENCE_CONTEXT Deprecated. Description of the Field
String	PRESENT_HELP_LABEL Deprecated. Description of the Field
static String	PROJECTLINK_INSTALL_KEY Deprecated.
private static boolean	ProjectLinkInstalled Deprecated.
private StdTemplateProcessor	queryService Deprecated.
private static String	RESOURCE Deprecated.
static String	SEARCH Deprecated. Description of the Field
private static String	SECONDARY_EXCLUDE Deprecated.
(package private) static long	serialVersionUID Deprecated.
static String	SHARE_ICON Deprecated. Description of the Field
private static boolean	templateCommentsEnabled Deprecated.
static String	TEXT_RESOURCE_BUNDLE Deprecated. Description of the Field
private HTTPState	theState Deprecated.
static String	URL_RESOURCE Deprecated. Description of the Field
private static ResourceBundle	urlLinkResource Deprecated.
private static boolean	VERBOSE Deprecated.
private static boolean	visualizationEnabled Deprecated.
static String	WORKLIST Deprecated. Description of the Field
protected WTAttribute	wtAttribute Deprecated. Description of the Field
static String	WTCORE_IMAGE_DIR Deprecated. Description of the Field

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

BasicTemplateProcessor()
Deprecated.

Method Summary

static boolean	AccessOK(String action, Object obj, HTTPRequest request) Deprecated. Checks whether a given action is currently available for a given object.
void	addHiddenProperty(Properties parameters, Locale locale, OutputStream os) Deprecated. Adds a feature to the HiddenProperty attribute of the BasicTemplateProcessor object
void	addHTMLHelpLink(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	addToResponseExceptions(Exception newException) Deprecated.
void	addToResponseFooters(LocalizableMessage newFooter) Deprecated.
void	addToResponseHeaders(LocalizableMessage newHeader) Deprecated.
void	addToResponseMessages(LocalizableMessage newMessage) Deprecated.
void	allVersions(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs HTML to display all versions of a Mastered object.
private String	appDataTableHeading(Locale locale) Deprecated. Outputs the table headings for the Application Data (file content) table.
void	bcwti(Properties parameters, Locale locale, OutputStream os) Deprecated. No-op method to filter out copyright statements on templates so they aren't sent to browser.
static String	buildFormProcessorURL(String label, String parameters, String method, Properties properties) Deprecated. Returns a string representation of a URL to the FormProcessor.
static String	buildFormProcessorURL(String class_string, String label, String parameters, String method, Properties properties) Deprecated. Description of the Method
void	comment(Properties parameters, Locale locale, OutputStream os) Deprecated. No-op method to filter out comments on templates so they aren't sent to browser unless the wt.property "wt.template.commentsEnabled" is true.
void	createActionsBar(Properties parameters, Locale locale, OutputStream os) Deprecated. Write a list of links to actions corresponding to the context object to the given OutputStream.
void	createFederationNavigationBar(Properties parameters, Locale locale, OutputStream os) Deprecated. Output a table of links to federation actions.
void	createGlobalNavigationBar(Properties parameters, Locale locale, OutputStream os) Deprecated. Output a table of links to global actions.
void	createNavigationBar(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs HTML Navigation Bar specific for object.
void	createParentFolderLink(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs a hyperlink to the object properties page of the parent folder of the context object.
void	currentTimestamp(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs HTML that describes the current date and time.
void	displayAllCabinets(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs a table displaying all of the cabinets for which the current user has read permissions.
void	displayAttributeName(Properties parameters, Locale locale, OutputStream os) Deprecated. Description of the Method
void	displayAttributesTable(Properties parameters, Locale locale, OutputStream os) Deprecated. Description of the Method
void	displayAttributeValue(Properties parameters, Locale locale, OutputStream os) Deprecated. Description of the Method
void	displayFolderContents(Properties parameters, Locale locale, OutputStream os) Deprecated. Displays the contents of the folder context object.
static boolean	displayFolderObject(WTContainer container, WTObject obj) Deprecated.
void	displayFolderTrail(Properties parameters, Locale locale, OutputStream os) Deprecated. Description of the Method
void	displayGoToLatestLink(Properties parameters, Locale locale, OutputStream os) Deprecated. dysplay Go To Latest iteration link on the attribute block
private void	displayMeasurementSystemsDropDown(String currentMeasurementSystem, String displayFormTag, String tableAlignment, String tableWidth, PrintWriter out, Locale locale) Deprecated. Description of the Method
void	displayOrganizationIdentifier(Properties parameters, Locale locale, OutputStream os) Deprecated. Description of the Method
static String	displayPendingChangeIndicator(Object object, String gifImage, boolean showURL) Deprecated. Description of the Method
void	displayStyleSheetAttributesTable(Properties parameters, Locale locale, OutputStream os, boolean USE_STYLE_SHEET) Deprecated. This method when is the same as displayAttributesTable() with hard-coded fonts and colors removed and references to stylesheet settings added.
void	displayVisualData(Properties parameters, Locale locale, OutputStream os) Deprecated. Displays a thumbnail and/or other appropriate visualization action links on the ObjectIdentificationVerbose html page of a Representable or Viewable object (WTPart, EPMDocument, WTDocument) Supported API: false
static String	formatDate(int format, Date time, Locale locale) Deprecated. Formats the given with the given format type for the given locale.
protected static Vector	getActionPairs(String keyRep, Locale locale) Deprecated. Returns a Vector containing strings
private SortedEnumeration	getAllCabinets(String permission) Deprecated. Returns all cabinets for which the current user has the given permission.
static String	getAllCabinetsURL(String label, String parameters, Locale locale) Deprecated. Returns a String containing the HTML code to create a link to display all cabinets.
private static String	getAttrValue(Object obj, String attr) Deprecated. Returns the String value of the given attribute on the given object.
void	getBaselineItems(Properties parameters, Locale locale, OutputStream os) Deprecated. Supported API: false
static void	getCharsetEncoding(Properties parameters, Locale locale, OutputStream os) Deprecated. Method to output the appropriate charset encoding for the current locale.
static String	getCheckedOutFolderURL(String label, String parameters, Locale locale) Deprecated. Gets the checkedOutFolderURL attribute of the BasicTemplateProcessor class
void	getClassIcon(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs the icon associated with the given class to the given OutputStream.
protected static ClassInfo	getClassInfo(Class class_name) Deprecated. Returns the ClassInfo object corresponding to the given Class.
private WTContainer	getContainerByOid(String containerOid) Deprecated. For the specified container oid, return the WTContainer object.
String	getContextAction() Deprecated.
String	getContextClass() Deprecated. Gets the contextClass attribute of the BasicTemplateProcessor object
String	getContextClassName() Deprecated.
String[]	getContextListIn() Deprecated.
String[]	getContextListOut() Deprecated.
Object	getContextObj() Deprecated.
Properties	getContextProperties() Deprecated.
static String	getContextServiceName(String action_delegate) Deprecated. Returns the CONTEXT_SERVICE_NAME for the ActionDelegate specified by the given delegate parameter.
protected static String	getDisplayName(Class class_name, String attr, Locale locale) Deprecated. Returns the display name corresponding to the given attribute for the given class.
void	getDomainPath(Properties parameters, Locale locale, OutputStream os) Deprecated. Gets the domainPath attribute of the BasicTemplateProcessor object
void	getEnabledVersion(Properties properties, Locale locale, OutputStream os) Deprecated. Method to display the enabled version property of a templateable object that is a template
String	getEncoding(OutputStream out, Locale locale) Deprecated. Get character encoding that should be used with the template processing output stream.
private static String	getFamilyGlyph(String glyphLocation) Deprecated.
static String	getFederationSearchURL(String label, String search_type, Properties parameters, String href_props, Locale locale) Deprecated. Supported API: false
private String	getFileSize(ApplicationData file) Deprecated. Returns a String containing the size of the given file in Kilobytes.
private SortedEnumeration	getFolderContents() Deprecated. Retrieve the folder contents of the folder context object.
void	getFolderLocation(Properties parameters, Locale locale, OutputStream os) Deprecated. Prints the folder location of the FolderEntry context object to the given OutputStream.
void	getFolderPath(Properties parameters, Locale locale, OutputStream os) Deprecated. Prints the folder path of the FolderEntry context object to the given OutputStream.
private static String	getFolderTableHeading(Locale locale) Deprecated. Returns a String containing the HTML code to display the heading for the folder contents table.
Properties	getFormData() Deprecated.
static String	getGenericInstanceIconImgTag(Object obj) Deprecated.
static String	getGlyphImageTag(WTObject object) Deprecated.
static String[][]	getGlyphsArray() Deprecated.
static String	getGlyphTagsNoDnD(WTObject obj, Vector glyphResources, boolean forceFullyQualified) Deprecated. Gets the tags for an object's icon glyphs (no drag and drop).
String	getHelpContext() Deprecated. Gets the helpContext attribute of the BasicTemplateProcessor object
static String	getHomepageURL(String label, String href_properties, Locale locale) Deprecated. Returns a String representation of a URL to the Windchill homepage Supported API: false
HTMLComponentFactory	getHTMLComponentFactory() Deprecated. Gets the hTMLComponentFactory attribute of the BasicTemplateProcessor object
String	getHTMLHelpLink(Properties parameters, Locale locale, OutputStream os) Deprecated. Returns a String with the HTML for a link to a context dependent Help page.
void	getHTMLHelpURL(Properties parameters, Locale locale, OutputStream os) Deprecated.
String	getHTMLHelpURL(String helpContext, Locale locale) Deprecated. This call will generate the URL of a Help page based on the current Context Object or Context Class Name and the HelpContext String that is passed in.
TemplateProcessorTableService	getHTMLTableService() Deprecated.
String	getIconResource() Deprecated. Returns a String containing the URL to the icon for the context object.
private static String	getIconResource(Class obj_class) Deprecated. Returns a String containing the URL to the icon for the given class.
static String	getIconResource(IconSelector iconSelector, boolean forceFullyQualified) Deprecated. Returns a String containing the URL to the icon for the given class.
static String	getIconResource(Object obj, HTTPState a_State) Deprecated. Returns a String containing the URL to the icon for the given WTObject or class.
private static String	getIconResource(WTObject obj, HTTPState a_State) Deprecated. Returns a String containing the URL to the icon for the given WTObject.
private static String	getIconResource(WTObject obj, HTTPState a_State, boolean forceFullyQualified) Deprecated. Returns a String containing the URL to the icon for the given WTObject.
static IconSelector	getIconSelector(WTObject obj, HTTPState a_State, String sharedFrom, String sharedTo, WTContainer contextContainer) Deprecated. Returns an IconSelector for the given object.
void	getId(Properties parameters, Locale locale, OutputStream os) Deprecated. This template processor method generates an ID value.
JavaScriptManager	getJavaScriptManager() Deprecated. Gets the javaScriptManager attribute of the BasicTemplateProcessor object
private String	getKeyRep(Locale locale) Deprecated. Gets the keyRep attribute of the BasicTemplateProcessor object
void	getLocalizedDateFormatMessage(Properties parameters, Locale locale, OutputStream os) Deprecated. Gets the localizedDateFormatMessage attribute of the BasicTemplateProcessor object
void	getLocalizedMessage(Properties parameters, Locale locale, OutputStream os) Deprecated. Produces HTML that represents a localized message from a resouce bundle.
static PrintWriter	getLocalizedPrintWriter(OutputStream out, Locale locale) Deprecated. Get a PrintWriter for the given output stream and locale.
String	getLocalizedString(ResourceBundle resource, String key, String backup) Deprecated. Method to localize generic strings.
void	getObjectDnDIcon(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs the icon associated with the context object to the given OutputStream.
void	getObjectIcon(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs the icon associated with the context object to the given OutputStream.
static String	getObjectIconDnDTag(WTObject obj, String backgroundColor, ContentHolder holder) Deprecated. Gets the HTML applet tag(s) to display the drag icon and glyphs associated with a given object.
static Vector	getObjectIconGlyphs(IconSelector selector, boolean doDnD) Deprecated. Returns the image files for the glyphs for an object
static String	getObjectIconImgTag(Class obj_class) Deprecated. Returns the HTML code to display the image corresponding to the given object class
static String	getObjectIconImgTag(WTObject obj) Deprecated. Gets the HTML tag(s) to display the icon and glyphs associated with a given object.
static String	getObjectIconImgTag(WTObject obj, boolean forceFullyQualified) Deprecated. Gets the HTML tag(s) to display the icon and glyphs associated with a given object.
static String	getObjectIconImgTag(WTObject obj, String backgroundColor) Deprecated. Gets the HTML tag(s) to display the icon and glyphs associated with a given object.
private static String	getObjectIconImgTag(WTObject obj, String backgroundColor, ContentHolder holder, HTTPState a_State) Deprecated. Gets the HTML tag(s) to display the icon and glyphs associated with a given object.
private static String	getObjectIconImgTag(WTObject obj, String backgroundColor, ContentHolder holder, HTTPState a_State, String sharedFrom, String sharedTo, WTContainer currentContainerContext) Deprecated. Gets the HTML tag(s) to display the icon and glyphs associated with a given object.
private static String	getObjectIconImgTag(WTObject obj, String backgroundColor, ContentHolder holder, HTTPState a_State, String sharedFrom, String sharedTo, WTContainer currentContainerContext, boolean forceFullyQualified) Deprecated. Gets the HTML tag(s) to display the icon and glyphs associated with a given object.
private static String	getObjectIconImgTag(WTObject obj, String backgroundColor, HTTPState a_State) Deprecated. Gets the HTML tag(s) to display the icon and glyphs associated with a given object.
static String	getObjectIconImgTag(WTObject obj, String sharedFrom, String sharedTo, WTContainer currentContainerContext) Deprecated. Gets the HTML tag(s) to display the icon and glyphs associated with a given object.
static String	getObjectIconImgTag(WTObject obj, String sharedFrom, String sharedTo, WTContainer currentContainerContext, boolean forceFullyQualified) Deprecated. Gets the HTML tag(s) to display the icon and glyphs associated with a given object.
protected String	getObjectPropertyValueString(String propertyName, Properties parameters, Locale locale, Object obj) Deprecated. A utility method that implements some of the basic functionality needed by objectPropertyValue().
protected String	getObjectPropertyValueString(String propertyName, Properties parameters, Locale locale, Object obj, boolean warn) Deprecated. Returns the String value of the attribute specified by the given property name on the given object.
private static String	getObjectType(WTObject obj) Deprecated. Returns a string for the type of the object (e.g.
private HTMLTemplate	getOITemplate(String mode, Locale locale) Deprecated. Return an initialized HTMLTemplate.
private String	getOITemplateName(String mode) Deprecated. Gets the oITemplateName attribute of the BasicTemplateProcessor object
PageContext	getPageContext() Deprecated. Gets the pageContext attribute of the BasicTemplateProcessor object
protected String	getParentFolderLink(CabinetBased cabinet_based, String label, Locale locale) Deprecated. Returns the String containing the HTML code to display a Hyperlink to the object properties page of the parent folder of the given FolderEntry object.
protected static Cabinet	getPersonalCabinet(WTPrincipal principal) Deprecated. Returns the personal cabinet corresponding to the given WTPrincipal.
static String	getPersonalCabinetURL(WTPrincipal principal, String label, String params, Locale locale) Deprecated. Return a String representation of a URL to the user's personal cabinet.
protected static String	getPreferenceValue(String node, String key) Deprecated. Gets the preferenceValue attribute of the BasicTemplateProcessor class
protected String	getPrincipalEmailLink(WTPrincipalReference principal, String args) Deprecated. Returns a String containing the HTML code to display a mail-to hyperlink to the e-mail of the principal referenced by the given WTPrincipalReference.
protected String	getPrincipalEmailLink(WTPrincipal principal, String args) Deprecated. Returns a String containing the HTML code to display a mail-to hyperlink to the e-mail of the given principal.
PrintWriter	getPrintWriter(OutputStream out, Locale locale) Deprecated. Get a PrintWriter for the given output stream and locale.
static String	getPropertyFromPropertyFile(Properties parameters) Deprecated. Method to return the String value of a property from a property file.
void	getQuery(Properties parameters, Locale locale, OutputStream os) Deprecated. Gets the query specified by the value of the parameter whose key is 'QueryName'.
Properties	getQueryData() Deprecated.
void	getReferenceString(Properties parameters, Locale locale, OutputStream os) Deprecated. Gets the referenceString attribute of the BasicTemplateProcessor object
static String	getReferenceString(WTObject obj) Deprecated. Gets the referenceString attribute of the BasicTemplateProcessor class
void	getResourceString(Properties parameters, Locale locale, OutputStream os) Deprecated.
static String	getResourceString(String resourceToken, Locale locale, String resourceBundle, String defaultText) Deprecated. This is a service to get a localized string from a resource bundle.
Vector	getResponseExceptions() Deprecated.
Vector	getResponseFooters() Deprecated.
Vector	getResponseHeaders() Deprecated.
Vector	getResponseMessages() Deprecated.
String	getResponseString() Deprecated.
void	getSearchCriteriaURL(Properties parameters, Locale locale, OutputStream os) Deprecated. Supported API: false
static String	getSearchCriteriaURL(String label, String search_type, Properties parameters, String href_props, Locale locale) Deprecated. Supported API: false
String	getSearchResultsURL(String attribute, String value, String label, String search_objs, Locale locale) Deprecated. Supported API: false
String	getShareImage() Deprecated. Gets the shareImage attribute of the BasicTemplateProcessor object
static String	getShareImage(Object obj) Deprecated. Returns the Share Image Supported API: false
HTTPState	getState() Deprecated.
int	getStatus() Deprecated.
static String	getStringFromResourceBundle(String resource_key, String resource_class, Locale locale) Deprecated. Gets the stringFromResourceBundle attribute of the BasicTemplateProcessor class
static String	getStringFromResourceBundle(String resource_key, String resource_class, Object[] params, Locale locale) Deprecated. Gets the stringFromResourceBundle attribute of the BasicTemplateProcessor class
void	getTemplateDisplayGeneral(Properties properties, Locale locale, OutputStream os) Deprecated. Method to display the template property of an object along with its availability for use.
void	getTrailId(Properties parameters, Locale locale, OutputStream os) Deprecated. Constructs an HTML tag ID suitable for Pro/E trail file instrumentation.
void	getTrlIdAttribute(Properties parameters, Locale locale, OutputStream os) Deprecated. Constructs a trlId tag suitable for Pro/E trail file instrumentation.
static Vector	getURLActions(Class obj_class, Locale locale) Deprecated. Given a class, returns a Vector of URLActionDelegates available for that class.
static Vector	getURLActions(Class obj_class, Locale locale, boolean minimal_list) Deprecated. Gets the uRLActions attribute of the BasicTemplateProcessor class
static Vector	getURLActions(Object obj, Locale locale) Deprecated. Given an object, returns a Vector of URLActionDelegates available for that class of object.
static Vector	getURLActions(Object obj, Locale locale, boolean minimal) Deprecated. Gets the uRLActions attribute of the BasicTemplateProcessor class
String	getURLActionsString(Object obj, Locale locale, String link_params) Deprecated. Returns a String of links to actions that can be performed on the given Object.
String	getURLActionsString(Object obj, Vector actionDelegates, Locale locale, String link_params) Deprecated. Gets the uRLActionsString attribute of the BasicTemplateProcessor object
protected static URLFactory	getURLFactory() Deprecated. This method should be used ONLY for static methods for legacy processor support.
static String	getURLFromDelegate(URLActionDelegate delegate, Object obj, HTTPState state) Deprecated. Given an object, a URLActionDelegate and a HTTPState object, returns a URL string for an action.
void	getURLProcessorLink(Properties parameters, Locale locale, OutputStream os) Deprecated.
String	getURLProcessorLink(String methodName, Properties parameters) Deprecated. Gets the uRLProcessorLink attribute of the BasicTemplateProcessor object
String	getURLProcessorLink(String methodName, Properties parameters, boolean fullyQualified) Deprecated. Gets the uRLProcessorLink attribute of the BasicTemplateProcessor object
static String	getURLProcessorLinkWithLabel(String label, String parameters, String method, Properties properties) Deprecated. Gets the uRLProcessorLinkWithLabel attribute of the BasicTemplateProcessor class
WTPartUsageLink[]	getUsedByLinks() Deprecated. Supported API: false
void	getWCColor(Properties parameters, Locale locale, OutputStream os) Deprecated. Retrieves the value of a HTML color property from wt.properties and writes it to the HTML page.
static String	getWCColor(String styleClass) Deprecated. Retrieves the value of a HTML color property from wt.properties
void	getWCColorDec(Properties parameters, Locale locale, OutputStream os) Deprecated. Retrieves the value of a HTML color property from wt.properties and writes it to the HTML page as a decimal integer.
static String	getWCColorDec(String styleClass) Deprecated. Gets the wCColorDec attribute of the BasicTemplateProcessor class
static String	getWCFontFamily() Deprecated. Retrieves the list of preferred HTML font faces from wt.properties
void	getWCFontFamily(Properties parameters, Locale locale, OutputStream os) Deprecated. Retrieves the list of preferred HTML font faces from wt.properties.
private static IconSelector	getWildfireIconSelector(IconDelegate a_IconDelegate, HTTPState a_State) Deprecated. Gets the wildfireIconSelector attribute of the BasicTemplateProcessor class
static String	getWorklistURL(String label, String href_properties, Locale locale) Deprecated. Returns a String representation of a URL to the current principal's worklist.
WTAttribute	getWTAttribute() Deprecated. Gets the wTAttribute attribute of the BasicTemplateProcessor object
WTContainer	getWTContainerByName(String containerName) Deprecated. For the specified container name, return back the WTContainer object.
WTContainerRef	getWTContainerRef(Properties parameters, Locale locale) Deprecated. Get container value as contextual value.
void	handleExceptionTP(String methodName, Exception e, boolean printStackTrace, Properties parameters, Locale locale, OutputStream os) Deprecated. This flavor of the handleExceptionTP() method can be called in the following scenario:
void	handleExceptionTP(String title, String text, Exception e, boolean printStackTrace, HTTPResponse resp, Locale locale) Deprecated. This flavor of the handleExceptionTP() method can be called in the following scenario:
static void	handleProcessorException(String methodName, Exception e, boolean printStackTrace, Properties parameters, Locale locale, OutputStream os) Deprecated. HandleProcessorException() method can be called in the following scenario:
String	hiddenContextString(String name, String value) Deprecated. Description of the Method
private static boolean	ignoreException(Throwable t) Deprecated. Description of the Method
void	include(Properties parameters, Locale locale, OutputStream os) Deprecated. This method has been extended at Release 5.0.
void	initJavaScriptManager(Properties props, Locale locale, OutputStream os) Deprecated. Description of the Method
protected static boolean	isDndMicroAppletEnabled() Deprecated. Gets the dndMicroAppletEnabled attribute of the BasicTemplateProcessor class
static boolean	isEqual(WTObject object_a, WTObject object_b) Deprecated. Returns a boolean value indicating whether or not the two given WTObjects are equal.
private static boolean	isSandboxWorkingCopy(Versioned obj) Deprecated. Gets the sandboxWorkingCopy attribute of the BasicTemplateProcessor class
private boolean	isWildfireEnabled() Deprecated. Gets the wildfireEnabled attribute of the BasicTemplateProcessor object
private static boolean	isWildfireIconDelegate(IconDelegate a_IconDelegate) Deprecated. Gets the wildfireIconDelegate attribute of the BasicTemplateProcessor class
void	listContent(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs a table listing the content items (files and URLs) associated with the ContentHolder context object.
void	objectActionLink(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs an HTML HREF with a URL to the wt.enterprise.URLProcessor class and its URLTemplateAction method.
static String	objectActionLinkAux(Object obj, String action, String label, Locale locale) Deprecated. A utility method that implements some of the basic functionality needed by objectActionLink().
static String	objectActionLinkAux(Object obj, String action, String label, Locale locale, boolean inline) Deprecated. A utility method that implements some of the basic functionality needed by objectActionLink().
static String	objectActionLinkAux(Object obj, String action, String label, Properties params, Locale locale) Deprecated. A utility method that implements some of the basic functionality needed by objectActionLink().
static String	objectActionLinkAux(Object obj, String action, String label, Properties params, String href_props, Locale locale) Deprecated. A utility method that implements some of the basic functionality needed by objectActionLink().
static String	objectActionLinkAux(Object obj, String action, String label, Properties params, String href_props, Locale locale, boolean inline) Deprecated. A utility method that implements some of the basic functionality needed by objectActionLink().
static String	objectActionLinkAux(Object obj, String action, String label, String href_props, Locale locale) Deprecated. A utility method that implements some of the basic functionality needed by objectActionLink().
static String	objectActionLinkAux(WTReference obj_ref, String action, String label, Properties params, String href_props, Locale locale) Deprecated. A utility method that implements some of the basic functionality needed by objectActionLink().
void	objectBackground(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs HTML to set the background of the page to a supplied image.
void	objectIdentification(Properties parameters, Locale locale, OutputStream os) Deprecated. Produces HTML which represents identification information for the contextual object of a BasicTemplateProcessor.
void	objectIdentifier(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs an object identifier of the form "wt.doc.General:2472".
void	objectProperties(Properties parameters, Locale locale, OutputStream os) Deprecated. A utility method for use during development and testing.
void	objectPropertyName(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs HTML which represents the display name of a property.
void	objectPropertyNameAux(Properties parameters, Locale locale, PrintWriter out) Deprecated. A utility method that implements some of the basic functionality needed by objectPropertyName().
void	objectPropertyNameAux2(Properties parameters, Locale locale, PrintWriter out, String propertyName) Deprecated. A utility method that implements some of the basic functionality needed by objectPropertyName().
void	objectPropertyValue(Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs HTML which represents the value of a property.
void	objectPropertyValueAux(Properties parameters, Locale locale, PrintWriter out) Deprecated. A utility method that implements some of the basic functionality needed by objectPropertyValue().
void	objectPropertyValueAux2(Properties parameters, Locale locale, PrintWriter out, String propertyName) Deprecated. A utility method that implements some of the basic functionality needed by objectPropertyValue().
protected String	objectPropertyValueString(String propertyName, Properties parameters, Locale locale) Deprecated. A utility method that implements some of the basic functionality needed by objectPropertyValue().
static void	outputLink(Properties parameters, Locale locale, OutputStream os) Deprecated. Description of the Method
static void	outputPropertyFromPropertyFile(Properties parameters, Locale locale, OutputStream os) Deprecated. Method to output the value of a property from a property file.
String	parameterValue(Properties params, String paramName) Deprecated. Supported API: false
void	partUsedBy(Properties parameters, Locale locale, OutputStream os) Deprecated. Supported API: false
static boolean	PDMLinkIsInstalled() Deprecated. Returns true if PDMLink is installed Supported API: false
void	printQueryTable(Properties parameters, Locale locale, OutputStream os) Deprecated. A call to printQueryTable from an HTML template will generate an HTML table with the results of a query presented in the HTML table.
void	printTable(Properties parameters, Locale locale, OutputStream os) Deprecated. Supported API: false
void	printTextArea(String label, String text, Properties parameters, Locale locale, OutputStream os) Deprecated. A call to printTextArea will output an HTML textarea with a title under the assumption that the title and textarea are to appear as a row in the an HTML table.
void	processSubTemplate(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	readContext(HTTPRequest request) Deprecated. Description of the Method
void	readExternal(ObjectInput input) Deprecated.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated. Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(BasicTemplateProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated.
private String	removeEnclosingQuotes(String value) Deprecated. Utility method to remove any enclosing quotes from the given String.
private SortedEnumeration	retrieveFolderContents() Deprecated. Retrieve the folder contents of the folder context object.
private float	roundToTwoDecimals(float number) Deprecated. Returns the given float rounded to two decimal places.
void	setColumnProperties(Properties parameters, Locale locale, OutputStream os) Deprecated. Supported API: false
void	setContextAction(String a_ContextAction) Deprecated.
void	setContextClass(String a_contextClass) Deprecated. Sets the contextClass attribute of the BasicTemplateProcessor object
void	setContextClassName(String a_ContextClassName) Deprecated.
void	setContextListIn(String[] a_ContextListIn) Deprecated.
void	setContextListOut(String[] a_ContextListOut) Deprecated.
void	setContextObj(Object a_ContextObj) Deprecated.
void	setContextProperties(Properties a_ContextProperties) Deprecated.
void	setFormData(Properties a_FormData) Deprecated.
void	setHelpContext(String a_HelpContext) Deprecated. Sets the helpContext attribute of the BasicTemplateProcessor object
void	setHTMLTableService(TemplateProcessorTableService newTableService) Deprecated. Sets the TemplateProcessorTableService instance to be used for the Windchill script calls
void	setJavaScriptManager(JavaScriptManager javaScriptManager) Deprecated. Sets the javaScriptManager attribute of the BasicTemplateProcessor object
void	setPageContext(PageContext pageContext) Deprecated. Sets the pageContext attribute of the BasicTemplateProcessor object
void	setQueryData(Properties a_QueryData) Deprecated.
void	setResponseExceptions(Vector a_ResponseExceptions) Deprecated.
void	setResponseFooters(Vector a_ResponseFooters) Deprecated.
void	setResponseHeaders(Vector a_ResponseHeaders) Deprecated.
void	setResponseMessages(Vector a_ResponseMessages) Deprecated.
void	setResponseString(String a_ResponseString) Deprecated.
void	setState(HTTPState a_State) Deprecated.
void	setStatus(int a_Status) Deprecated.
void	showResponseExceptions(Properties parameters, Locale locale, OutputStream os) Deprecated.
void	showResponseFooters(Properties parameters, Locale locale, OutputStream os) Deprecated. Presents the LocalizableMessages in maintained in the HTTPState object that were added to the HTTPState object with the call to the addToResponseFooters method.
void	showResponseHeaders(Properties parameters, Locale locale, OutputStream os) Deprecated. Presents the LocalizableMessages in maintained in the HTTPState object that were added to the HTTPState object with the call to the addToResponseHeaders method.
void	showResponseMessage(String message, Properties parameters, Locale locale, OutputStream os) Deprecated. This method will receive a String and print the String out to the HMTL page in a centered HTML table with a border=3.
void	showResponseMessages(Vector messages, Properties parameters, Locale locale, OutputStream os) Deprecated. This method will receive a Vector containing LocalizableMessages and prints them out in order.
protected void	showVersions(QueryResult versions, boolean versionTable, Properties parameters, Locale locale, OutputStream os) Deprecated. Outputs HTML to display all versions of a Mastered object.
static SortedEnumeration	sortQueryResult(QueryResult results, CollationKeyFactory key) Deprecated. Sorts the given QueryResult using the given CollationKeyFactory.
static String	splitStringIntoTokens(String string_to_split) Deprecated. Removes the LABEL_SEPARATOR characters in the given string and replaces them with spaces.
void	tableService(Properties parameters, Locale locale, OutputStream os) Deprecated.
String	translateToHtml(String value) Deprecated. translateToHtml replaces null values or empty strings with the HTML code for a non-breakable space.
private String	urlTableHeading(Locale locale) Deprecated. Outputs the table headings for the URL table.
void	useProcessorService(Properties parameters, Locale locale, OutputStream os) Deprecated. Calls a method on a ProcessorService (or TemplateProcessor ) that is context aware.
static boolean	visualizationIsEnabled() Deprecated. Returns true if Windhcill visualization services are enabled or false otherwise.
void	writeExternal(ObjectOutput output) Deprecated.
void	writeHiddenContext(Properties parameters, Locale locale, OutputStream os) Deprecated. Description of the Method
String	writeQueryStringContext() Deprecated. Description of the Method

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.enterprise.TemplateProcessor

handleRequest

Field Detail

RESOURCE

private static final String RESOURCE

Deprecated.

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Deprecated.

theState

private HTTPState theState

Deprecated.

contextListIn

private String[] contextListIn

Deprecated.

contextListOut

private String[] contextListOut

Deprecated.

serialVersionUID

static final long serialVersionUID

Deprecated.

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

Deprecated.

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

Deprecated.

See Also:

Constant Field Values

HOMEPAGE

public static final String HOMEPAGE

Deprecated.

Description of the Field

See Also:

Constant Field Values

WORKLIST

public static final String WORKLIST

Deprecated.

Description of the Field

See Also:

Constant Field Values

ENTERPRISE_SEARCH

public static final String ENTERPRISE_SEARCH

Deprecated.

Description of the Field

See Also:

Constant Field Values

LOCAL_SEARCH

public static final String LOCAL_SEARCH

Deprecated.

Description of the Field

See Also:

Constant Field Values

INTEGRATED_SEARCH

public static final String INTEGRATED_SEARCH

Deprecated.

Description of the Field

See Also:

Constant Field Values

FEDERATION_SEARCH

public static final String FEDERATION_SEARCH

Deprecated.

Description of the Field

See Also:

Constant Field Values

IMPORT

public static final String IMPORT

Deprecated.

Description of the Field

See Also:

Constant Field Values

PERSONAL_CABINET

public static final String PERSONAL_CABINET

Deprecated.

Description of the Field

See Also:

Constant Field Values

ALL_CABINETS

public static final String ALL_CABINETS

Deprecated.

Description of the Field

See Also:

Constant Field Values

SEARCH

public static final String SEARCH

Deprecated.

Description of the Field

See Also:

Constant Field Values

DOCFROMTEMPLATE

public static final String DOCFROMTEMPLATE

Deprecated.

Description of the Field

See Also:

Constant Field Values

PDMLINK_INSTALL_KEY

public static final String PDMLINK_INSTALL_KEY

Deprecated.

Description of the Field

See Also:

Constant Field Values

PDMLinkInstalled

private static boolean PDMLinkInstalled

Deprecated.

PROJECTLINK_INSTALL_KEY

public static final String PROJECTLINK_INSTALL_KEY

Deprecated.

See Also:

Constant Field Values

ProjectLinkInstalled

private static boolean ProjectLinkInstalled

Deprecated.

ACTION

protected static String ACTION

Deprecated.

Description of the Field

CLASS

protected static String CLASS

Deprecated.

Description of the Field

OID

protected static String OID

Deprecated.

Description of the Field

BREAK_SEPARATOR

protected static String BREAK_SEPARATOR

Deprecated.

Description of the Field

BREAK_TAG

protected static String BREAK_TAG

Deprecated.

Description of the Field

CODEBASE

private static String CODEBASE

Deprecated.

VERBOSE

private static boolean VERBOSE

Deprecated.

queryService

private StdTemplateProcessor queryService

Deprecated.

CONTENT_RESOURCE

public static final String CONTENT_RESOURCE

Deprecated.

Description of the Field

See Also:

Constant Field Values

URL_RESOURCE

public static final String URL_RESOURCE

Deprecated.

Description of the Field

See Also:

Constant Field Values

FEDERATION_RESOURCE

private static final String FEDERATION_RESOURCE

Deprecated.

See Also:

Constant Field Values

MAXLENGTH

private static int MAXLENGTH

Deprecated.

helpContext

protected String helpContext

Deprecated.

Description of the Field

HELP_CONTEXT

public final String HELP_CONTEXT

Deprecated.

Description of the Field

See Also:

Constant Field Values

HELP_LABEL

public final String HELP_LABEL

Deprecated.

Description of the Field

See Also:

Constant Field Values

HELP_LABEL_RESOURCE

public final String HELP_LABEL_RESOURCE

Deprecated.

Description of the Field

See Also:

Constant Field Values

DEFAULT_HELP_LABEL

public final String DEFAULT_HELP_LABEL

Deprecated.

Description of the Field

See Also:

Constant Field Values

HELP_WINDOW_NAME

public final String HELP_WINDOW_NAME

Deprecated.

Description of the Field

See Also:

Constant Field Values

helpIconEnabledDefault

protected static boolean helpIconEnabledDefault

Deprecated.

Description of the Field

globalNavBarHelpIconEnabledDefault

protected static boolean globalNavBarHelpIconEnabledDefault

Deprecated.

Description of the Field

helpIconEnabled

protected boolean helpIconEnabled

Deprecated.

Description of the Field

isDndMicroAppletEnabled

protected static boolean isDndMicroAppletEnabled

Deprecated.

Description of the Field

isDndMicroAppletEnabledInitialized

protected static boolean isDndMicroAppletEnabledInitialized

Deprecated.

Description of the Field

ADD_HELP_ICON

public final String ADD_HELP_ICON

Deprecated.

Description of the Field

See Also:

Constant Field Values

HELP_ICON_SELECTOR

public final String HELP_ICON_SELECTOR

Deprecated.

Description of the Field

See Also:

Constant Field Values

DEFAULT_HELP_ICON_SELECTOR

public final String DEFAULT_HELP_ICON_SELECTOR

Deprecated.

Description of the Field

See Also:

Constant Field Values

PRESENT_HELP_LABEL

public final String PRESENT_HELP_LABEL

Deprecated.

Description of the Field

See Also:

Constant Field Values

HELP_ICON_POSITION

public final String HELP_ICON_POSITION

Deprecated.

Description of the Field

See Also:

Constant Field Values

LABEL_SEPARATOR

public static String LABEL_SEPARATOR

Deprecated.

Description of the Field

LINE_FEED_DELIMITER

public static final String LINE_FEED_DELIMITER

Deprecated.

Description of the Field

See Also:

Constant Field Values

PREFERENCE_CONTEXT

public final String PREFERENCE_CONTEXT

Deprecated.

Description of the Field

See Also:

Constant Field Values

DEFAULT_PREFERENCE_CONTEXT

public final String DEFAULT_PREFERENCE_CONTEXT

Deprecated.

Description of the Field

See Also:

Constant Field Values

PREF_WINDOW_NAME

public final String PREF_WINDOW_NAME

Deprecated.

Description of the Field

See Also:

Constant Field Values

TEXT_RESOURCE_BUNDLE

public static final String TEXT_RESOURCE_BUNDLE

Deprecated.

Description of the Field

See Also:

Constant Field Values

contextClass

protected String contextClass

Deprecated.

Description of the Field

BLANK_SPACE

protected static final String BLANK_SPACE

Deprecated.

Description of the Field

See Also:

Constant Field Values

urlLinkResource

private static ResourceBundle urlLinkResource

Deprecated.

classInfos

private static Hashtable classInfos

Deprecated.

HTML_GATEWAY

private static final String HTML_GATEWAY

Deprecated.

See Also:

Constant Field Values

HTML_TEMPLATE_ACTION

private static final String HTML_TEMPLATE_ACTION

Deprecated.

See Also:

Constant Field Values

htmlTableService

private TemplateProcessorTableService htmlTableService

Deprecated.

ENABLE_HELP_ICON_PROPERTY_NAME

public static String ENABLE_HELP_ICON_PROPERTY_NAME

Deprecated.

Description of the Field

GLOBAL_NAVIGATION_ENABLE_HELP_ICON

public static String GLOBAL_NAVIGATION_ENABLE_HELP_ICON

Deprecated.

Description of the Field

WTCORE_IMAGE_DIR

public static String WTCORE_IMAGE_DIR

Deprecated.

Description of the Field

SHARE_ICON

public static String SHARE_ICON

Deprecated.

Description of the Field

glyphImages

private static String[][] glyphImages

Deprecated.

DND_GLYPH_IMG

private static String DND_GLYPH_IMG

Deprecated.

DND_WIP_WORKCOPY_AND_CHKOUT_FROM_PDM_GLYPH

private static String DND_WIP_WORKCOPY_AND_CHKOUT_FROM_PDM_GLYPH

Deprecated.

DND_WIP_CHECKED_OUT_AND_CHECKED_FROM_PDM_GLYPH

private static String DND_WIP_CHECKED_OUT_AND_CHECKED_FROM_PDM_GLYPH

Deprecated.

DND_WIP_CHECKED_OUT_AND_SHARED_FROM_GLYPH

private static String DND_WIP_CHECKED_OUT_AND_SHARED_FROM_GLYPH

Deprecated.

DND_WIP_CHECKED_OUT_AND_SHARED_TO_GLYPH

private static String DND_WIP_CHECKED_OUT_AND_SHARED_TO_GLYPH

Deprecated.

DND_WIP_CHECKED_OUT_AND_CHECKED_OUT_FROM_PDM_AND_SHARED_FROM_GLYPH

private static String DND_WIP_CHECKED_OUT_AND_CHECKED_OUT_FROM_PDM_AND_SHARED_FROM_GLYPH

Deprecated.

DND_CHECKED_FROM_PDM_AND_SHARED_FROM_GLYPH

private static String DND_CHECKED_FROM_PDM_AND_SHARED_FROM_GLYPH

Deprecated.

CHECKOUT_FOLDER

private static final String CHECKOUT_FOLDER

Deprecated.

See Also:

Constant Field Values

IDPREFIX

public static final String IDPREFIX

Deprecated.

Constant for ID key property key.

See Also:

Constant Field Values

linkPrefix

protected String linkPrefix

Deprecated.

Description of the Field

wtAttribute

protected WTAttribute wtAttribute

Deprecated.

Description of the Field

componentFactory

protected HTMLComponentFactory componentFactory

Deprecated.

Description of the Field

pageContext

protected PageContext pageContext

Deprecated.

Description of the Field

visualizationEnabled

private static boolean visualizationEnabled

Deprecated.

templateCommentsEnabled

private static boolean templateCommentsEnabled

Deprecated.

isWildfireIconDelegateMethod

private static Method isWildfireIconDelegateMethod

Deprecated.

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

Deprecated.

Description of the Field

See Also:

Constant Field Values

SECONDARY_EXCLUDE

private static String SECONDARY_EXCLUDE

Deprecated.

CONTAINER_NAME

public static final String CONTAINER_NAME

Deprecated.

Description of the Field

See Also:

Constant Field Values

Constructor Detail

BasicTemplateProcessor

public BasicTemplateProcessor()

Deprecated.

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Deprecated.

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

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Deprecated.

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

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

Deprecated.

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

Deprecated.

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

getState

public HTTPState getState()

Deprecated.

Gets the object for the association that plays role: theState.

Supported API: false

Returns:

HTTPState

setState

public void setState(HTTPState a_State)

Deprecated.

Sets the object for the association that plays role: theState.

Supported API: false

Parameters:

a_State -

getContextListIn

public String[] getContextListIn()

Deprecated.

Gets the value of the attribute: contextListIn.

Supported API: true

Specified by:

getContextListIn in interface ContextTranslator

Returns:

String[]

setContextListIn

public void setContextListIn(String[] a_ContextListIn)

Deprecated.

Sets the value of the attribute: contextListIn.

Supported API: true

Specified by:

setContextListIn in interface ContextTranslator

Parameters:

a_ContextListIn -

getContextListOut

public String[] getContextListOut()

Deprecated.

Gets the value of the attribute: contextListOut.

Supported API: true

Specified by:

getContextListOut in interface ContextTranslator

Returns:

String[]

setContextListOut

public void setContextListOut(String[] a_ContextListOut)

Deprecated.

Sets the value of the attribute: contextListOut.

Supported API: true

Specified by:

setContextListOut in interface ContextTranslator

Parameters:

a_ContextListOut -

getContextAction

public String getContextAction()

Deprecated.

Gets the value of the attribute: contextAction; Context Action is the name of the action of the current page

Supported API: true

Specified by:

getContextAction in interface ContextHolder

Returns:

String

setContextAction

public void setContextAction(String a_ContextAction)

Deprecated.

Sets the value of the attribute: contextAction; Context Action is the name of the action of the current page

Supported API: true

Specified by:

setContextAction in interface ContextHolder

Parameters:

a_ContextAction -

getContextObj

public Object getContextObj()

Deprecated.

Gets the value of the attribute: contextObj; Context Object is the reference object of the current page

Supported API: true

Specified by:

getContextObj in interface ContextHolder

Returns:

Object

setContextObj

public void setContextObj(Object a_ContextObj)

Deprecated.

Sets the value of the attribute: contextObj; Context Object is the reference object of the current page

Supported API: true

Specified by:

setContextObj in interface ContextHolder

Parameters:

a_ContextObj -

getContextClassName

public String getContextClassName()

Deprecated.

Gets the value of the attribute: contextClassName; Context Object Name is the name of the class of the current page

Supported API: true

Specified by:

getContextClassName in interface ContextHolder

Returns:

String

setContextClassName

public void setContextClassName(String a_ContextClassName)

Deprecated.

Sets the value of the attribute: contextClassName; Context Object Name is the name of the class of the current page

Supported API: true

Specified by:

setContextClassName in interface ContextHolder

Parameters:

a_ContextClassName -

getContextProperties

public Properties getContextProperties()

Deprecated.

Gets the value of the attribute: contextProperties.

Supported API: true

Specified by:

getContextProperties in interface ContextHolder

Returns:

Properties

setContextProperties

public void setContextProperties(Properties a_ContextProperties)

Deprecated.

Sets the value of the attribute: contextProperties.

Supported API: true

Specified by:

setContextProperties in interface ContextHolder

Parameters:

a_ContextProperties -

getResponseExceptions

public Vector getResponseExceptions()

Deprecated.

Gets the value of the attribute: responseExceptions.

Supported API: true

Specified by:

getResponseExceptions in interface ContextHolder

Returns:

Vector

setResponseExceptions

public void setResponseExceptions(Vector a_ResponseExceptions)

Deprecated.

Sets the value of the attribute: responseExceptions.

Supported API: true

Specified by:

setResponseExceptions in interface ContextHolder

Parameters:

a_ResponseExceptions -

getResponseFooters

public Vector getResponseFooters()

Deprecated.

Gets the value of the attribute: responseFooters.

Supported API: true

Specified by:

getResponseFooters in interface ContextHolder

Returns:

Vector

setResponseFooters

public void setResponseFooters(Vector a_ResponseFooters)

Deprecated.

Sets the value of the attribute: responseFooters.

Supported API: true

Specified by:

setResponseFooters in interface ContextHolder

Parameters:

a_ResponseFooters -

getResponseHeaders

public Vector getResponseHeaders()

Deprecated.

Gets the value of the attribute: responseHeaders.

Supported API: true

Specified by:

getResponseHeaders in interface ContextHolder

Returns:

Vector

setResponseHeaders

public void setResponseHeaders(Vector a_ResponseHeaders)

Deprecated.

Sets the value of the attribute: responseHeaders.

Supported API: true

Specified by:

setResponseHeaders in interface ContextHolder

Parameters:

a_ResponseHeaders -

getResponseMessages

public Vector getResponseMessages()

Deprecated.

Gets the value of the attribute: responseMessages.

Supported API: true

Specified by:

getResponseMessages in interface ContextHolder

Returns:

Vector

setResponseMessages

public void setResponseMessages(Vector a_ResponseMessages)

Deprecated.

Sets the value of the attribute: responseMessages.

Supported API: true

Specified by:

setResponseMessages in interface ContextHolder

Parameters:

a_ResponseMessages -

getResponseString

public String getResponseString()

Deprecated.

Gets the value of the attribute: responseString.

Supported API: true

Specified by:

getResponseString in interface ContextHolder

Returns:

String

setResponseString

public void setResponseString(String a_ResponseString)

Deprecated.

Sets the value of the attribute: responseString.

Supported API: true

Specified by:

setResponseString in interface ContextHolder

Parameters:

a_ResponseString -

getStatus

public int getStatus()

Deprecated.

Gets the value of the attribute: status.

Supported API: true

Specified by:

getStatus in interface ContextHolder

Returns:

int

setStatus

public void setStatus(int a_Status)

Deprecated.

Sets the value of the attribute: status.

Supported API: true

Specified by:

setStatus in interface ContextHolder

Parameters:

a_Status -

getFormData

public Properties getFormData()

Deprecated.

Gets the value of the attribute: formData; Form Data is the data present in the form of the current HTML page.

Supported API: true

Specified by:

getFormData in interface ContextHolder

Returns:

Properties

setFormData

public void setFormData(Properties a_FormData)

Deprecated.

Sets the value of the attribute: formData; Form Data is the data present in the form of the current HTML page.

Supported API: true

Specified by:

setFormData in interface ContextHolder

Parameters:

a_FormData -

getQueryData

public Properties getQueryData()

Deprecated.

Gets the value of the attribute: queryData; Query Data is the information present after the "?" mark on the URL of the current page.

Supported API: true

Specified by:

getQueryData in interface ContextHolder

Returns:

Properties

setQueryData

public void setQueryData(Properties a_QueryData)

Deprecated.

Sets the value of the attribute: queryData; Query Data is the information present after the "?" mark on the URL of the current page.

Supported API: true

Specified by:

setQueryData in interface ContextHolder

Parameters:

a_QueryData -

getLocalizedPrintWriter

public static PrintWriter getLocalizedPrintWriter(OutputStream out,
                                                  Locale locale)

Deprecated.

Get a PrintWriter for the given output stream and locale. Template processing uses a special output stream that allows reuse of a shared print writer and writes to the output stream using a character encoding determined from the locale of the template file resource. Therefore, all template processor methods should call this method when they need a print writer for writing text to their output stream.

Supported API: true

Parameters:

out - the output stream passed to the processing method

locale - the locale passed to the processing method

Returns:

PrintWriter the print writer to use for writing text to the output stream

getPrintWriter

public PrintWriter getPrintWriter(OutputStream out,
                                  Locale locale)

Deprecated.

Get a PrintWriter for the given output stream and locale. Template processing uses a special output stream that allows reuse of a shared print writer and writes to the output stream using a character encoding determined from the locale of the template file resource. Therefore, all template processor methods should call this method when they need a print writer for writing text to their output stream.

Supported API: true

Parameters:

out - the output stream passed to the processing method

locale - the locale passed to the processing method

Returns:

PrintWriter the print writer to use for writing text to the output stream

getEncoding

public String getEncoding(OutputStream out,
                          Locale locale)

Deprecated.

Get character encoding that should be used with the template processing output stream.

Supported API: true

Parameters:

out - the output stream passed to the processing method

locale - the locale passed to the processing method

Returns:

the encoding name

objectIdentification

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

Deprecated.

Produces HTML which represents identification information for the contextual object of a BasicTemplateProcessor.

It is expected that this method will be invoked as a result of an objectIdentification script call in an HTML template file. The format of objectIdentification script calls is:

objectIdentification [mode="Brief"|"Verbose"] [includeURL="url-property-name"]

mode

The mode parameter determines the detail provided by the template file. It defaults to "Verbose".

includeURL

The includeURL parameter is not currently defined. It defaults to "HtmlView".

Example:

objectIdentification mode=Brief

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 objectIdentification script call within a higher level HTML template. Currently the template file is chosen from either the ObjectIdentificationVerbose or ObjectIdentificationBrief directories. Within those directories 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
 

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

getOITemplate

private HTMLTemplate getOITemplate(String mode,
                                   Locale locale)
                            throws WTException

Deprecated.

Return an initialized HTMLTemplate.

Parameters:

mode - Description of the Parameter

locale - Description of the Parameter

Returns:

The oITemplate value

Throws:

WTException - Description of the Exception

getOITemplateName

private String getOITemplateName(String mode)

Deprecated.

Gets the oITemplateName attribute of the BasicTemplateProcessor object

Parameters:

mode - Description of the Parameter

Returns:

The oITemplateName value

objectPropertyValue

public void objectPropertyValue(Properties parameters,
                                Locale locale,
                                OutputStream os)
                         throws IllegalAccessException,
                                InvocationTargetException,
                                WTIntrospectionException,
                                WTException

Deprecated.

Outputs HTML which represents the value of a property. The set of available properties are those that can be retrieved by the WTIntrospector class.

It is expected that this method will be invoked as a result of an objectPropertyValue script call in an HTML template file. The format of objectPropertyValue script calls is:

objectPropertyValue propertyName="propertyName"

propertyName

The propertyName parameter is the name of a property.

Example:

objectPropertyValue propertyName=requester

The format of the HTML that is output is dependent on the type of the property value.
Caution: This method will return "&nbsp;" for null property values. Also, if the MethodContext contains the property "preserveFormatting=true", characters with special meaning or treatment in HTML will be encoded to display properly in browsers. For example, '>' will be encoded as "&gt;" and a carriage return will be encoded as "<BR>." The preserveFormatting flag can be set using the Windchill script method DefaultTemplateProcessor.setMethodContextProperty().

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

IllegalAccessException - Description of the Exception

InvocationTargetException - Description of the Exception

WTIntrospectionException - Description of the Exception

WTException - Description of the Exception

objectPropertyValueAux

public void objectPropertyValueAux(Properties parameters,
                                   Locale locale,
                                   PrintWriter out)
                            throws IllegalAccessException,
                                   InvocationTargetException,
                                   WTIntrospectionException,
                                   WTException

Deprecated.

A utility method that implements some of the basic functionality needed by objectPropertyValue().

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

out - Description of the Parameter

Throws:

IllegalAccessException - Description of the Exception

InvocationTargetException - Description of the Exception

WTIntrospectionException - Description of the Exception

WTException - Description of the Exception

objectPropertyValueAux2

public void objectPropertyValueAux2(Properties parameters,
                                    Locale locale,
                                    PrintWriter out,
                                    String propertyName)
                             throws IllegalAccessException,
                                    InvocationTargetException,
                                    WTIntrospectionException,
                                    WTException

Deprecated.

A utility method that implements some of the basic functionality needed by objectPropertyValue().

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

out - Description of the Parameter

propertyName - Description of the Parameter

Throws:

IllegalAccessException - Description of the Exception

InvocationTargetException - Description of the Exception

WTIntrospectionException - Description of the Exception

WTException - Description of the Exception

objectPropertyValueString

protected String objectPropertyValueString(String propertyName,
                                           Properties parameters,
                                           Locale locale)
                                    throws WTIntrospectionException,
                                           WTException

Deprecated.

A utility method that implements some of the basic functionality needed by objectPropertyValue().

Supported API: false

Parameters:

propertyName - Description of the Parameter

parameters - Description of the Parameter

locale - Description of the Parameter

Returns:

Description of the Return Value

Throws:

WTIntrospectionException - Description of the Exception

WTException - Description of the Exception

getObjectPropertyValueString

protected String getObjectPropertyValueString(String propertyName,
                                              Properties parameters,
                                              Locale locale,
                                              Object obj)
                                       throws WTIntrospectionException,
                                              WTException

Deprecated.

A utility method that implements some of the basic functionality needed by objectPropertyValue(). This method can be called in the java code of TemplateProcessors to retrieve the value of an attribute associated with the context object of that TemplateProcessor.

Supported API: false

Parameters:

propertyName - Description of the Parameter

parameters - Description of the Parameter

locale - Description of the Parameter

obj - Description of the Parameter

Returns:

The objectPropertyValueString value

Throws:

WTIntrospectionException - Description of the Exception

WTException - Description of the Exception

getObjectPropertyValueString

protected String getObjectPropertyValueString(String propertyName,
                                              Properties parameters,
                                              Locale locale,
                                              Object obj,
                                              boolean warn)
                                       throws WTIntrospectionException,
                                              WTException

Deprecated.

Returns the String value of the attribute specified by the given property name on the given object. Additional information on how to return the property may optionally be given in the Properties parameter. For example, if the given property has a type of VersionInfo, whether or not the returned version information contains the iteration can be specified in the Properties object. The following are key-value pairs currently checked: Property Type Key Value Result versionInfo version_info qualified contains the iteration WTPrincipalReference email true principal name is returned as link to e-mail

Caution: This method will return "&nbsp;" for null property values. Also, if the MethodContext contains the property "preserveFormatting=true", characters with special meaning or treatment in HTML will be encoded to display properly in browsers. For example, '>' will be encoded as "&gt;" and a carriage return will be encoded as "<BR>." The preserveFormatting flag can be set using the Windchill script method DefaultTemplateProcessor.setMethodContextProperty().
Supported API: false

Parameters:

propertyName - the name of the property whose value is returned

parameters - a Properties object containing key-value pairs which provide more information in retrieving the property value.

locale - the Locale in which the result should be formatted

obj - the object from which the property value is retrieved

warn - if true, when an exception occurs, the returned string will contain the text of the exception.

Returns:

The objectPropertyValueString value

Throws:

WTIntrospectionException - Description of the Exception

WTException - Description of the Exception

removeEnclosingQuotes

private String removeEnclosingQuotes(String value)

Deprecated.

Utility method to remove any enclosing quotes from the given String.

Parameters:

value - the String from which to remove quotes

Returns:

the String with any enclosing quotes removed.

objectPropertyName

public void objectPropertyName(Properties parameters,
                               Locale locale,
                               OutputStream os)
                        throws IllegalAccessException,
                               InvocationTargetException,
                               WTIntrospectionException,
                               WTException

Deprecated.

Outputs HTML which represents the display name of a property. The set of available properties are those that can be retrieved by the WTIntrospector class.

It is expected that this method will be invoked as a result of an objectPropertyName script call in an HTML template file. The format of objectPropertyName script calls is:

objectPropertyName propertyName="propertyName"

propertyName

The propertyName parameter is the name of a property.

Example:

objectPropertyName propertyName=requester

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

IllegalAccessException - Description of the Exception

InvocationTargetException - Description of the Exception

WTIntrospectionException - Description of the Exception

WTException - Description of the Exception

objectPropertyNameAux

public void objectPropertyNameAux(Properties parameters,
                                  Locale locale,
                                  PrintWriter out)
                           throws WTIntrospectionException

Deprecated.

A utility method that implements some of the basic functionality needed by objectPropertyName().

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

out - Description of the Parameter

Throws:

WTIntrospectionException - Description of the Exception

objectPropertyNameAux2

public void objectPropertyNameAux2(Properties parameters,
                                   Locale locale,
                                   PrintWriter out,
                                   String propertyName)

Deprecated.

A utility method that implements some of the basic functionality needed by objectPropertyName().

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

out - Description of the Parameter

propertyName - Description of the Parameter

objectProperties

public void objectProperties(Properties parameters,
                             Locale locale,
                             OutputStream os)
                      throws IllegalAccessException,
                             InvocationTargetException,
                             WTIntrospectionException,
                             WTException

Deprecated.

A utility method for use during development and testing.

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

IllegalAccessException - Description of the Exception

InvocationTargetException - Description of the Exception

WTIntrospectionException - Description of the Exception

WTException - Description of the Exception

objectActionLink

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

Deprecated.

Outputs an HTML HREF with a URL to the wt.enterprise.URLProcessor class and its URLTemplateAction method. The URL will be created with two or three parameters, an action, oid (object ID) and label. The action and label are supplied as input parameters. The oid is that of the context object of the BasicTemplateProcessor instance.

It is expected that this method will be invoked as a result of an objectActionLink script call in an HTML template file. The format of objectActionLink script calls is:

objectActionLink action="action" [label="label"] [labelPropertyName="labelPropertyName"

action

The action parameter is the action to take on the contextual object. The action is defined in the resource service used by the URLProcessor class.

label

By default, the label generated for the URL is the concatenation of the businessType and identity properties of the contextual object. This optional label will override the default.

labelPropertyName

By specifying a labelPropertyName, the value of the property will be used to override the default label.

Example:

objectActionLink action=ObjProps label=Context1

objectActionLink action=ObjProps labelPropertyName=requester

objectActionLink action=ObjProps

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

objectActionLinkAux

public static String objectActionLinkAux(Object obj,
                                         String action,
                                         String label,
                                         Locale locale)
                                  throws WTException

Deprecated.

A utility method that implements some of the basic functionality needed by objectActionLink(). Returns a String representation of a URL to the specified action on the specified object. This method creates a URL to the given action on the given object with the given label as the link text via the URLProcessor.

Supported API: false

Parameters:

obj - the Object to be the context object of the link

action - the action to link to (i.e. ObjProps)

label - the label to use as the text of the HREF link

locale - Description of the Parameter

Returns:

a String representation of the URL formed

Throws:

WTException - Description of the Exception

objectActionLinkAux

public static String objectActionLinkAux(Object obj,
                                         String action,
                                         String label,
                                         Locale locale,
                                         boolean inline)
                                  throws WTException

Deprecated.

A utility method that implements some of the basic functionality needed by objectActionLink(). Returns a String representation of a URL to the specified action on the specified object. This method creates a URL to the given action on the given object with the given label as the link text via the URLProcessor.

Supported API: false

Parameters:

obj - the Object to be the context object of the link

action - the action to link to (i.e. ObjProps)

label - the label to use as the text of the HREF link

locale - Description of the Parameter

inline - Description of the Parameter

Returns:

a String representation of the URL formed

Throws:

WTException - Description of the Exception

objectActionLinkAux

public static String objectActionLinkAux(Object obj,
                                         String action,
                                         String label,
                                         String href_props,
                                         Locale locale)
                                  throws WTException

Deprecated.

A utility method that implements some of the basic functionality needed by objectActionLink(). Returns a String representation of a URL to the specified action on the specified object. This method creates a URL to the given action on the given object with the given label as the link text and the given String HTML to include in the HREF tag.

Supported API: false

Parameters:

obj - the Object to be the context object of the link

action - the action to link to (i.e. ObjProps)

label - the label to use as the text of the HREF link

href_props - a String containing HTML code to be used in the HREF tags.

locale - Description of the Parameter

Returns:

a String representation of the URL formed

Throws:

WTException - Description of the Exception

objectActionLinkAux

public static String objectActionLinkAux(Object obj,
                                         String action,
                                         String label,
                                         Properties params,
                                         Locale locale)
                                  throws WTException

Deprecated.

A utility method that implements some of the basic functionality needed by objectActionLink().

Supported API: false

Parameters:

obj - Description of the Parameter

action - Description of the Parameter

label - Description of the Parameter

params - Description of the Parameter

locale - Description of the Parameter

Returns:

Description of the Return Value

Throws:

WTException - Description of the Exception

objectActionLinkAux

public static String objectActionLinkAux(Object obj,
                                         String action,
                                         String label,
                                         Properties params,
                                         String href_props,
                                         Locale locale)
                                  throws WTException

Deprecated.

A utility method that implements some of the basic functionality needed by objectActionLink().

Supported API: false

Parameters:

obj - Description of the Parameter

action - Description of the Parameter

label - Description of the Parameter

params - Description of the Parameter

href_props - Description of the Parameter

locale - Description of the Parameter

Returns:

Description of the Return Value

Throws:

WTException - Description of the Exception

getURLFactory

protected static URLFactory getURLFactory()

Deprecated.

This method should be used ONLY for static methods for legacy processor support. Instance methods should obtain URLFactory by a call to getState().getURLFactory().

Returns:

The uRLFactory value

objectActionLinkAux

public static String objectActionLinkAux(Object obj,
                                         String action,
                                         String label,
                                         Properties params,
                                         String href_props,
                                         Locale locale,
                                         boolean inline)
                                  throws WTException

Deprecated.

A utility method that implements some of the basic functionality needed by objectActionLink().

Supported API: false

Parameters:

obj - Description of the Parameter

action - Description of the Parameter

label - Description of the Parameter

params - Description of the Parameter

href_props - Description of the Parameter

locale - Description of the Parameter

inline - Description of the Parameter

Returns:

Description of the Return Value

Throws:

WTException - Description of the Exception

objectActionLinkAux

public static String objectActionLinkAux(WTReference obj_ref,
                                         String action,
                                         String label,
                                         Properties params,
                                         String href_props,
                                         Locale locale)
                                  throws WTException

Deprecated.

A utility method that implements some of the basic functionality needed by objectActionLink(). Returns a String containing the HTML code to create a link (HREF) to the given action with the given label on the object associated with the given WTReference. Additional parameters to be added to the query string of the link are specified in the given Properties object. Additional HTML code to be used in creating the link is specified in the given href_props String.

Supported API: false

Parameters:

obj_ref - the WTReference to the object which is to be associated as the context object for the link

action - the action to link to

label - the label to use as the text of the link

params - Properties to be included on the query string of the link

href_props - Additional HTML to be included in the link

locale - the Locale of the client in which this link will be displayed

Returns:

Description of the Return Value

Throws:

WTException - Description of the Exception

objectBackground

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

Deprecated.

Outputs HTML to set the background of the page to a supplied image. The image file used must be supplied as a parameter and is expected to be in $(wt.server.codebase)/wt/clients/images/.

It is expected that this method will be invoked as a result of an objectBackground script call in an HTML template file. The format of objectBackground script calls is:

objectBackground image="image"

image

The image parameter is the image file name to use as the background.

Example:

objectBackground image=background_gray.gif

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

currentTimestamp

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

Deprecated.

Outputs HTML that describes the current date and time.

It is expected that this method will be invoked as a result of an currentTimestamp script call in an HTML template file. The format of currentTimestamp script calls is:

currentTimestamp

Example:

currentTimestamp

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

objectIdentifier

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

Deprecated.

Outputs an object identifier of the form "wt.doc.General:2472".

It is expected that this method will be invoked as a result of an objectIdentifier script call in an HTML template file. The format of objectIdentifier script calls is:

objectIdentifier

Example:

objectIdentifier

Supported API: false

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

getBaselineItems

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

Deprecated.

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

partUsedBy

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

Deprecated.

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

getUsedByLinks

public WTPartUsageLink[] getUsedByLinks()
                                 throws WTException

Deprecated.

Supported API: false

Returns:

The usedByLinks value

Throws:

WTException - Description of the Exception

listContent

public void listContent(Properties parameters,
                        Locale locale,
                        OutputStream os)
                 throws WTException,
                        PropertyVetoException,
                        InvocationTargetException,
                        IllegalAccessException

Deprecated.

Outputs a table listing the content items (files and URLs) associated with the ContentHolder context object. If the current context object is not a ContentHolder, no output is generated.

Supported API: false

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

PropertyVetoException - Description of the Exception

InvocationTargetException - Description of the Exception

IllegalAccessException - Description of the Exception

appDataTableHeading

private String appDataTableHeading(Locale locale)

Deprecated.

Outputs the table headings for the Application Data (file content) table. This method is used by listContent to print the table of content items.

Supported API: false

Parameters:

locale - Description of the Parameter

Returns:

a String containing the HTML code to display the table headers for file content items.

urlTableHeading

private String urlTableHeading(Locale locale)

Deprecated.

Outputs the table headings for the URL table. This method is used by listContent to print the table of content items.

Supported API: false

Parameters:

locale - Description of the Parameter

Returns:

a String containing the HTML code to display the table headers for URL content items.

parameterValue

public String parameterValue(Properties params,
                             String paramName)
                      throws WTException

Deprecated.

Supported API: false

Parameters:

params - Description of the Parameter

paramName - Description of the Parameter

Returns:

Description of the Return Value

Throws:

WTException - Description of the Exception

displayAllCabinets

public void displayAllCabinets(Properties parameters,
                               Locale locale,
                               OutputStream os)
                        throws PropertyVetoException,
                               InvocationTargetException,
                               IllegalAccessException,
                               WTException

Deprecated.

Outputs a table displaying all of the cabinets for which the current user has read permissions.

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

PropertyVetoException - Description of the Exception

InvocationTargetException - Description of the Exception

IllegalAccessException - Description of the Exception

WTException - Description of the Exception

getAllCabinets

private SortedEnumeration getAllCabinets(String permission)
                                  throws QueryException,
                                         WTException

Deprecated.

Returns all cabinets for which the current user has the given permission. If the given permission is null, all cabinets for which the current user has read permissions will be returned. The cabinets are returned in a SortedEnumeration which is sorted according to identity of the cabinet.

Parameters:

permission - optional String permission which determines what cabinets are retrieved; if not given, all cabinets for which the user has read permission is returned

Returns:

a SortedEnumeration containing all cabinets for which the current user has the given permission.

Throws:

QueryException - Description of the Exception

WTException - Description of the Exception

displayFolderContents

public void displayFolderContents(Properties parameters,
                                  Locale locale,
                                  OutputStream os)
                           throws WTException,
                                  PropertyVetoException,
                                  InvocationTargetException,
                                  IllegalAccessException

Deprecated.

Displays the contents of the folder context object.

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

PropertyVetoException - Description of the Exception

InvocationTargetException - Description of the Exception

IllegalAccessException - Description of the Exception

getFolderContents

private SortedEnumeration getFolderContents()

Deprecated.

Retrieve the folder contents of the folder context object. If the current context object is not a folder, this method returns a null SortedEnumeration

Supported API: false

Returns:

a SortedEnumeration of the contents associated with the folder context object, or null if the context object is not a folder

retrieveFolderContents

private SortedEnumeration retrieveFolderContents()
                                          throws WTException

Deprecated.

Retrieve the folder contents of the folder context object. If the current context object is not a folder, this method returns a null SortedEnumeration

Supported API: false

Returns:

a SortedEnumeration of the contents associated with the folder context object, or null if the context object is not a folder

Throws:

WTException - Description of the Exception

getIconResource

public String getIconResource()
                       throws WTException,
                              PropertyVetoException,
                              InvocationTargetException,
                              IllegalAccessException

Deprecated.

Returns a String containing the URL to the icon for the context object. The returned URL is generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and an absolute URL is returned. This method does not take into consideration any glyphs that may be associated with the context object. If the context object is not a WTObject, an empty string is returned.

Supported API: false

Returns:

the String URL to the icon file of the context object

Throws:

WTException - if an error occurs retrieving the icon file

PropertyVetoException - if an error occurs retrieving the icon file

InvocationTargetException - if an error occurs retrieving the icon file

IllegalAccessException - if an error occurs retrieving the icon file

getIconResource

private static String getIconResource(WTObject obj,
                                      HTTPState a_State)
                               throws WTException,
                                      PropertyVetoException,
                                      InvocationTargetException,
                                      IllegalAccessException

Deprecated.

Returns a String containing the URL to the icon for the given WTObject. The returned URL is generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and an absolute URL is returned. This method does not take into consideration any glyphs that may be associated with the given object.

Supported API: false

Parameters:

obj - the WTObject whose icon is desired (input)

a_State - HTTPState object associated with the current page (input)

Returns:

the String URL to the icon file of the given WTObject

Throws:

WTException - if an error occurs retrieving the icon file

PropertyVetoException - if an error occurs retrieving the icon file

InvocationTargetException - if an error occurs retrieving the icon file

IllegalAccessException - if an error occurs retrieving the icon file

getIconResource

public static String getIconResource(Object obj,
                                     HTTPState a_State)
                              throws WTException,
                                     PropertyVetoException,
                                     InvocationTargetException,
                                     IllegalAccessException

Deprecated.

Returns a String containing the URL to the icon for the given WTObject or class. The returned URL is generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and an absolute URL is returned. This method does not take into consideration any glyphs that may be associated with the given object.

Supported API: false

Parameters:

obj - The object whose icon image is desired (input)

a_State - The HTTPState object associated with the current page (input)

Returns:

The URL for the icon file

Throws:

WTException - if an error occurs retrieving the icon file

PropertyVetoException - if an error occurs retrieving the icon file

InvocationTargetException - if an error occurs retrieving the icon file

IllegalAccessException - if an error occurs retrieving the icon file

getIconResource

private static String getIconResource(WTObject obj,
                                      HTTPState a_State,
                                      boolean forceFullyQualified)
                               throws WTException,
                                      PropertyVetoException,
                                      InvocationTargetException,
                                      IllegalAccessException

Deprecated.

Returns a String containing the URL to the icon for the given WTObject. The returned URL is generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and an absolute URL is returned. This method does not take into consideration any glyphs that may be associated with the given object.

Supported API: false

Parameters:

obj - the WTObject whose icon is desired (input)

a_State - The HTTPState object associated with the current page (input)

Returns:

the String URL to the icon file of the given WTObject

Throws:

WTException - if an error occurs retrieving the icon file

PropertyVetoException - if an error occurs retrieving the icon file

InvocationTargetException - if an error occurs retrieving the icon file

IllegalAccessException - if an error occurs retrieving the icon file

getIconResource

private static String getIconResource(Class obj_class)
                               throws WTException,
                                      PropertyVetoException,
                                      InvocationTargetException,
                                      IllegalAccessException

Deprecated.

Returns a String containing the URL to the icon for the given class. The returned URL is generated using the URLFactory in the Method Context, if any. If none is present, a new URLFactory is used and an absolute URL is returned. This method does not take into consideration any glyphs that may be associated with the given object.

Supported API: false

Parameters:

obj_class - the Class whose icon is desired (input)

Returns:

the String URL to the icon file of the given Class

Throws:

WTException - if an error occurs retrieving the icon file

PropertyVetoException - if an error occurs retrieving the icon file

InvocationTargetException - if an error occurs retrieving the icon file

IllegalAccessException - if an error occurs retrieving the icon file

getIconResource

public static String getIconResource(IconSelector iconSelector,
                                     boolean forceFullyQualified)

Deprecated.

Returns a String containing the URL to the icon for the given class. The returned URL is generated using the URLFactory in the Method Context, if any. If none is present, a new URLFactory is used and an absolute URL is returned. This method does not take into consideration any glyphs that may be associated with the given object.

Supported API: false

Parameters:

iconSelector - IconSelector containing the icon image file name (input)

forceFullyQualified - true if a fully qualified URL is needed, false if not (input)

Returns:

the String URL to the icon file of the given Class

Throws:

WTException - if an error occurs retrieving the icon file

PropertyVetoException - if an error occurs retrieving the icon file

InvocationTargetException - if an error occurs retrieving the icon file

IllegalAccessException - if an error occurs retrieving the icon file

getIconSelector

public static IconSelector getIconSelector(WTObject obj,
                                           HTTPState a_State,
                                           String sharedFrom,
                                           String sharedTo,
                                           WTContainer contextContainer)
                                    throws WTException,
                                           PropertyVetoException,
                                           InvocationTargetException,
                                           IllegalAccessException

Deprecated.

Returns an IconSelector for the given object. The IconSelector contains the icon image file name and the names of the appropriate glyphs.
Supported API: false

Parameters:

obj - the WTObject whose icon is desired (input)

a_State - The HTTPState object associated with the current page (input)

sharedFrom - The following values are recognized:

• IconDelegate.DISPLAY_SHARED_FROM_GLYPH - display a glyph on the icon indicating the object has been shared into the current container from another container
• IconDelegate.NO_SHARED_FROM_GLYPH - don't display a glyph indicating the object has been shared into the container from another container
• IconDelegate.COMPUTE_SHARED_FROM_GLYPH - using the value of the currentContainerContext, determine if the object has been shared into the current container from another container and display the shared-from glyph if it has.

sharedTo - The following values are recognized:

• IconDelegate.DISPLAY_SHARED_TO_GLYPH - display a glyph on the icon indicating the object has been shared to another container by its owning container
• IconDelegate.NO_SHARED_TO_GLYPH - don't display a glyph indicating the object has been shared to another container
• IconDelegate.COMPUTE_SHARED_TO_GLYPH - if obj is a SubFolder and the currentContainerContext is the objects's owning container determine if the object has been shared to another container and display the shared-to glyph if it has. This computation requires a database query.

contextContainer - The container forming the context from which the object is being viewed. Required if sharedFrom = COMPUTE_SHARED_FROM_GLYPH or sharedTo = COMPUTE_SHARED_TO_GLYPH. Otherwise may be null.

Returns:

IconSelector

Throws:

WTException - if an error occurs retrieving the icon file

PropertyVetoException - if an error occurs retrieving the icon file

InvocationTargetException - if an error occurs retrieving the icon file

IllegalAccessException - if an error occurs retrieving the icon file

getFolderTableHeading

private static String getFolderTableHeading(Locale locale)

Deprecated.

Returns a String containing the HTML code to display the heading for the folder contents table. This method is used by displayFolderContents to display the contents of a folder.

Supported API: false

Parameters:

locale - Description of the Parameter

Returns:

the string containing the HTML code to display the heading for the table of folder contents.

getAttrValue

private static String getAttrValue(Object obj,
                                   String attr)

Deprecated.

Returns the String value of the given attribute on the given object. This method uses introspection to find the value of the given attribute on the given object.

Supported API: false

Parameters:

obj - the object for which the attribute value is returned

attr - the attribute whose value is to be returned

Returns:

the String value of the given attribute on the given object

getDisplayName

protected static String getDisplayName(Class class_name,
                                       String attr,
                                       Locale locale)

Deprecated.

Returns the display name corresponding to the given attribute for the given class. This method uses introspection to retrieve the display name of the given attribute for the given class.

Supported API: false

Parameters:

class_name - the Class which contains the attribute whose display name is returned

attr - the attribute whose display name is returned

locale - Description of the Parameter

Returns:

the display name of the given attribute

getClassInfo

protected static ClassInfo getClassInfo(Class class_name)

Deprecated.

Returns the ClassInfo object corresponding to the given Class. If an error occurs retrieving the ClassInfo, null is returned.

Supported API: false

Parameters:

class_name - the class for which the ClassInfo is returned

Returns:

the ClassInfo corresponding to the given class, or null if an error occurs retrieving the ClassInfo

getFolderLocation

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

Deprecated.

Prints the folder location of the FolderEntry context object to the given OutputStream. If the context object is not a FolderEntry object, nothing is output

Supported API: false

Parameters:

parameters - the Properties passed in when this method is invoked. This parameter is not used

locale - the Locale of the client

os - the OutputStream which the folder location is written to

getFolderPath

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

Deprecated.

Prints the folder path of the FolderEntry context object to the given OutputStream. If the context object is not a FolderEntry object, nothing is output

Supported API: false

Parameters:

parameters - the Properties passed in when this method is invoked. This parameter is not used

locale - the Locale of the client

os - the OutputStream which the folder path is written to

getDomainPath

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

Deprecated.

Gets the domainPath attribute of the BasicTemplateProcessor object

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

getObjectIconImgTag

public static String getObjectIconImgTag(WTObject obj)
                                  throws WTException,
                                         PropertyVetoException,
                                         InvocationTargetException,
                                         IllegalAccessException

Deprecated.

Gets the HTML tag(s) to display the icon and glyphs associated with a given object. The urls to the icon image file(s) are generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and absolute URLs are returned.

Parameters:

obj - The object whose icon is desired

Returns:

One or more image tags for the icon and glyphs of the given object

Throws:

WTException - Description of the Exception

PropertyVetoException - Description of the Exception

InvocationTargetException - Description of the Exception

IllegalAccessException - Description of the Exception

getObjectIconImgTag

public static String getObjectIconImgTag(WTObject obj,
                                         boolean forceFullyQualified)
                                  throws WTException,
                                         PropertyVetoException,
                                         InvocationTargetException,
                                         IllegalAccessException

Deprecated.

Gets the HTML tag(s) to display the icon and glyphs associated with a given object. The urls to the icon image file(s) are generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and absolute URLs are returned.

Parameters:

obj - Object whose icon is desired

forceFullyQualified - True if image urls must be fully qualified regardless of the state of the existing URLFactory, if any

Returns:

One or more image tags for the icon and glyphs associated with the given object

Throws:

WTException - Description of the Exception

PropertyVetoException - Description of the Exception

InvocationTargetException - Description of the Exception

IllegalAccessException - Description of the Exception

getObjectIconImgTag

public static String getObjectIconImgTag(WTObject obj,
                                         String backgroundColor)
                                  throws WTException,
                                         PropertyVetoException,
                                         InvocationTargetException,
                                         IllegalAccessException

Deprecated.

Gets the HTML tag(s) to display the icon and glyphs associated with a given object. The urls to the icon image file(s) are generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and absolute URLs are returned.
Supported API: false

Parameters:

obj - The WTObject whose icon is desired

backgroundColor - Background color. Optional. Used for drag and drop.

Returns:

a String containing the HTML code to display the icon and glyphs associated with the given WTObject.

Throws:

WTException - if an error occurs retrieving the icon

PropertyVetoException - if an error occurs retrieving the icon

InvocationTargetException - if an error occurs retrieving the icon

IllegalAccessException - if an error occurs retrieving the icon

getObjectIconImgTag

public static String getObjectIconImgTag(WTObject obj,
                                         String sharedFrom,
                                         String sharedTo,
                                         WTContainer currentContainerContext)
                                  throws WTException,
                                         PropertyVetoException,
                                         InvocationTargetException,
                                         IllegalAccessException

Deprecated.

Gets the HTML tag(s) to display the icon and glyphs associated with a given object. The urls to the icon image file(s) are generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and absolute URLs are returned.
If object type is draggable and the drag and drop preference is on, the HTML will be an applet tag with the object icon. Otherwise, the HTML will be an IMG tag with the object icon.

Supported API: false

Parameters:

obj - Object whose icon is desired. Required.

sharedFrom - The following values are recognized:

• IconDelegate.DISPLAY_SHARED_FROM_GLYPH - display a glyph on the icon indicating the object has been shared into the current container from another container
• IconDelegate.NO_SHARED_FROM_GLYPH - don't display a glyph indicating the object has been shared into the container from another container
• IconDelegate.COMPUTE_SHARED_FROM_GLYPH - using the value of the currentContainerContext, determine if the object has been shared into the current container from another container and display the shared-from glyph if it has.

sharedTo - The following values are recognized:

• IconDelegate.DISPLAY_SHARED_TO_GLYPH - display a glyph on the icon indicating the object has been shared to another container by its owning container
• IconDelegate.NO_SHARED_TO_GLYPH - don't display a glyph indicating the object has been shared to another container
• IconDelegate.COMPUTE_SHARED_TO_GLYPH - if obj is a SubFolder and the currentContainerContext is the objects's owning container determine if the object has been shared to another container and display the shared-to glyph if it has. This computation requires a database query.

currentContainerContext - The container forming the context from which the object is being viewed. Required if sharedFrom = COMPUTE_SHARED_FROM_GLYPH or sharedTo = COMPUTE_SHARED_TO_GLYPH. Otherwise may be null.

Returns:

applet or img tag

Throws:

WTException - Description of the Exception

PropertyVetoException - Description of the Exception

InvocationTargetException - Description of the Exception

IllegalAccessException - Description of the Exception

getObjectIconImgTag

public static String getObjectIconImgTag(WTObject obj,
                                         String sharedFrom,
                                         String sharedTo,
                                         WTContainer currentContainerContext,
                                         boolean forceFullyQualified)
                                  throws WTException,
                                         PropertyVetoException,
                                         InvocationTargetException,
                                         IllegalAccessException

Deprecated.

Gets the HTML tag(s) to display the icon and glyphs associated with a given object. The urls to the icon image file(s) are generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and absolute URLs are returned.
If object type is draggable and the drag and drop preference is on, the HTML will be an applet tag with the object icon. Otherwise, the HTML will be one or more IMG tags for the object icon and glyphs.

Supported API: false

Parameters:

obj - Object whose icon is desired. Required.

sharedFrom - The following values are recognized:

• IconDelegate.DISPLAY_SHARED_FROM_GLYPH - display a glyph on the icon indicating the object has been shared into the current container from another container
• IconDelegate.NO_SHARED_FROM_GLYPH - don't display a glyph indicating the object has been shared into the container from another container
• IconDelegate.COMPUTE_SHARED_FROM_GLYPH - using the value of the currentContainerContext, determine if the object has been shared into the current container from another container and display the shared-from glyph if it has.

sharedTo - The following values are recognized:

• IconDelegate.DISPLAY_SHARED_TO_GLYPH - display a glyph on the icon indicating the object has been shared to another container by its owning container
• IconDelegate.NO_SHARED_TO_GLYPH - don't display a glyph indicating the object has been shared to another container
• IconDelegate.COMPUTE_SHARED_TO_GLYPH - if obj is a SubFolder and the currentContainerContext is the objects's owning container determine if the object has been shared to another container and display the shared-to glyph if it has. This computation requires a database query.

currentContainerContext - The container forming the context from which the object is being viewed. Required if sharedFrom = COMPUTE_SHARED_FROM_GLYPH or sharedTo = COMPUTE_SHARED_TO_GLYPH. Otherwise may be null.

forceFullyQualified - if true, returns the fully qualified url for the icon

Returns:

applet or img tag

Throws:

WTException - Description of the Exception

PropertyVetoException - Description of the Exception

InvocationTargetException - Description of the Exception

IllegalAccessException - Description of the Exception

getObjectIconImgTag

private static String getObjectIconImgTag(WTObject obj,
                                          String backgroundColor,
                                          HTTPState a_State)
                                   throws WTException,
                                          PropertyVetoException,
                                          InvocationTargetException,
                                          IllegalAccessException

Deprecated.

Gets the HTML tag(s) to display the icon and glyphs associated with a given object. The urls to the icon image file(s) are generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and absolute URLs are returned.

Parameters:

obj - Object whose icon is desired

backgroundColor - Background color. Optional. Used for drag and drop.

a_State - HTTPState object associated with the current page

Returns:

The objectIconImgTag value

Throws:

WTException - Description of the Exception

PropertyVetoException - Description of the Exception

InvocationTargetException - Description of the Exception

IllegalAccessException - Description of the Exception

getObjectIconImgTag

private static String getObjectIconImgTag(WTObject obj,
                                          String backgroundColor,
                                          ContentHolder holder,
                                          HTTPState a_State)
                                   throws WTException,
                                          PropertyVetoException,
                                          InvocationTargetException,
                                          IllegalAccessException

Deprecated.

Gets the HTML tag(s) to display the icon and glyphs associated with a given object. The urls to the icon image file(s) are generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and absolute URLs are returned.

Parameters:

obj - Object whose icon is desired

backgroundColor - Background color. Optional. Used for drag and drop.

holder - Optional. Used for drag and drop.

a_State - HTTPState object associated with the current page

Returns:

one or more image tags

Throws:

WTException - Description of the Exception

PropertyVetoException - Description of the Exception

InvocationTargetException - Description of the Exception

IllegalAccessException - Description of the Exception

getObjectIconImgTag

private static String getObjectIconImgTag(WTObject obj,
                                          String backgroundColor,
                                          ContentHolder holder,
                                          HTTPState a_State,
                                          String sharedFrom,
                                          String sharedTo,
                                          WTContainer currentContainerContext)
                                   throws WTException,
                                          PropertyVetoException,
                                          InvocationTargetException,
                                          IllegalAccessException

Deprecated.

Gets the HTML tag(s) to display the icon and glyphs associated with a given object. The urls to the icon image file(s) are generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and absolute URLs are returned.

Parameters:

obj - Object whose icon is desired

backgroundColor - Background color. Optional. Used for drag and drop.

holder - Optional. Used for drag and drop.

a_State - HTTPState object associated with the current page

sharedFrom - The following values are recognized:

• IconDelegate.DISPLAY_SHARED_FROM_GLYPH - display a glyph on the icon indicating the object has been shared into the current container from another container
• IconDelegate.NO_SHARED_FROM_GLYPH - don't display a glyph indicating the object has been shared into the container from another container
• IconDelegate.COMPUTE_SHARED_FROM_GLYPH - using the value of the currentContainerContext, determine if the object has been shared into the current container from another container and display the shared-from glyph if it has.

sharedTo - The following values are recognized:

• IconDelegate.DISPLAY_SHARED_TO_GLYPH - display a glyph on the icon indicating the object has been shared to another container by its owning container
• IconDelegate.NO_SHARED_TO_GLYPH - don't display a glyph indicating the object has been shared to another container
• IconDelegate.COMPUTE_SHARED_TO_GLYPH - if obj is a SubFolder and the currentContainerContext is the objects's owning container determine if the object has been shared to another container and display the shared-to glyph if it has. This computation requires a database query.

currentContainerContext - The container forming the context from which the object is being viewed. Required if sharedFrom = COMPUTE_SHARED_FROM_GLYPH or sharedTo = COMPUTE_SHARED_TO_GLYPH. Otherwise may be null.

Returns:

one or more image tags

Throws:

WTException - Description of the Exception

PropertyVetoException - Description of the Exception

InvocationTargetException - Description of the Exception

IllegalAccessException - Description of the Exception

getObjectIconImgTag

private static String getObjectIconImgTag(WTObject obj,
                                          String backgroundColor,
                                          ContentHolder holder,
                                          HTTPState a_State,
                                          String sharedFrom,
                                          String sharedTo,
                                          WTContainer currentContainerContext,
                                          boolean forceFullyQualified)
                                   throws WTException,
                                          PropertyVetoException,
                                          InvocationTargetException,
                                          IllegalAccessException

Deprecated.

Gets the HTML tag(s) to display the icon and glyphs associated with a given object. The urls to the icon image file(s) are generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and absolute URLs are returned.
If object type is draggable and the drag and drop preference is on, the HTML will be an applet tag with the object icon. Otherwise, the HTML will be an IMG tag with the object icon.

Supported API: false

Parameters:

obj - Object whose icon is desired. Required.

backgroundColor - Background color. Optional. Used for drag and drop.

holder - Optional. Used for drag and drop. c *@param a_State State of the object

forceFullyQualified - get the fully qualified path of the icon

Returns:

applet or img tag

Throws:

WTException - Description of the Exception

PropertyVetoException - Description of the Exception

InvocationTargetException - Description of the Exception

IllegalAccessException - Description of the Exception

getObjectType

private static String getObjectType(WTObject obj)

Deprecated.

Returns a string for the type of the object (e.g. Part, Document), localized if possible

getGlyphTagsNoDnD

public static String getGlyphTagsNoDnD(WTObject obj,
                                       Vector glyphResources,
                                       boolean forceFullyQualified)
                                throws WTException

Deprecated.

Gets the tags for an object's icon glyphs (no drag and drop). A family table glyph is included for CAD documents, if appropriate. The urls to the icon image file(s) are generated using the URLFactory associated with the key "URLFactory" in the Method Context, if any. If none is present, a new URLFactory is used and absolute URLs are returned.

Parameters:

obj - Object whose glyphs are desired (input)

glyphResources - Glyph image file paths relative to codebase. If null and no family table glyph, an empty string will be returned. (input)

forceFullyQualified - True if urls to images must be fully qualifed regardless of the state of an existing URLFactory (input)

Returns:

Image tags referencing the input glyph image files (may be up to 4 tags in the string: 3 glyphs and family table icon

Throws:

WTException - Description of the Exception

getObjectIconGlyphs

public static Vector getObjectIconGlyphs(IconSelector selector,
                                         boolean doDnD)
                                  throws WTException

Deprecated.

Returns the image files for the glyphs for an object

Parameters:

selector - IconSelector containing the names of the glyphs to be used

doDnD - True if drag and drop glyphs should be returned

Returns:

Vector of strings containing the file paths of the glyphs relative to codebase

Throws:

WTException - Description of the Exception

isSandboxWorkingCopy

private static boolean isSandboxWorkingCopy(Versioned obj)
                                     throws WTException

Deprecated.

Gets the sandboxWorkingCopy attribute of the BasicTemplateProcessor class

Parameters:

obj - Description of the Parameter

Returns:

The sandboxWorkingCopy value

Throws:

WTException - Description of the Exception

getObjectIconDnDTag

public static String getObjectIconDnDTag(WTObject obj,
                                         String backgroundColor,
                                         ContentHolder holder)
                                  throws WTException,
                                         PropertyVetoException,
                                         InvocationTargetException,
                                         IllegalAccessException

Deprecated.

Gets the HTML applet tag(s) to display the drag icon and glyphs associated with a given object.

Parameters:

obj - Description of the Parameter

backgroundColor - Description of the Parameter

holder - Description of the Parameter

Returns:

The objectIconDnDTag value

Throws:

WTException - Description of the Exception

PropertyVetoException - Description of the Exception

InvocationTargetException - Description of the Exception

IllegalAccessException - Description of the Exception

getObjectIconImgTag

public static String getObjectIconImgTag(Class obj_class)
                                  throws WTException,
                                         PropertyVetoException,
                                         InvocationTargetException,
                                         IllegalAccessException

Deprecated.

Returns the HTML code to display the image corresponding to the given object class

Parameters:

obj_class - the object class for which the icon is returned

Returns:

the HTML code to display the image corresponding to the given object class

Throws:

WTException - if an error occurs retrieving the icon

PropertyVetoException - if an error occurs retrieving the icon

InvocationTargetException - if an error occurs retrieving the icon

IllegalAccessException - if an error occurs retrieving the icon

getGlyphImageTag

public static String getGlyphImageTag(WTObject object)

Deprecated.

Returns a String containing the HTML code to display the glyph associated with the object. This method returns only the HTML to display the glyph, and not to display the object icon with the glyph. This method only returns a single glyph, so, for example, if a shortcut to a checked out object is given, the shortcut glyph will be returned. This method does not compute sandbox glyphs.

Supported API: false

Parameters:

object - the WTObject for which the glyph is returned

Returns:

a String containing the HTML code to display the glyph; if no glyph is associated with the given object, an empty string is returned.

getObjectIcon

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

Deprecated.

Outputs the icon associated with the context object to the given OutputStream. This method will output the image including any glyphs that should be associated with it. DnD may be turned on/off.

Supported API: true

Parameters:

parameters - the Properties passed in when this method is invoked; this parameter is not used by this method

locale - the Locale in which the image will be displayed

os - the OutputStream to write the image to.

getShareImage

public static String getShareImage(Object obj)
                            throws WTException

Deprecated.

Returns the Share Image

Supported API: false

Parameters:

obj - Description of the Parameter

Returns:

a String containing the Share Image

Throws:

WTException - Description of the Exception

getShareImage

public String getShareImage()
                     throws WTException

Deprecated.

Gets the shareImage attribute of the BasicTemplateProcessor object

Returns:

The shareImage value

Throws:

WTException - Description of the Exception

getClassIcon

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

Deprecated.

Outputs the icon associated with the given class to the given OutputStream. The object class whose icon is output is given by value of the "object_class" parameter passed in the given Properties object. This method is typically invoked as a Windchill script call in an HTML template. The only script parameter currently supported is "object_class", which specifies the object class whose icon is displayed.

Supported API: false

Parameters:

parameters - the Properties passed in when this method is invoked; the Properties object should contain the object class

locale - the Locale in which the image will be displayed

os - the OutputStream to write the image to.

getParentFolderLink

protected String getParentFolderLink(CabinetBased cabinet_based,
                                     String label,
                                     Locale locale)

Deprecated.

Returns the String containing the HTML code to display a Hyperlink to the object properties page of the parent folder of the given FolderEntry object. If the label used as the text of the hyperlink is not given, this method will use the display identity of the parent folder.

Supported API: false

Parameters:

cabinet_based - the CabinetBased object for which the link to the properties page of the parent folder is returned

label - the String label to use as the link text. If no label is given, the display identity of the parent folder is used.

locale - the Locale in which the link will be displayed

Returns:

a String containing the HTML code to display a hyperlink to the object properties page of the parent folder.

createParentFolderLink

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

Deprecated.

Outputs a hyperlink to the object properties page of the parent folder of the context object. The hyperlink is output to the given OutputStream. If the current context object is not a FolderEntry object, no output is written to the stream.

Supported API: false

Parameters:

parameters - the Properties passed to the method when it is invoked via a Script call. This method does not use this parameter.

locale - the locale in which the hyperlink is displayed

os - the OutputStream to which the hyperlink is written

formatDate

public static String formatDate(int format,
                                Date time,
                                Locale locale)

Deprecated.

Formats the given with the given format type for the given locale. This method uses the WTStandardDateFormat to format the given date.

Supported API: false

Parameters:

format - the format type to use in formatting the given date

time - the Date to be formatted

locale - the Locale in which to format the date

Returns:

Description of the Return Value

See Also:

WTStandardDateFormat

getFileSize

private String getFileSize(ApplicationData file)

Deprecated.

Returns a String containing the size of the given file in Kilobytes. The string returned also contains the units (e.g "100 KB").

Supported API: false

Parameters:

file - the ApplicationData item whose size is returned

Returns:

a String containing the size of the file and the units.

roundToTwoDecimals

private float roundToTwoDecimals(float number)

Deprecated.

Returns the given float rounded to two decimal places.

Supported API: false

Parameters:

number - the float to be rounded

Returns:

the given number rounded to two decimal places

getPrincipalEmailLink

protected String getPrincipalEmailLink(WTPrincipalReference principal,
                                       String args)

Deprecated.

Returns a String containing the HTML code to display a mail-to hyperlink to the e-mail of the principal referenced by the given WTPrincipalReference. The display name of the principal is used as the text of the link. Any additional code to be used in formatting the HREF can be optionally given in the given args string.

Supported API: false

Parameters:

principal - the WTPrincipalReference referencing the principal for which a hyperlink to his/her e-mail is returned.

args - an optional string containing HTML code to be used in building the HREF link.

Returns:

the String containing the HTML code to display a hyperlink to the e-mail of the given principal.

getPrincipalEmailLink

protected String getPrincipalEmailLink(WTPrincipal principal,
                                       String args)

Deprecated.

Returns a String containing the HTML code to display a mail-to hyperlink to the e-mail of the given principal. The display name of the principal is used as the text of the link. Any additional code to be used in formatting the HREF can be optionally given in the given args string.

Supported API: false

Parameters:

principal - the WTPrincipal for which a hyperlink to his/her e-mail is returned.

args - an optional string containing HTML code to be used in building the HREF link.

Returns:

the String containing the HTML code to display a hyperlink to the e-mail of the given principal.

createNavigationBar

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

Deprecated.

Outputs HTML Navigation Bar specific for object. Objects must be declared in enterpriseResource.

Supported API: true

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

getKeyRep

private String getKeyRep(Locale locale)
                  throws WTException

Deprecated.

Gets the keyRep attribute of the BasicTemplateProcessor object

Parameters:

locale - Description of the Parameter

Returns:

The keyRep value

Throws:

WTException - Description of the Exception

createActionsBar

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

Deprecated.

Write a list of links to actions corresponding to the context object to the given OutputStream. This method retrieves the actions corresponding to the current context object from the UrlLinkResource ResourceBundle, and creates a table of hyperlinks to those actions. This method is typically to be invoked as a script call in an HTML template file. The Windchill script call that invokes this method can contain optional parameters to specify the background color for the table cells and the color of the links: createActionsBar bgcolor=(Background Color) linkcolor=(Link Color) selected_linkcolor=(Selected Link Color)

Supported API: true

Parameters:

parameters - the Properties which contains parameter values specified in the script call. Can contain values for the link color and background color of the table cells.

locale - the locale in which the links will be displayed

os - the OutputStream to write the table of links to.

Throws:

WTException - if an error occurs building the links to the actions

getActionPairs

protected static Vector getActionPairs(String keyRep,
                                       Locale locale)

Deprecated.

Returns a Vector containing strings

Parameters:

keyRep - Description of the Parameter

locale - Description of the Parameter

Returns:

The actionPairs value

allVersions

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

Deprecated.

Outputs HTML to display all versions of a Mastered object. Also has mechanism to compare versions if more than one version is found.

Supported API: false

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException - Description of the Exception

showVersions

protected void showVersions(QueryResult versions,
                            boolean versionTable,
                            Properties parameters,
                            Locale locale,
                            OutputStream os)
                     throws WTException

Deprecated.

Outputs HTML to display all versions of a Mastered object. Also has mechanism to compare versions if more than one version is found.

Supported API: false

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

versions - Description of the Parameter

versionTable - Description of the Parameter

Throws:

WTException - Description of the Exception

getLocalizedString

public String getLocalizedString(ResourceBundle resource,
                                 String key,
                                 String backup)

Deprecated.

Method to localize generic strings. There must be a key in the Resource Bundle otherwise the backup parameter will be returned.

Supported API: false

Parameters:

resource - The resource bundle for localization.

key - The key in the resource bundle.

backup - The string that will be used if key is not found.

Returns:

The localizedString value

getSearchResultsURL

public String getSearchResultsURL(String attribute,
                                  String value,
                                  String label,
                                  String search_objs,
                                  Locale locale)

Deprecated.

Supported API: false

Parameters:

attribute - Description of the Parameter

value - Description of the Parameter

label - Description of the Parameter

search_objs - Description of the Parameter

locale - Description of the Parameter

Returns:

The searchResultsURL value

include

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

Deprecated.

This method has been extended at Release 5.0. The original functionality remains and is unchanged. There are now more options available to use the include for a file into an HTML template.

The additional functionality allows the inclusion of a file with a file extension of *.htm. *.html, or *.js. The included file is NOT allowed to have Windchill script calls. If you would like to include a sub-Template with script calls, you should use the processSubTemplate script call.

There are three ways to use this script call

• Insert an ObjectPropery template into the page (Original functionality, script calls ARE processed).
• Insert plain text HTML or JavaScript into a template by specifying a relative path from codebase(Script calls ARE NOT processed)
• Insert plain text HTML into a template by specifying an entry in a properties file(Script calls ARE NOT processed)

Insert an ObjectPropery template into the page

To have a ObjectProperty page or ObjectPropertyVerbose page inserted into your current page, use the following syntax

include action=ObjProps
or
include action=ObjProps template=Simple

If the template is not specified, the template will be determined using the current context object.
The template can be any of the current ObjectProperties templates.
This method is currently unsupported for customization. It is subject to change or removal without notice.

Insert plain text HTML or JavaScript into a template by specifying a relative path from codebase

You are able to insert a file into your current template by specifying the relative path from codebase. The file you reference must have one of the following extensions : htm, html, or js . The file you include cannot have any Windchill Script calls. If you would like include an HTML template with script calls, you should call the processSubTemplate Windchill script call.

The syntax for this usage is

include fileName=<Relative file path from codebase, no file extension>

An example of this would be if you would like to include copyright information and that file was located in /codebase/templates/util/copyright.html. You would the call

include fileName=templates/util/copyright

Insert plain text HTML into a template by specifying an entry in a properties file

You are able to insert a file into your current template by specifying the context with which to find the file using the ApplicationContextServices. The file you reference must have one of the following extensions : htm, html, or js. The file you include cannot have any Windchill Script calls. If you would like include an HTML template with script calls, you should call the processSubTemplate Windchill script call.

There are two difference calls this usage.

The first version of the syntax is

include selectorString=<String key to use in a properties file entry>

This usage will find the following entry in a properties file

wt.services/rsc/default/wt.templateutil.DefaultHTMLTemplate/<String key to use in a properties file entry>/<Current Context Class>/0=<Relative path to file from codebase>

An example of a call on a page displaying a wt.part.WTPart and the the corresponding entry in a property file is

include selectorString=TestInclude

wt.services/rsc/default/wt.templateutil.DefaultHTMLTemplate/ TestInclude /wt.part.WTPart/0=templates.ObjectProperties.IncludeUsesTable

The second version of the syntax is

include selectorString=<String key to use in a properties file entry> requestorClass=<Context Class to reference in properties file>

This usage will find the following entry in a properties file

wt.services/rsc/default/wt.templateutil.DefaultHTMLTemplate/<String key to use in a properties file entry>/<Context Class to reference in properties file>/0=<Relative path to file from codebase>

An example of a call and the the corresponding entry in a property file is

include selectorString=TestInclude requestorClass=java.lang.Object

wt.services/rsc/default/wt.templateutil.DefaultHTMLTemplate/TestInclude/java.lang.Object/0=templates.ObjectProperties.IncludeUsesTable

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

handleProcessorException

public static void handleProcessorException(String methodName,
                                            Exception e,
                                            boolean printStackTrace,
                                            Properties parameters,
                                            Locale locale,
                                            OutputStream os)

Deprecated.

HandleProcessorException() method can be called in the following scenario:

Use case: An exception is thrown back to a method that corresponds to a "Windchill script language" call (a call that actually appears in an HTML template file, for example: objectPropertyValue or objectActionLink), and processing of the page should continue even though this call has failed.

This method will handle the exception by embedding a message in the generated web page that states:

"ERROR: During the dynamic generation of this web page, while processing the Windchill script language method "methodName".
The error message is: "e.getLocalizedMessage()"
A stack trace has been printed to the log.
Generation of this web page will now continue."

If printStackTrace is false, then the line about the "stack trace" will not be generated in the web page.

Supported API: false

Parameters:

methodName - The name of the Windchill script language method that has failed.

e - The exception that was generated by the method.

printStackTrace - A boolean that specifies if a stack trace should be printed to the log.

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

ignoreException

private static boolean ignoreException(Throwable t)

Deprecated.

Description of the Method

Parameters:

t - Description of the Parameter

Returns:

Description of the Return Value

handleExceptionTP

public void handleExceptionTP(String methodName,
                              Exception e,
                              boolean printStackTrace,
                              Properties parameters,
                              Locale locale,
                              OutputStream os)

Deprecated.

This flavor of the handleExceptionTP() method can be called in the following scenario:

Use case: An exception is thrown back to a method that corresponds to a "Windchill script language" call (a call that actually appears in an HTML template file, for example: objectPropertyValue or objectActionLink), and processing of the page should continue even though this call has failed.

This method will handle the exception by embedding a message in the generated web page that states:

"ERROR: During the dynamic generation of this web page, while processing the Windchill script language method "methodName".
The error message is: "e.getLocalizedMessage()"
A stack trace has been printed to the log.
Generation of this web page will now continue."

If printStackTrace is false, then the line about the "stack trace" will not be generated in the web page.

Supported API: false

Parameters:

methodName - The name of the Windchill script language method that has failed.

e - The exception that was generated by the method.

printStackTrace - A boolean that specifies if a stack trace should be printed to the log.

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

handleExceptionTP

public void handleExceptionTP(String title,
                              String text,
                              Exception e,
                              boolean printStackTrace,
                              HTTPResponse resp,
                              Locale locale)
                       throws WTException

Deprecated.

This flavor of the handleExceptionTP() method can be called in the following scenario:

Use case: Many template processors have a handleRequest() method that instantiates an HTMLTemplate, and then calls the process() method on that instance. If the process() method throws and exception, then the processing by this template processor has stopped. After catching the exception thrown by the process() method, call this flavor of handleExceptionTP().

This method will handle the exception by appending a message to the generated web page that states:

ERROR: During the dynamic generation of this web page.
The error message is: "e.getLocalizedMessage()"
A stack trace has been printed to the log.
Generation of this web page has halted.

If printStackTrace is false, then the line about the "stack trace" will not be generated in the web page.

Supported API: false

Parameters:

title - A title for the web page. If the page already has a title, this one will be ignored.

text - An informative message to be presented to the user.

e - The exception that was generated.

printStackTrace - A boolean that specifies if a stack trace should be printed to the log.

resp - The HTTPResponse object, from which the output stream is retrieved.

locale - The Locale for which to localize the messages.

Throws:

WTException - Description of the Exception

getQuery

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

Deprecated.

Gets the query specified by the value of the parameter whose key is 'QueryName'. As a short-term solution, this method is forwarded to the StdTemplateProcessor which is maintained as an instance variable.

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

setColumnProperties

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

Deprecated.

Supported API: false

Parameters:

parameters - The new columnProperties value

locale - The new columnProperties value

os - The new columnProperties value

Throws:

WTException - Description of the Exception

printTable

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

Deprecated.

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

getPersonalCabinetURL

public static String getPersonalCabinetURL(WTPrincipal principal,
                                           String label,
                                           String params,
                                           Locale locale)

Deprecated.

Return a String representation of a URL to the user's personal cabinet. If a value is not passed in for the label, use the principal's name. If a principal is not passed in, use the current principal.

Supported API: false

Parameters:

principal - the Principal whose personal cabinet will be the target of the link. If null, the current principal is used

label - the String label to be used as the target of the link

params - Description of the Parameter

locale - Description of the Parameter

Returns:

a String representation of the URL to the personal cabinet

getWorklistURL

public static String getWorklistURL(String label,
                                    String href_properties,
                                    Locale locale)

Deprecated.

Returns a String representation of a URL to the current principal's worklist.

Supported API: false

Parameters:

label - the label to use as the link text

href_properties - any additional HTML code to be placed in the A HREF tags

locale - Description of the Parameter

Returns:

a string representation of the link to the user's worklist

getHomepageURL

public static String getHomepageURL(String label,
                                    String href_properties,
                                    Locale locale)

Deprecated.

Returns a String representation of a URL to the Windchill homepage

Supported API: false

Parameters:

label - the label to use as the link text

href_properties - any additional HTML code to be placed in the A HREF tags

locale - Description of the Parameter

Returns:

a string representation of the link to the Windchill homepage

buildFormProcessorURL

public static String buildFormProcessorURL(String label,
                                           String parameters,
                                           String method,
                                           Properties properties)

Deprecated.

Returns a string representation of a URL to the FormProcessor.

Supported API: false

Parameters:

label - the label to use as the text of the link

parameters - any additional HTML to include in the HREF tag

method - the method to invoke in FormProcessor

properties - Properties passed on the URL of the FormProcessor

Returns:

a String representation of the FormProcessor URL

buildFormProcessorURL

public static String buildFormProcessorURL(String class_string,
                                           String label,
                                           String parameters,
                                           String method,
                                           Properties properties)

Deprecated.

Description of the Method

Parameters:

class_string - Description of the Parameter

label - Description of the Parameter

parameters - Description of the Parameter

method - Description of the Parameter

properties - Description of the Parameter

Returns:

Description of the Return Value

getSearchCriteriaURL

public static String getSearchCriteriaURL(String label,
                                          String search_type,
                                          Properties parameters,
                                          String href_props,
                                          Locale locale)

Deprecated.

Supported API: false

Parameters:

label - Description of the Parameter

search_type - Description of the Parameter

parameters - Description of the Parameter

href_props - Description of the Parameter

locale - Description of the Parameter

Returns:

The searchCriteriaURL value

getSearchCriteriaURL

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

Deprecated.

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

createGlobalNavigationBar

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

Deprecated.

Output a table of links to global actions. This method does not currently support customization, but needs to be updated so that it will support customization.

Supported API: true

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

getCheckedOutFolderURL

public static String getCheckedOutFolderURL(String label,
                                            String parameters,
                                            Locale locale)

Deprecated.

Gets the checkedOutFolderURL attribute of the BasicTemplateProcessor class

Parameters:

label - Description of the Parameter

parameters - Description of the Parameter

locale - Description of the Parameter

Returns:

The checkedOutFolderURL value

getFederationSearchURL

public static String getFederationSearchURL(String label,
                                            String search_type,
                                            Properties parameters,
                                            String href_props,
                                            Locale locale)

Deprecated.

Supported API: false

Parameters:

label - Description of the Parameter

search_type - Description of the Parameter

parameters - Description of the Parameter

href_props - Description of the Parameter

locale - Description of the Parameter

Returns:

The federationSearchURL value

createFederationNavigationBar

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

Deprecated.

Output a table of links to federation actions. This method does not currently support customization, but needs to be updated so that it will support customization.

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

getAllCabinetsURL

public static String getAllCabinetsURL(String label,
                                       String parameters,
                                       Locale locale)

Deprecated.

Returns a String containing the HTML code to create a link to display all cabinets. The option String label is used as the text of the link. The optional String parameters is used to add additional HTML to the forming of the link. The given Locale parameter determines the locale in which the link is displayed.

Parameters:

label - Description of the Parameter

parameters - Description of the Parameter

locale - Description of the Parameter

Returns:

The allCabinetsURL value

getStringFromResourceBundle

public static String getStringFromResourceBundle(String resource_key,
                                                 String resource_class,
                                                 Object[] params,
                                                 Locale locale)
                                          throws WTException

Deprecated.

Gets the stringFromResourceBundle attribute of the BasicTemplateProcessor class

Parameters:

resource_key - Description of the Parameter

resource_class - Description of the Parameter

params - Description of the Parameter

locale - Description of the Parameter

Returns:

The stringFromResourceBundle value

Throws:

WTException - Description of the Exception

getStringFromResourceBundle

public static String getStringFromResourceBundle(String resource_key,
                                                 String resource_class,
                                                 Locale locale)
                                          throws WTException

Deprecated.

Gets the stringFromResourceBundle attribute of the BasicTemplateProcessor class

Parameters:

resource_key - Description of the Parameter

resource_class - Description of the Parameter

locale - Description of the Parameter

Returns:

The stringFromResourceBundle value

Throws:

WTException - Description of the Exception

getLocalizedMessage

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

Deprecated.

Produces HTML that represents a localized message from a resouce bundle.

Here is an example call from within and HTML template file: getLocalizedMessage resourceKey=NULL_CONTEXT_OBJECT resourceClass=wt.enterprise.enterpriseResource

Optional parameter are:

unicodeEscaped=true - Will unicode escape any non-Ascii characters in the form of \\uXXXX
byteEncoded=true - Will encode the unicode bytes into Ascii using UTF-8 encoding. newLine=false - Will not append a line termination to the output. paramX=value - Includes the value of the parameter in an appropriate localized message. X must be a integer, distinct with respect to other 'param' values included in the same call. The referenced resource bundle key must be appropriately parameterized.

Supported API: false

Parameters:

parameters - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

getURLActions

public static Vector getURLActions(Object obj,
                                   Locale locale)
                            throws UnableToLoadServiceProperties

Deprecated.

Given an object, returns a Vector of URLActionDelegates available for that class of object. If no delegates for the particular class of the given object have been found, an empty vector is returned.

Supported API: false

Parameters:

obj - the Object for which a vector of URLActionDelegates is returned

locale - Description of the Parameter

Returns:

a Vector containing the URLActionDelegates which correspond to the class of the given object.

Throws:

UnableToLoadServiceProperties - if the service.properties used to instantiate URLActionDelegates cannot be loaded.

getURLActions

public static Vector getURLActions(Object obj,
                                   Locale locale,
                                   boolean minimal)
                            throws UnableToLoadServiceProperties

Deprecated.

Gets the uRLActions attribute of the BasicTemplateProcessor class

Parameters:

obj - Description of the Parameter

locale - Description of the Parameter

minimal - Description of the Parameter

Returns:

The uRLActions value

Throws:

UnableToLoadServiceProperties - Description of the Exception

getURLActions

public static Vector getURLActions(Class obj_class,
                                   Locale locale)
                            throws UnableToLoadServiceProperties

Deprecated.

Given a class, returns a Vector of URLActionDelegates available for that class. If no delegates for the particular class have been found, an empty vector is returned.

Supported API: false

Parameters:

obj_class - the Class for which a vector of URLActionDelegates is returned

locale - Description of the Parameter

Returns:

a Vector containing the URLActionDelegates which correspond to the given class.

Throws:

UnableToLoadServiceProperties - if the service.properties used to instantiate URLActionDelegates cannot be loaded.

getURLActions

public static Vector getURLActions(Class obj_class,
                                   Locale locale,
                                   boolean minimal_list)
                            throws UnableToLoadServiceProperties

Deprecated.

Gets the uRLActions attribute of the BasicTemplateProcessor class

Parameters:

obj_class - Description of the Parameter

locale - Description of the Parameter

minimal_list - Description of the Parameter

Returns:

The uRLActions value

Throws:

UnableToLoadServiceProperties - Description of the Exception

getURLActionsString

public String getURLActionsString(Object obj,
                                  Locale locale,
                                  String link_params)
                           throws UnableToLoadServiceProperties

Deprecated.

Returns a String of links to actions that can be performed on the given Object. The labels displayed as the text of the links are formatted using the given locale. Additional HTML to be used in building the A HREF link tag is specified in the optionally given String parameter.

Supported API: false

Parameters:

obj - the Object to which the URLs to actions apply

locale - the locale used in determining what text to display

link_params - optional HTML code to be used in the A HREF tags

Returns:

a String of HTML code containing links

Throws:

UnableToLoadServiceProperties - Description of the Exception

getURLActionsString

public String getURLActionsString(Object obj,
                                  Vector actionDelegates,
                                  Locale locale,
                                  String link_params)
                           throws UnableToLoadServiceProperties

Deprecated.

Gets the uRLActionsString attribute of the BasicTemplateProcessor object

Parameters:

obj - Description of the Parameter

actionDelegates - Description of the Parameter

locale - Description of the Parameter

link_params - Description of the Parameter

Returns:

The uRLActionsString value

Throws:

UnableToLoadServiceProperties - Description of the Exception

translateToHtml

public String translateToHtml(String value)

Deprecated.

translateToHtml replaces null values or empty strings with the HTML code for a non-breakable space. It also replaces newLine characters with the html line break code.

Parameters:

value - The value to be translated to html viewable form

Returns:

the HTML code to display value

printQueryTable

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

Deprecated.

A call to printQueryTable from an HTML template will generate an HTML table with the results of a query presented in the HTML table. "printQueryTable" assumes several things

1. You will be using a subclass of wt.enterprise.tabularresults.BasicQueryService to perform the query
2. The table is being presented within another HTML table
3. Your table's "Title" or "Caption" can be passed in and found either through introspection or a resource bundle

Here is an example of how to use a call to "printQueryTable" in a WindChill Script in an HTML template without printing a title for the table

   <SCRIPT LANGUAGE=Windchill>
   <!--
   printQueryTable QueryName=UsedByQuery colspan=4
   -->
   </SCRIPT>
  

Here is an example of how to use a call to "printQueryTable" in a WindChill Script in an HTML template that does print a title for the table

   <SCRIPT LANGUAGE=Windchill>
   <!--
   printQueryTable QueryName=UsedByQuery colspan=4 tableType= resourceBundle=
   -->
   </SCRIPT>
  

Both of these calls assume that the call to printQueryTable is going to fill an entire row in the HTML table that it is embedded. The colspan argument is used to specify the width of the parent table.

Supported API: false

Parameters:

parameters - The parameters must to pass in 1. the parameter QueryName and 2.the parameter tableType

locale - the locale used in determining what text to display

os - The output stream for the generated table

Throws:

WTException - Description of the Exception

printTextArea

public void printTextArea(String label,
                          String text,
                          Properties parameters,
                          Locale locale,
                          OutputStream os)

Deprecated.

A call to printTextArea will output an HTML textarea with a title under the assumption that the title and textarea are to appear as a row in the an HTML table. The only required entry in the "parameter" to be passed into printTextArea is "colspan" property that should pass in the number of columns in the parent HTML table.

Supported API: false

Parameters:

label - Used as the title to the textarea and is presented to the left of the textarea

text - The actual text to be displayed in the textarea

parameters - Needs to pass in several parameters to format textarea's output

locale - the locale used in determining what text to display

os - The output stream for the generated table

getResourceString

public static String getResourceString(String resourceToken,
                                       Locale locale,
                                       String resourceBundle,
                                       String defaultText)

Deprecated.

This is a service to get a localized string from a resource bundle. The resource bundle to be used is passed in as an argument, as is the locale. Additional arguments are a resource token and default text. This method uses reflection to see if the resource token is a constant name in either the locale specific or root resource bundle, and if so, uses the constant value as the resource bundle key. Otherwise, the resource token is expected to be the resource bundle key.

Supported API: false

Parameters:

resourceToken - the name of a constant whose value is a resource bundle key, or a string that is the actual resource bundle key

locale - the locale used in determining what text to display

resourceBundle - the resourceBundle to use to find the desired, localized string

defaultText - the default text to display

Returns:

string with text to display

getContextServiceName

public static String getContextServiceName(String action_delegate)

Deprecated.

Returns the CONTEXT_SERVICE_NAME for the ActionDelegate specified by the given delegate parameter. The given parameter is a String representation of the delegate class whose CONTEXT_SERVICE_NAME is to be returned.

Parameters:

action_delegate - a String representation of the ActionDelegate class whose CONTEXT_SERVICE_NAME is to be returned

Returns:

the CONTEXT_SERVICE_NAME of the given delegate. If no delegate is found corresponding to the given String class, null is returned.

isEqual

public static boolean isEqual(WTObject object_a,
                              WTObject object_b)
                       throws WTException

Deprecated.

Returns a boolean value indicating whether or not the two given WTObjects are equal. If the given WTObjects are both persistent, this method will compare for equality using the WTReferences of the object.

Parameters:

object_a - one object to be compared

object_b - one object to be compared

Returns:

true, if the two given objects are equal

Throws:

WTException - Description of the Exception

displayFolderTrail

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

Deprecated.

Description of the Method

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

getPersonalCabinet

protected static Cabinet getPersonalCabinet(WTPrincipal principal)
                                     throws FolderNotFoundException,
                                            WTException

Deprecated.

Returns the personal cabinet corresponding to the given WTPrincipal. If the given WTPrincipal is null, the current session principal is used.

Parameters:

principal - the WTPrincipal whose personal cabinet is returned

Returns:

the personal cabinet of the given WTPrincipal.

Throws:

FolderNotFoundException - Description of the Exception

WTException - Description of the Exception

getReferenceString

public static String getReferenceString(WTObject obj)
                                 throws WTException

Deprecated.

Gets the referenceString attribute of the BasicTemplateProcessor class

Parameters:

obj - Description of the Parameter

Returns:

The referenceString value

Throws:

WTException - Description of the Exception

getReferenceString

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

Deprecated.

Gets the referenceString attribute of the BasicTemplateProcessor object

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

sortQueryResult

public static SortedEnumeration sortQueryResult(QueryResult results,
                                                CollationKeyFactory key)

Deprecated.

Sorts the given QueryResult using the given CollationKeyFactory. If the given CollationKeyFactory is null, the IdentityCollationKeyFactory is used.

Parameters:

results - the QueryResult to be sorted

key - the CollationKeyFactory used for sorting

Returns:

the sorted SortedEnumeration containing the QueryResult

getHTMLHelpURL

public String getHTMLHelpURL(String helpContext,
                             Locale locale)
                      throws WTException

Deprecated.

This call will generate the URL of a Help page based on the current Context Object or Context Class Name and the HelpContext String that is passed in. The Locale of the HTML Help page will be determined by the the locale that is passed in as the second argument.

Parameters:

helpContext - The String to be used as the Context String in properties file entry

locale - The current Locale of the browser

Returns:

The URL of the correct Help Page

Throws:

WTException - Description of the Exception

getHTMLHelpURL

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

Deprecated.

Prints out a String with the HTML for a link to a context dependent Help page to the browser.

The correct Windchill script call is

getHTMLHelpURL HelpContext=<Context to locate Help Page>

The HelpContext parameter is optional. See comments below.

The help page is based on the context of the current HTML page and is found via an entry in a *.properties file. The correct entry in a properties file will look like

wt.services/rsc/default/wt.templateutil.processor.HelpHTMLTemplate/<Context Action>/<Context Class>/0=<Path to HTML Help Page><Anchor>

Where

• Context Action - The current value of getContextAction, unless the HelpContext is passed in the Script call
• Context Class - If getContextObj != null, the class of the contextObj is used, otherwise the value of getContextClassName is used. If both return null, the java.lang.Object is used.
• Path to HTML Help Page - The non-localized path to the HTML Help page relative to codebase. For example, if the HTML Help page was at /wt/helpfiles/federation/help_en /IEServices.html, then the entry in the properties file would be,

  wt.helpfiles.federation.help.IEServices

• Anchor - Optionally you can specify an anchor in the page, so if the wanted to get the anchor,VIEWIESERVICE, in the Help page above, then you would have the following entry in your properties file wt.helpfiles.federation.help.IEServices#VIEWIESERVICE

The current list of options for configuring the Help link, via name/value pairs in the parameters argument is

• HelpContext - Replaces the Context Action that is used to locate the Help Page
  
  Supported API: true

  Parameters:

  parameters - The name/value pairs passed in from the Windchill Script Call

  locale - The current Locale of the browser

  os - The OutputStream to the Browser

  Throws:

  WTException - Description of the Exception

addHTMLHelpLink

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

Deprecated.

Prints the HTML with a link to a context dependent Help page. The help page is based on the context of the current HTML page, namely the contextAction and the contextObj or contextClassName(if the contextObj == null)

The correct Windchill script call is

addHTMLHelpLink <name/value pairs indicating customized options>

Please the javadoc for the method, getHTMLHelpLink, for listing and description of the name/value pairs that specify the options for presenting an HTML help link.

Please the javadoc for the method, getHTMLHelpLink, for description of how register an HTML Help page for the page that the help link is to appear.

Supported API: true

Parameters:

parameters -

locale -

os -

Throws:

WTException

getHTMLHelpLink

public String getHTMLHelpLink(Properties parameters,
                              Locale locale,
                              OutputStream os)
                       throws WTException

Deprecated.

Returns a String with the HTML for a link to a context dependent Help page. The help page is based on the context of the current HTML page and is found via an entry in a *.properties file. The correct entry in a properties file will look like

wt.services/rsc/default/wt.templateutil.processor.HelpHTMLTemplate/<Context Action>/<Context Class>/0=<Path to HTML Help Page><Anchor>

Where

• Context Action - The current value of getContextAction
• Context Class - If getContextObj != null, the class of the contextObj is used, otherwise the value of getContextClassName is used. If both return null, the java.lang.Object is used.
• Path to HTML Help Page - The non-localized path to the HTML Help page relative to codebase. For example, if the HTML Help page was at /wt/helpfiles/federation/help_en /IEServices.html, then the entry in the properties file would be,

  wt.helpfiles.federation.help.IEServices

• Anchor - Optionally you can specify an anchor in the page, so if the wanted to get the anchor,VIEWIESERVICE, in the Help page above, then you would have the following entry in your properties file wt.helpfiles.federation.help.IEServices#VIEWIESERVICE

The current list of options for configuring the Help link, via name/value pairs in the parameters argument is

• HelpContext - Replaces the Context Action that is used to locate the Help Page
• PresentHelpLabel - true/false option that allows turning on/off the presentation of a text label. Default is on
• HelpLabelResource - The resource bundle that is used to locate the Localized text label
• HelpLabel - The resource key that is used to locate the Localized text label
• ADD_HELP_ICON - true/false option that allows turning on/off the presentation of an Icon with theHelp Link
• HELP_ICON_SELECTOR - Replaces the Context Action that is used to locate the Icon from service.properties
• HELP_ICON_POSITION - LEFT/RIGHT option allows have the Icon appear to Right of the text label. The default positioning of the Help Icon is to the left of the text label

Parameters:

parameters -

locale -

os -

Returns:

The hTMLHelpLink value

Throws:

WTException

getResourceString

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

Deprecated.

Gets the resourceString attribute of the BasicTemplateProcessor object

Supported API: true

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

setHelpContext

public void setHelpContext(String a_HelpContext)

Deprecated.

Sets the helpContext attribute of the BasicTemplateProcessor object

Parameters:

a_HelpContext - The new helpContext value

getHelpContext

public String getHelpContext()

Deprecated.

Gets the helpContext attribute of the BasicTemplateProcessor object

Returns:

The helpContext value

setContextClass

public void setContextClass(String a_contextClass)

Deprecated.

Sets the contextClass attribute of the BasicTemplateProcessor object

Parameters:

a_contextClass - The new contextClass value

getContextClass

public String getContextClass()

Deprecated.

Gets the contextClass attribute of the BasicTemplateProcessor object

Returns:

The contextClass value

readContext

public void readContext(HTTPRequest request)
                 throws WTException

Deprecated.

Description of the Method

Specified by:

readContext in interface ContextTranslator

Parameters:

request - Description of the Parameter

Throws:

WTException - Description of the Exception

writeHiddenContext

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

Deprecated.

Description of the Method

Specified by:

writeHiddenContext in interface ContextTranslator

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

writeQueryStringContext

public String writeQueryStringContext()

Deprecated.

Description of the Method

Specified by:

writeQueryStringContext in interface ContextTranslator

Returns:

Description of the Return Value

hiddenContextString

public String hiddenContextString(String name,
                                  String value)

Deprecated.

Description of the Method

Parameters:

name - Description of the Parameter

value - Description of the Parameter

Returns:

Description of the Return Value

addHiddenProperty

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

Deprecated.

Adds a feature to the HiddenProperty attribute of the BasicTemplateProcessor object

Parameters:

parameters - The feature to be added to the HiddenProperty attribute

locale - The feature to be added to the HiddenProperty attribute

os - The feature to be added to the HiddenProperty attribute

Throws:

WTException - Description of the Exception

displayAttributesTable

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

Deprecated.

Description of the Method

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

displayMeasurementSystemsDropDown

private void displayMeasurementSystemsDropDown(String currentMeasurementSystem,
                                               String displayFormTag,
                                               String tableAlignment,
                                               String tableWidth,
                                               PrintWriter out,
                                               Locale locale)
                                        throws RemoteException,
                                               WTException

Deprecated.

Description of the Method

Parameters:

currentMeasurementSystem - Description of the Parameter

displayFormTag - Description of the Parameter

tableAlignment - Description of the Parameter

tableWidth - Description of the Parameter

out - Description of the Parameter

locale - Description of the Parameter

Throws:

RemoteException - Description of the Exception

WTException - Description of the Exception

displayStyleSheetAttributesTable

public void displayStyleSheetAttributesTable(Properties parameters,
                                             Locale locale,
                                             OutputStream os,
                                             boolean USE_STYLE_SHEET)

Deprecated.

This method when is the same as displayAttributesTable() with hard-coded fonts and colors removed and references to stylesheet settings added.

Supported API: false

Parameters:

parameters - the properties passed to the processing method

locale - the locale passed to the processing method

os - the output stream passed to the processing method

USE_STYLE_SHEET - informs the processing method to use solutions.css style classes

getURLProcessorLink

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

Deprecated.

Gets the uRLProcessorLink attribute of the BasicTemplateProcessor object

Supported API: true

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

getURLProcessorLink

public String getURLProcessorLink(String methodName,
                                  Properties parameters)
                           throws WTException

Deprecated.

Gets the uRLProcessorLink attribute of the BasicTemplateProcessor object

Parameters:

methodName - Description of the Parameter

parameters - Description of the Parameter

Returns:

The uRLProcessorLink value

Throws:

WTException - Description of the Exception

getURLProcessorLink

public String getURLProcessorLink(String methodName,
                                  Properties parameters,
                                  boolean fullyQualified)
                           throws WTException

Deprecated.

Gets the uRLProcessorLink attribute of the BasicTemplateProcessor object

Parameters:

methodName - Description of the Parameter

parameters - Description of the Parameter

fullyQualified - Description of the Parameter

Returns:

The uRLProcessorLink value

Throws:

WTException - Description of the Exception

getURLProcessorLinkWithLabel

public static String getURLProcessorLinkWithLabel(String label,
                                                  String parameters,
                                                  String method,
                                                  Properties properties)

Deprecated.

Gets the uRLProcessorLinkWithLabel attribute of the BasicTemplateProcessor class

Parameters:

label - Description of the Parameter

parameters - Description of the Parameter

method - Description of the Parameter

properties - Description of the Parameter

Returns:

The uRLProcessorLinkWithLabel value

addToResponseExceptions

public void addToResponseExceptions(Exception newException)

Deprecated.

This method should be used to add to a running list of exceptions kept track of in the HTTPState object.

The stackTraces for the list of exceptions can be presented using the following Windchill Script call

Supported API: true

Specified by:

addToResponseExceptions in interface ContextHolder

Parameters:

newException -

addToResponseMessages

public void addToResponseMessages(LocalizableMessage newMessage)

Deprecated.

This method should be used to add to a running list of LocalizableMessages kept track of in the HTTPState object. This list of LocalizableMessage can be presented using the following Windchill Script call

The messages will be presented in the Locale of the HTML template

Supported API: true

Specified by:

addToResponseMessages in interface ContextHolder

Parameters:

newMessage -

addToResponseHeaders

public void addToResponseHeaders(LocalizableMessage newHeader)

Deprecated.

This method should be used to add to a running list of LocalizableMessages kept track of in the HTTPState object to present at the top of an HTML page. This list of messages can be presented using the following Windchill Script call

The goal of this option is to provide a way to present any information that occured preparing the processing of the page at the top of the page.

The LocalizableMessages will be presented in the locale of the HTML page

Supported API: true

Specified by:

addToResponseHeaders in interface ContextHolder

Parameters:

newHeader -

addToResponseFooters

public void addToResponseFooters(LocalizableMessage newFooter)

Deprecated.

This method should be used to add to a running list of Messages kept track of in the HTTPState object. This list of messages can be presented using the following Windchill Script call The goal of this option is to provide a way to present any information that occured during the processing of the page at the bottom of the page.

Supported API: true

Specified by:

addToResponseFooters in interface ContextHolder

Parameters:

newFooter - The feature to be added to the ToResponseFooters attribute

processSubTemplate

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

Deprecated.

Gets a TemplateProcessor and HTML Template and processes the HTML template in place. That is, the Windchill script call is replaced with the output of the processed HTML template. This allows a more componentized approach to your HTML templates and also allows your template processors to be componentized also.

The correct Windchill script call is

processSubTemplate action=<Context Action for sub-TemplateProcessor> <More name/value pairs>

This entry will look for the following in entry in a properties file

wt.services/rsc/default/wt.templateutil.DefaultHTMLTemplate/<Context Action for sub-TemplateProcessor> /<Current Context Object>/0=<relative path to HTML Template>

The action specified in the Windchill script call and the current context object are used to locate the correct TemplateProcessor and the HTML template via entries in the properties files, as usual.

After getting the TemplateProcessor, the current state is passed off the the sub-TemplateProcessor via the HTTPState object. The action on the HTTPState object is temporalily set to the action in the Windchill script call. The contextAction is restored to its previous value after the processing of the sub-HTML template is finished.

The Locale and OutputStream are passed off to the sub-TemplateProcessor so it knows the current Locale and has access to output stream to the browser. The name/values pairs passed in via the Windchill script are made available to the Sub-TemplateProcessor via contextProperties object of the TemplateProcessor.

Supported API: true

Parameters:

parameters -

locale -

os -

showResponseExceptions

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

Deprecated.

Presents the stackTraces from each Exception in maintained in the HTTPState object. The exceptions are added to the HTTPState object with the call to the addToResponseExceptions method.

The correct Windchill script call is

showResponseExceptions

The goal of this option is to provide a way to present a list of non-fatal stackTraces that occured in the processing of an HTML template or a HTTP Get/Post request.

Supported API: true

Parameters:

parameters -

locale -

os -

showResponseHeaders

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

Deprecated.

Presents the LocalizableMessages in maintained in the HTTPState object that were added to the HTTPState object with the call to the addToResponseHeaders method.

The correct Windchill script call is

showResponseHeaders

The goal of this option is to provide a way to present any information that occured during the processing of the page at the top of the page.

This ideal to present information in the response page that was occurred in the processing of a request in a FormTaskDelegate.

Parameters:

parameters -

locale -

os -

showResponseFooters

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

Deprecated.

Presents the LocalizableMessages in maintained in the HTTPState object that were added to the HTTPState object with the call to the addToResponseFooters method.

The correct Windchill script call is

showResponseFooters

The goal of this option is to provide a way to present any information that occured during the processing of the page at the bottom of the page.

This ideal to present information in the bottom of the HTML page regarding any occurances while processing the HTML template for the page.

Parameters:

parameters -

locale -

os -

showResponseMessages

public void showResponseMessages(Vector messages,
                                 Properties parameters,
                                 Locale locale,
                                 OutputStream os)

Deprecated.

This method will receive a Vector containing LocalizableMessages and prints them out in order. A call to the method showResponseMessage is used to format each message to be presented. A subclass of BasicTemplateProcessor can override the showResponseMessage to provide its own formatting for the LocalizableMessage

Parameters:

messages -

parameters -

locale -

os -

showResponseMessage

public void showResponseMessage(String message,
                                Properties parameters,
                                Locale locale,
                                OutputStream os)

Deprecated.

This method will receive a String and print the String out to the HMTL page in a centered HTML table with a border=3. The cell's background color is set to the wt.property wt.html.color.bg-msg and font color is set to wt.html.color.f-msg.

This method is used to format the output for the showResponseMessages method. The showResponseMessages method in turn is used to print out the html for the show*Messages method calls, such as showResponseHeaders. A subclass of BasicTemplateProcessor can override the this method to provide its own formatting for the presentation of the LocalizedMessages.

Parameters:

message -

parameters -

locale -

os -

setHTMLTableService

public void setHTMLTableService(TemplateProcessorTableService newTableService)

Deprecated.

Sets the TemplateProcessorTableService instance to be used for the Windchill script calls

tableService action=...

Parameters:

newTableService -

getHTMLTableService

public TemplateProcessorTableService getHTMLTableService()

Deprecated.

Gets the TemplateProcessorTableService instance to be used for the Windchill script calls

tableService action=...

If there is not an instance of TemplateProcessorTableService available, lazy initialization is done to present one.

The current state is passed to the TemplateProcessorTableService instance via the HTTPState object.

Supported API: true

Returns:

The hTMLTableService value

tableService

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

Deprecated.

Calls the current TemplateProcessorTableService instance and fires off an HTMLTableServiceEvent to all of the registered HTMLTableServiceEventListeners.

The correct Windchill script call is

tableService action=<A valid action for a HTMLTableServiceEventListener> <More name/value pairs>

The HTMLTableServiceEventListeners are registered in wt.properties in the entry

wt.templateutil.table.HTMLTableServiceEventListeners=...

Please see the Javadoc for the registered HTMLTableServiceEventListeners as to how to use the individual method calls and what parameters they take

Supported API: true

Parameters:

parameters -

locale -

os -

Throws:

WTException - Description of the Exception

useProcessorService

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

Deprecated.

Calls a method on a ProcessorService (or TemplateProcessor ) that is context aware.

The correct Windchill script call is

useProcessorService service=<Fully qualified classpath> method=<Method name> <More name/value pairs>

The parameters have the following meaning

• service - The fully qualified classpath of a subclass of ProcessorService or of BasicTemplateProcessor
• method - a method ( non-static or static ) that has the following signature

public void <Method name>( Properties parameters, Locale locale, OutputStream os )

• <More name/value pairs> - method dependent name/values pairs to pass in

The call to the method will have access to the context of the template processor currently processing the HTML template, for example the context object, the context action, Form data, via the HTTPState object that is passed in.

Consequently, any changes to the context, for example calls to setContextObj or setContextAction, will be reflected in the templateprocessor that is calling the method.

Parameters:

parameters -

locale -

os -

getHTMLComponentFactory

public HTMLComponentFactory getHTMLComponentFactory()

Deprecated.

Gets the hTMLComponentFactory attribute of the BasicTemplateProcessor object

Returns:

The hTMLComponentFactory value

getWTAttribute

public WTAttribute getWTAttribute()

Deprecated.

Gets the wTAttribute attribute of the BasicTemplateProcessor object

Returns:

The wTAttribute value

setPageContext

public void setPageContext(PageContext pageContext)

Deprecated.

Sets the pageContext attribute of the BasicTemplateProcessor object

Parameters:

pageContext - The new pageContext value

getPageContext

public PageContext getPageContext()

Deprecated.

Gets the pageContext attribute of the BasicTemplateProcessor object

Returns:

The pageContext value

setJavaScriptManager

public void setJavaScriptManager(JavaScriptManager javaScriptManager)

Deprecated.

Sets the javaScriptManager attribute of the BasicTemplateProcessor object

Parameters:

javaScriptManager - The new javaScriptManager value

initJavaScriptManager

public void initJavaScriptManager(Properties props,
                                  Locale locale,
                                  OutputStream os)

Deprecated.

Description of the Method

Parameters:

props - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

getJavaScriptManager

public JavaScriptManager getJavaScriptManager()

Deprecated.

Gets the javaScriptManager attribute of the BasicTemplateProcessor object

Returns:

The javaScriptManager value

getLocalizedDateFormatMessage

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

Deprecated.

Gets the localizedDateFormatMessage attribute of the BasicTemplateProcessor object

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

splitStringIntoTokens

public static String splitStringIntoTokens(String string_to_split)

Deprecated.

Removes the LABEL_SEPARATOR characters in the given string and replaces them with spaces. This method is useful for allowing arguments with spaces to be passed in to Windchill scripts.

Parameters:

string_to_split - the string to split

Returns:

the given string with spaces replacing the separators

getCharsetEncoding

public static void getCharsetEncoding(Properties parameters,
                                      Locale locale,
                                      OutputStream os)

Deprecated.

Method to output the appropriate charset encoding for the current locale. If the specific locale encoding value has been defined in wt.properties, it will be returned, otherwise the default value (also from wt.properties) will be returned. The property value is "wt.template.charset"

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

outputPropertyFromPropertyFile

public static void outputPropertyFromPropertyFile(Properties parameters,
                                                  Locale locale,
                                                  OutputStream os)

Deprecated.

Method to output the value of a property from a property file. The particular subclass of Properties and the particular method to invoke on that subclass are given in the "class" and "method" parameters. This method assumes that the method specified by the method parameter is static. The property to be output is specified by "propertyName".

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

getPropertyFromPropertyFile

public static String getPropertyFromPropertyFile(Properties parameters)
                                          throws ClassNotFoundException,
                                                 IllegalAccessException,
                                                 NoSuchMethodException,
                                                 InvocationTargetException

Deprecated.

Method to return the String value of a property from a property file. The particular subclass of Properties and the particular method to invoke on that subclass are given in the "class" and "method" parameters. This method assumes that the method specified by the method parameter is static. The property to be returned is specified by "propertyName".

Parameters:

parameters - the Properties object containing the Class name, method name and property to return

Returns:

The propertyFromPropertyFile value

Throws:

ClassNotFoundException - Description of the Exception

IllegalAccessException - Description of the Exception

NoSuchMethodException - Description of the Exception

InvocationTargetException - Description of the Exception

outputLink

public static void outputLink(Properties parameters,
                              Locale locale,
                              OutputStream os)

Deprecated.

Description of the Method

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

visualizationIsEnabled

public static boolean visualizationIsEnabled()

Deprecated.

Returns true if Windhcill visualization services are enabled or false otherwise.

Supported API: false

Returns:

Description of the Return Value

displayVisualData

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

Deprecated.

Displays a thumbnail and/or other appropriate visualization action links on the ObjectIdentificationVerbose html page of a Representable or Viewable object (WTPart, EPMDocument, WTDocument)

Supported API: false

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

getWCColor

public static String getWCColor(String styleClass)

Deprecated.

Retrieves the value of a HTML color property from wt.properties

Parameters:

styleClass - Refers to the name of a wt.html.color property in wt.properties (for example, "bg-body")

Returns:

Unquoted string in the form: #NNNNNN *

Supported API: true

getWCColor

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

Deprecated.

Retrieves the value of a HTML color property from wt.properties and writes it to the HTML page. This is for use as a Windchill script call.

The script call must pass the required parameter "styleClass" which refers to the name of a wt.html.color property in wt.properties.

The optional parameter "quotes" determines what kind of quotes will be included in the output.

The output written to the html page will be a color number string.
If quotes=none, the output will not have quotes: #NNNNNN
If quotes=single, the output will be in single quotes: '#NNNNNN'
If quotes=double or if there is no quotes parameter, the output will be in double quotes: "#NNNNNN"

Example usage in an html template: getWCColor styleClass=bg-navbar >

Supported API: true

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

getWCColorDec

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

Deprecated.

Retrieves the value of a HTML color property from wt.properties and writes it to the HTML page as a decimal integer. This is for use as a Windchill script call.

The script call must pass the required parameter "styleClass" which refers to the name of a wt.html.color property in wt.properties.

The output written to the html page will be an unquoted string in the form: nnnn...

Example usage in an html template: getWCColor styleClass=bg-body >

Supported API: true

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

getWCColorDec

public static String getWCColorDec(String styleClass)
                            throws WTException

Deprecated.

Gets the wCColorDec attribute of the BasicTemplateProcessor class

Parameters:

styleClass - Description of the Parameter

Returns:

The wCColorDec value

Throws:

WTException - Description of the Exception

getWCFontFamily

public static String getWCFontFamily()

Deprecated.

Retrieves the list of preferred HTML font faces from wt.properties

Returns:

Unquoted string in the form: [, , , ...]

Supported API: true

getWCFontFamily

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

Deprecated.

Retrieves the list of preferred HTML font faces from wt.properties. For use as a Windchill script call.

The output written to the HTML page will be a string in the form: "[, , , ...]"

The optional parameter "quotes" determines what kind of quotes will be included in the output.

If quotes=none, the output will not have quotes: [, ,...] If quotes=single, the output will be in single quotes: '[, ,...]' If quotes=double or if there is no quotes parameter, the output will be in double quotes: "[, ,...]"

Supported API: true

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

getURLFromDelegate

public static String getURLFromDelegate(URLActionDelegate delegate,
                                        Object obj,
                                        HTTPState state)
                                 throws WTException,
                                        ClassNotFoundException,
                                        NoSuchMethodException,
                                        IllegalAccessException,
                                        InvocationTargetException

Deprecated.

Given an object, a URLActionDelegate and a HTTPState object, returns a URL string for an action. This method should be used instead of calling URLActionDelegate.URL() when the concrete URLActionDelegate class is unknown.

Supported API: false

Parameters:

delegate - Description of the Parameter

obj - Description of the Parameter

state - Description of the Parameter

Returns:

The uRLFromDelegate value

Throws:

WTException - Description of the Exception

ClassNotFoundException - Description of the Exception

NoSuchMethodException - Description of the Exception

IllegalAccessException - Description of the Exception

InvocationTargetException - Description of the Exception

AccessOK

public static boolean AccessOK(String action,
                               Object obj,
                               HTTPRequest request)
                        throws WTException,
                               ClassNotFoundException,
                               NoSuchMethodException,
                               IllegalAccessException,
                               InvocationTargetException

Deprecated.

Checks whether a given action is currently available for a given object. This method should be used instead of calling ActionDelegate.enableable() when the concrete ActionDelegate class is unknown.

Supported API: false

Parameters:

action - Description of the Parameter

obj - Description of the Parameter

request - Description of the Parameter

Returns:

Description of the Return Value

Throws:

WTException - Description of the Exception

ClassNotFoundException - Description of the Exception

NoSuchMethodException - Description of the Exception

IllegalAccessException - Description of the Exception

InvocationTargetException - Description of the Exception

getPreferenceValue

protected static String getPreferenceValue(String node,
                                           String key)

Deprecated.

Gets the preferenceValue attribute of the BasicTemplateProcessor class

Parameters:

node - Description of the Parameter

key - Description of the Parameter

Returns:

The preferenceValue value

displayAttributeName

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

Deprecated.

Description of the Method

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

displayAttributeValue

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

Deprecated.

Description of the Method

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

PDMLinkIsInstalled

public static boolean PDMLinkIsInstalled()

Deprecated.

Returns true if PDMLink is installed

Supported API: false

Returns:

Description of the Return Value

getObjectDnDIcon

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

Deprecated.

Outputs the icon associated with the context object to the given OutputStream. This method will output the image including any glyphs that should be associated with it.

Supported API: false

Parameters:

parameters - the Properties passed in when this method is invoked; this parameter is not used by this method

locale - the Locale in which the image will be displayed

os - the OutputStream to write the image to.

bcwti

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

Deprecated.

No-op method to filter out copyright statements on templates so they aren't sent to browser.

The following can be included in a source subtemplate to satisfy copyright requirements but will not be sent to the browser:

<script language=windchill>

bcwti Copyright(c) 2002 Parametric Technology Corporation, all rights reserved. ecwti

</script>

This reduces the amount of data sent over the network and improves performance.

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

comment

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

Deprecated.

No-op method to filter out comments on templates so they aren't sent to browser unless the wt.property "wt.template.commentsEnabled" is true.

Comments on templates should be formatted as follows:

<SCRIPT language=Windchill>

comment text="<my comment text>"

</SCRIPT>

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

isWildfireEnabled

private boolean isWildfireEnabled()
                           throws WTException,
                                  ClassNotFoundException,
                                  NoSuchMethodException,
                                  IllegalAccessException,
                                  InvocationTargetException

Deprecated.

Gets the wildfireEnabled attribute of the BasicTemplateProcessor object

Returns:

The wildfireEnabled value

Throws:

WTException - Description of the Exception

ClassNotFoundException - Description of the Exception

NoSuchMethodException - Description of the Exception

IllegalAccessException - Description of the Exception

InvocationTargetException - Description of the Exception

isWildfireIconDelegate

private static boolean isWildfireIconDelegate(IconDelegate a_IconDelegate)

Deprecated.

Gets the wildfireIconDelegate attribute of the BasicTemplateProcessor class

Parameters:

a_IconDelegate - Description of the Parameter

Returns:

The wildfireIconDelegate value

getWildfireIconSelector

private static IconSelector getWildfireIconSelector(IconDelegate a_IconDelegate,
                                                    HTTPState a_State)

Deprecated.

Gets the wildfireIconSelector attribute of the BasicTemplateProcessor class

Parameters:

a_IconDelegate - Description of the Parameter

a_State - Description of the Parameter

Returns:

The wildfireIconSelector value

getId

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

Deprecated.

This template processor method generates an ID value. The BasicTemplateProcessor.IDPREFIX ("idprefix") property is supported. If "idprefix" is configured then the id format is _ .

If "idprefix" is not configured then the id format is .

- If "idprefix" is specified is the HTTPState's context properties then it's value is used; otherwise if "idprefix" is specified as a method property then it's value is used.

- the value returned by getContextAction() is used.

NOTE: "id=" is not generated. The correct way to call this method from an html template file is:

id=""

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

displayPendingChangeIndicator

public static String displayPendingChangeIndicator(Object object,
                                                   String gifImage,
                                                   boolean showURL)

Deprecated.

Description of the Method

Parameters:

object - Description of the Parameter

gifImage - Description of the Parameter

showURL - Description of the Parameter

Returns:

Description of the Return Value

getTrailId

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

Deprecated.

Constructs an HTML tag ID suitable for Pro/E trail file instrumentation. All HTML tags with which the user can interact should have such an ID attribute. The ids returned will have the form:

<product prefix>:<feature name>:<element type>:<unique id>

where:

• Product prefix identifies the product with which this element is associated.
• Feature name identifies the feature with which this tag is associated.
• Element type is the type of HTML tag to which this ID belongs.
• Unique id is a string designed to insure the tag is unique within the page. For the purposes of this method this is usually an arbitrary magic number or string. When an id is constructed programmatically and the tag is associated with a particular object, this can be a string identifying that object.

Any of the above four components may be missing from an id, although ids with all four are preferred wherever possible. Each of the four elements in the ID is input as a parameter to this script call. Any that are missing will be excluded from the ID. If all are missing, an empty string will be returned.

We recommend that the total number of characters in all four components not exceed 65 characters (one trail file line) for trail file readability.

NOTE: The trail id components should include only letter characters [A..Z,a..z] and digit characters [0..9].

Sample ids:

PDML:MoreSearchOptions:TextLink:782241247

PDML:Tools:DropDown:98735

Tools:DropDown

Supported API: false

Parameters:

parameters - Name/value pairs passed to the Windchill script call. The following parameters are recognized:

• product - the product prefix. See wt.htmltuil.TrailIdConstants for possible values
• feature - string to identify the page feature with which the HTML element is associated
• elementType - string to identify the type of HTML element. Recommend using one of the values in wt.htmltuil.TrailIdConstants
• uniqueId - string to ensure id uniqueness

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

getTrlIdAttribute

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

Deprecated.

Constructs a trlId tag suitable for Pro/E trail file instrumentation. All HTML tags with which the user can interact should have an ID attribute or trlId attribute. The trlIds returned will have the form:

trlId=<product prefix>:<feature name>:<element type>:<unique id>

where:

• Product prefix identifies the product with which this element is associated.
• Feature name identifies the feature with which this tag is associated.
• Element type is the type of HTML tag to which this ID belongs.
• Unique id is a string designed to insure the tag is unique within the page. For the purposes of this method this is usually an arbitrary magic number or string. When an id is constructed programmatically and the tag is associated with a particular object, this can be a string identifying that object.

Any of the above four components may be missing from a trlId, although trlIds with all four are preferred wherever possible. Each of the four elements in the trlId is input as a parameter to this script call. Any that are missing will be excluded from the trlId. If all are missing, an empty string will be returned.

We recommend that the total number of characters in all four components not exceed 65 characters (one trail file line) for trail file readability.

NOTE: The trail id components should include only letter characters [A..Z,a..z] and digit characters [0..9].

Sample trlIds:

trlId=PDML:MoreSearchOptions:TextLink:782241247

trlId=PDML:Tools:DropDown:98735

trlId=Tools:DropDown

Supported API: false

Parameters:

parameters - Name/value pairs passed to the Windchill script call. The following parameters are recognized:

• product - the product prefix. See wt.htmltuil.TrailIdConstants for possible values
• feature - string to identify the page feature with which the HTML element is associated
• elementType - string to identify the type of HTML element. Recommend using one of the values in wt.htmltuil.TrailIdConstants
• uniqueId - string to ensure id uniqueness

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

isDndMicroAppletEnabled

protected static boolean isDndMicroAppletEnabled()

Deprecated.

Gets the dndMicroAppletEnabled attribute of the BasicTemplateProcessor class

Returns:

The dndMicroAppletEnabled value

displayOrganizationIdentifier

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

Deprecated.

Description of the Method

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception

getTemplateDisplayGeneral

public void getTemplateDisplayGeneral(Properties properties,
                                      Locale locale,
                                      OutputStream os)
                               throws WTException

Deprecated.

Method to display the template property of an object along with its availability for use. This method is common to all Templateable objects that is objects that implement interface Templateable like Parts,Documents etc. All Templateable objects should have their own service or a separate TemplateProcessor, when more methods that act on Templateables need to be added.

Parameters:

locale -

os -

properties - Description of the Parameter

Throws:

WTException - Description of the Exception

getWTContainerRef

public WTContainerRef getWTContainerRef(Properties parameters,
                                        Locale locale)
                                 throws WTException

Deprecated.

Get container value as contextual value. If not found then, if the context object is WTContained object, return back it's container.

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

Returns:

The wTContainerRef value

Throws:

WTException - Description of the Exception

getWTContainerByName

public WTContainer getWTContainerByName(String containerName)
                                 throws WTException

Deprecated.

For the specified container name, return back the WTContainer object.

Parameters:

containerName - Description of the Parameter

Returns:

The wTContainerByName value

Throws:

WTException - Description of the Exception

getContainerByOid

private WTContainer getContainerByOid(String containerOid)

Deprecated.

For the specified container oid, return the WTContainer object.

Parameters:

containerOid - Description of the Parameter

Returns:

The containerByOid value

getEnabledVersion

public void getEnabledVersion(Properties properties,
                              Locale locale,
                              OutputStream os)
                       throws WTException

Deprecated.

Method to display the enabled version property of a templateable object that is a template

Parameters:

locale -

os -

properties - Description of the Parameter

Throws:

WTException - Description of the Exception

getGlyphsArray

public static String[][] getGlyphsArray()

Deprecated.

getGenericInstanceIconImgTag

public static String getGenericInstanceIconImgTag(Object obj)
                                           throws WTException

Deprecated.

Throws:

WTException

getFamilyGlyph

private static String getFamilyGlyph(String glyphLocation)
                              throws WTException

Deprecated.

Throws:

WTException

displayFolderObject

public static boolean displayFolderObject(WTContainer container,
                                          WTObject obj)
                                   throws WTException

Deprecated.

Throws:

WTException

displayGoToLatestLink

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

Deprecated.

dysplay Go To Latest iteration link on the attribute block

Parameters:

parameters - Description of the Parameter

locale - Description of the Parameter

os - Description of the Parameter

Throws:

WTException - Description of the Exception