wt.workflow
Class TableTemplateProcessor

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

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TableProcessor, TemplateProcessor

Direct Known Subclasses:

AssociatedProcessProcessor, WfWorkListProcessor

public abstract class TableTemplateProcessor

extends WorkflowProcessor

implements TableProcessor

See Also:

Serialized Form

Field Summary

private static String	CODEBASE
static String	COLUMN_DEFINITION
private String	dataSetKey
static String	GROUPBY_SELECTOR
private String	groupKey
static String	LOCALE
static String	MODEL
protected static String	NO_GROUPKEY
protected static String	NO_SORTKEY
private int	numberOfColumns
private static ResourceBundle	rb
private static String	RESOURCE
protected Vector	sortableAttributes
static String	SORTBY_SELECTOR
private String	sortKey
private static boolean	VERBOSE

Fields inherited from class wt.workflow.WorkflowProcessor

fontHeader, t1bgcolhead, t1bgevenrow, t1fcolhead, TABLE_ATTRIBUTES, TABLE_DATA_ATTRIBUTES, TABLE_DATA_FONT, TABLE_DATA_ODD_ATTRIBUTES, TABLE_HEAD_ATTRIBUTES, TABLE_HEAD_FONT, tableEvenRow, tableHeader, 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, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR, OID

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

TableTemplateProcessor()

Method Summary

protected String	columnHeaders(Enumeration labels) Create html for the table column labels
String	formatSeparatorRow(String label) Create a separator row with the label text
String	getDataSetKey()
String	getGroupKey()
int	getNumberOfColumns()
Vector	getSortableAttributes()
String	getSortKey()
void	groupBySelector(Properties parameters, Locale locale, OutputStream os) Construct a drop list of the available attributes that may be selected as a groupBy key
void	setDataSetKey(String aDataSetKey)
void	setGroupKey(String aGroupKey)
void	setNumberOfColumns(int columns)
void	setSortableAttributes(Vector attributes)
void	setSortKey(String aSortKey)
void	sortBySelector(Properties parameters, Locale locale, OutputStream os) Construct a drop list of the available attributes that may be selected as a sortBy key
void	tableItems(Properties parameters, Locale locale, OutputStream os) Construct the table of data

Methods inherited from class wt.workflow.WorkflowProcessor

columnLabel, createActionButton, createObjectLink, getStyleSheetProps, tableCell, tableCell, tableCellBold, tableOddCell

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

Methods inherited from interface wt.workflow.TableProcessor

getModel

Field Detail

CODEBASE

private static String CODEBASE

VERBOSE

private static boolean VERBOSE

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

rb

private static final ResourceBundle rb

sortKey

private String sortKey

groupKey

private String groupKey

dataSetKey

private String dataSetKey

sortableAttributes

protected Vector sortableAttributes

numberOfColumns

private int numberOfColumns

SORTBY_SELECTOR

public static final String SORTBY_SELECTOR

See Also:

Constant Field Values

GROUPBY_SELECTOR

public static final String GROUPBY_SELECTOR

See Also:

Constant Field Values

NO_SORTKEY

protected static final String NO_SORTKEY

See Also:

Constant Field Values

NO_GROUPKEY

protected static final String NO_GROUPKEY

See Also:

Constant Field Values

MODEL

public static final String MODEL

See Also:

Constant Field Values

LOCALE

public static final String LOCALE

See Also:

Constant Field Values

COLUMN_DEFINITION

public static final String COLUMN_DEFINITION

See Also:

Constant Field Values

Constructor Detail

TableTemplateProcessor

public TableTemplateProcessor()

Method Detail

tableItems

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

Construct the table of data

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

columnHeaders

protected String columnHeaders(Enumeration labels)
                        throws WTException

Create html for the table column labels

Parameters:

labels - Enumeration of column labels

Returns:

Html to display table column labels

Throws:

WTException

formatSeparatorRow

public String formatSeparatorRow(String label)

Create a separator row with the label text

Parameters:

label - The text to be displayed in the separator row

groupBySelector

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

Construct a drop list of the available attributes that may be selected as a groupBy key

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

sortBySelector

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

Construct a drop list of the available attributes that may be selected as a sortBy key

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

setSortKey

public void setSortKey(String aSortKey)

getSortKey

public String getSortKey()

setGroupKey

public void setGroupKey(String aGroupKey)

getGroupKey

public String getGroupKey()

setDataSetKey

public void setDataSetKey(String aDataSetKey)

getDataSetKey

public String getDataSetKey()

setSortableAttributes

public void setSortableAttributes(Vector attributes)

getSortableAttributes

public Vector getSortableAttributes()

setNumberOfColumns

public void setNumberOfColumns(int columns)

getNumberOfColumns

public int getNumberOfColumns()