wt.workflow
Class WorkflowProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              wt.workflow.WorkflowProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

Direct Known Subclasses:

TableTemplateProcessor, WfTaskProcessor

public abstract class WorkflowProcessor

extends GenerateFormProcessor

See Also:

Serialized Form

Field Summary

protected static String	fontHeader
protected static String	t1bgcolhead
protected static String	t1bgevenrow
protected static String	t1fcolhead
protected static String	TABLE_ATTRIBUTES
protected static String	TABLE_DATA_ATTRIBUTES
protected static String	TABLE_DATA_FONT
protected static String	TABLE_DATA_ODD_ATTRIBUTES
protected static String	TABLE_HEAD_ATTRIBUTES
protected static String	TABLE_HEAD_FONT
protected static String	tableEvenRow HTML formatting styles
protected static String	tableHeader
protected static String	tableOddRow

Fields inherited from class wt.templateutil.processor.GenerateFormProcessor

DEFAULT_LIFECYCLE, EXTERNALIZATION_VERSION_UID, OLD_FORMAT_VERSION_UID, ON_CHANGE_EVENT_NAME, TEAMTEMPLATE_INPUT_NAME

Fields inherited from class wt.templateutil.processor.DefaultTemplateProcessor

ACTION, CLASS, CODEBASE, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR, OID, VERBOSE

Fields inherited from class wt.enterprise.BasicTemplateProcessor

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

Fields inherited from interface wt.templateutil.processor.ContextTranslator

CONTEXT_LIST_IN, CONTEXT_LIST_OUT

Fields inherited from interface wt.templateutil.processor.ContextHolder

CONTEXT_ACTION, CONTEXT_CLASS_NAME, CONTEXT_OBJ, CONTEXT_PROPERTIES, FORM_DATA, QUERY_DATA, RESPONSE_EXCEPTIONS, RESPONSE_FOOTERS, RESPONSE_HEADERS, RESPONSE_MESSAGES, RESPONSE_STRING, STATUS

Constructor Summary

WorkflowProcessor()

Method Summary

String	columnLabel(String label) Create a string of html to display a table column header with the specified label text.
String	createActionButton(String buttonName, String buttonLabel) Outputs a string containing the html to present a button (control type = "submit") with the supplied name & label
String	createObjectLink(WTObject myObject) Deprecated. at R6 See wt.workflow.work.WfHtmlFormat.createObjectLink
void	getStyleSheetProps(Properties parameters, Locale locale, OutputStream os) Adds embedded stylesheet properties into an html page.
String	tableCell(Object text) Create a string of html to display a table cell with the specified label text.
String	tableCell(Object text, int rowSpan) Create a string of html to display a table cell with the specified label text.
String	tableCellBold(Object text, int rowSpan) Create a string of html to display a table cellr with the specified label text.
String	tableOddCell(Object text) Create a string of html to display a table cell with the specified label text.

Methods inherited from class wt.templateutil.processor.GenerateFormProcessor

addHiddenProperties, changedContextualValue, contextualValue, contextualValueEncoded, currentFolderId, currentFolderPath, enumeratedTypeMenu, enumeratedTypeMenuForClass, generateAction, generatePostURL, generateUpdatePostURL, getButtonText, getContentHolder, getContextualValue, getDefaultPath, getDelim, getDnDAppletTags, getEnumeratedTypeMenu, getFormat, getFormValueFromSession, getFormValueFromSession, getFormValueFromSessionWithEnumeratedPropertyDefault, getFormValueFromSessionWithPropertyDefault, getLastUpdated, getMessageURL, getObjectIdentity, getPreferenceValue, getPrimary, getPrimary, getPrimaryAttribute, getPrimaryChecksum, getPrimaryChecksum, getPrimaryDownloadURL, getPrimaryDownloadURL, getPrimaryFileName, getPrimaryFileName, getPrimaryOidString, getPrimaryOidString, getPrimaryUploadedFromPath, getPrimaryUploadedFromPath, getPrimaryUploadURL, getPrimaryUploadURL, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getSize, getTargetType, getURLTabLink, getWTContainerRef, handleRequest, holderUploadTable, listLifeCycles, listTeamTemplates, obtainFromCovertProperty, parentFolderPath, readExternal, readVersion, selectFolderMenu, selectFolderMenuForContainers, setContentHolder, writeExternal

Methods inherited from class wt.templateutil.processor.DefaultTemplateProcessor

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

Methods inherited from class wt.enterprise.BasicTemplateProcessor

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

Methods inherited from class java.lang.Object

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

Field Detail

tableEvenRow

protected static final String tableEvenRow

HTML formatting styles

See Also:

Constant Field Values

tableOddRow

protected static final String tableOddRow

See Also:

Constant Field Values

tableHeader

protected static final String tableHeader

See Also:

Constant Field Values

fontHeader

protected static final String fontHeader

See Also:

Constant Field Values

t1bgevenrow

protected static final String t1bgevenrow

t1bgcolhead

protected static final String t1bgcolhead

t1fcolhead

protected static final String t1fcolhead

TABLE_ATTRIBUTES

protected static final String TABLE_ATTRIBUTES

See Also:

Constant Field Values

TABLE_HEAD_ATTRIBUTES

protected static final String TABLE_HEAD_ATTRIBUTES

See Also:

Constant Field Values

TABLE_HEAD_FONT

protected static final String TABLE_HEAD_FONT

See Also:

Constant Field Values

TABLE_DATA_ATTRIBUTES

protected static final String TABLE_DATA_ATTRIBUTES

See Also:

Constant Field Values

TABLE_DATA_ODD_ATTRIBUTES

protected static final String TABLE_DATA_ODD_ATTRIBUTES

See Also:

Constant Field Values

TABLE_DATA_FONT

protected static final String TABLE_DATA_FONT

See Also:

Constant Field Values

Constructor Detail

WorkflowProcessor

public WorkflowProcessor()

Method Detail

columnLabel

public String columnLabel(String label)
                   throws WTException

Create a string of html to display a table column header with the specified label text.

Parameters:

label - Text displayed on column header.

Returns:

The generated html to create a button control as a String

Throws:

WTException

tableCell

public String tableCell(Object text)
                 throws WTException

Create a string of html to display a table cell with the specified label text.

Parameters:

text - Text displayed on column header.

Returns:

The generated html to create a button control as a String

Throws:

WTException

tableOddCell

public String tableOddCell(Object text)
                    throws WTException

Create a string of html to display a table cell with the specified label text.

Parameters:

text - Text displayed on column header.

Returns:

The generated html to create a button control as a String

Throws:

WTException

tableCell

public String tableCell(Object text,
                        int rowSpan)
                 throws WTException

Create a string of html to display a table cell with the specified label text.

Parameters:

text - Text displayed on column header.

Returns:

The generated html to create a button control as a String

Throws:

WTException

tableCellBold

public String tableCellBold(Object text,
                            int rowSpan)
                     throws WTException

Create a string of html to display a table cellr with the specified label text.

Parameters:

text - Text displayed on column header.

Returns:

The generated html to create a button control as a String

Throws:

WTException

createActionButton

public String createActionButton(String buttonName,
                                 String buttonLabel)
                          throws WTException

Outputs a string containing the html to present a button (control type = "submit") with the supplied name & label

Parameters:

buttonName - Name associated with this button control when the form is submitted

buttonLabel - Text displayed on the form button.

Returns:

The generated html to create a button control as a String

Throws:

WTException

createObjectLink

public String createObjectLink(WTObject myObject)
                        throws WTException

Deprecated. at R6 See wt.workflow.work.WfHtmlFormat.createObjectLink

Outputs a string containing a html link to the object properties page of the specified object

Parameters:

myObject - Ojbect to create a link to

Returns:

Html link to myObject

Throws:

WTException

getStyleSheetProps

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

Adds embedded stylesheet properties into an html page.

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