com.ptc.windchill.cadx.common
Class BrowseFoldersProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              wt.templateutil.processor.NavigateFormProcessor
                  com.ptc.windchill.cadx.common.BrowseFoldersProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateNameProcessor, TemplateProcessor

public class BrowseFoldersProcessor

extends NavigateFormProcessor

implements Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Nested Class Summary

private class

BrowseFoldersProcessor.ContainerListData

Field Summary

static String	ALIAS
static String	BROWSE_FOLDERS_RESOURCE
private static String	CLASSNAME
(package private) BrowseFoldersProcessor.ContainerListData	containerListData
protected static String	CONTEXT_ID_SELECT_LIST_NAME
static String	CURRENT_CONTEXT_ID
static String	CURRENT_CONTEXT_NAME
static String	CURRENT_FOLDER_ID
(package private) WTContainer	currentContainer
(package private) Folder	currentFolder
static long	EXTERNALIZATION_VERSION_UID
protected static String	FOLDER_SELECT_LIST_NAME
static String	LOCATION
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
(package private) PickerUtilities	utilities
static String	VALUE_TO_SELECT

Fields inherited from class wt.templateutil.processor.NavigateFormProcessor

LocationSelect, NAVIGATE_FOLDERS, VERBOSE

Fields inherited from class wt.templateutil.processor.GenerateFormProcessor

DEFAULT_LIFECYCLE, ON_CHANGE_EVENT_NAME, TEAMTEMPLATE_INPUT_NAME

Fields inherited from class wt.templateutil.processor.DefaultTemplateProcessor

ACTION, CLASS, CODEBASE, 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

BrowseFoldersProcessor()

Method Summary

void	actualFolderPath(Properties parameters, Locale locale, OutputStream os)
protected String	createFoundationStyleOptionIDValue(String selectName, String optionValue)
void	currentContainerVisibilityMask(Properties parameters, Locale locale, OutputStream os)
void	currentContextId(Properties parameters, Locale locale, OutputStream os) Outputs the oid of the current container context
void	currentContextName(Properties parameters, Locale locale, OutputStream os) Outputs the name of the current container context
void	currentFolderPath(Properties parameters, Locale locale, OutputStream os)
static String	fixPathForContainer(String path, WTContainer container)
static WTContainer	getContainerFromId(String currentContextId)
private Folder	getCurrentFolder()
private Folder	getParentFolder(Folder currentFolder)
private QueryResult	getSubFolders(Folder currentFolder, WTContainer currentContainer)
void	initListContainers(Properties parameters, Locale locale, OutputStream os) List the name of containers which belongs to same solution context as the current workspace's container.
private void	initPickerUtilities(Properties parameters, Locale locale, OutputStream os) Creates an instance of PickerUtilities if no yet created
void	listContainers(Properties parameters, Locale locale, OutputStream os) Creates a SELECT tag that contains the list of containers
void	parentFolderPath(Properties parameters, Locale locale, OutputStream os)
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(BrowseFoldersProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	selectFolderMenu(Properties parameters, Locale locale, OutputStream os) Overrides GenerateFormProcessor's selectFolderMenu method to support a current folder entry "/." Supported API: false
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class wt.templateutil.processor.NavigateFormProcessor

processTemplateName, readVersion

Methods inherited from class wt.templateutil.processor.GenerateFormProcessor

addHiddenProperties, changedContextualValue, contextualValue, contextualValueEncoded, currentFolderId, 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, readVersion, selectFolderMenuForContainers, setContentHolder

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

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

LOCATION

public static String LOCATION

VALUE_TO_SELECT

public static String VALUE_TO_SELECT

CURRENT_FOLDER_ID

public static String CURRENT_FOLDER_ID

CURRENT_CONTEXT_ID

public static String CURRENT_CONTEXT_ID

CURRENT_CONTEXT_NAME

public static String CURRENT_CONTEXT_NAME

ALIAS

public static String ALIAS

BROWSE_FOLDERS_RESOURCE

public static String BROWSE_FOLDERS_RESOURCE

CONTEXT_ID_SELECT_LIST_NAME

protected static String CONTEXT_ID_SELECT_LIST_NAME

FOLDER_SELECT_LIST_NAME

protected static String FOLDER_SELECT_LIST_NAME

containerListData

BrowseFoldersProcessor.ContainerListData containerListData

utilities

PickerUtilities utilities

currentContainer

WTContainer currentContainer

currentFolder

Folder currentFolder

Constructor Detail

BrowseFoldersProcessor

public BrowseFoldersProcessor()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

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

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class NavigateFormProcessor

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

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

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class NavigateFormProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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

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

selectFolderMenu

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

Overrides GenerateFormProcessor's selectFolderMenu method to support a current folder entry "/."

Supported API: false

Overrides:

selectFolderMenu in class GenerateFormProcessor

Parameters:

parameters -

locale -

os -

Throws:

WTException

currentFolderPath

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

Overrides:

currentFolderPath in class GenerateFormProcessor

Throws:

WTException

actualFolderPath

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

Throws:

WTException

parentFolderPath

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

Overrides:

parentFolderPath in class GenerateFormProcessor

Throws:

WTException

initListContainers

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

List the name of containers which belongs to same solution context as the current workspace's container. Pre-select the current workspace container.

Throws:

WTException

listContainers

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

Creates a SELECT tag that contains the list of containers

Throws:

WTException

currentContextName

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

Outputs the name of the current container context

Throws:

WTException

currentContextId

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

Outputs the oid of the current container context

Throws:

WTException

currentContainerVisibilityMask

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

Throws:

WTException

getContainerFromId

public static WTContainer getContainerFromId(String currentContextId)

fixPathForContainer

public static String fixPathForContainer(String path,
                                         WTContainer container)
                                  throws WTException

Throws:

WTException

initPickerUtilities

private void initPickerUtilities(Properties parameters,
                                 Locale locale,
                                 OutputStream os)

Creates an instance of PickerUtilities if no yet created

getCurrentFolder

private Folder getCurrentFolder()

getSubFolders

private QueryResult getSubFolders(Folder currentFolder,
                                  WTContainer currentContainer)
                           throws WTException

Throws:

WTException

getParentFolder

private Folder getParentFolder(Folder currentFolder)
                        throws WTException

Throws:

WTException

createFoundationStyleOptionIDValue

protected String createFoundationStyleOptionIDValue(String selectName,
                                                    String optionValue)