wt.clients.gui
Class ChooserHtml

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.clients.gui.ChooserHtml

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class ChooserHtml

extends BasicTemplateProcessor

This class extends BasicTemplateProcessor and is used to build the URL for the ChooserApplet.

Supported API: false.

Extendable: false.

See Also:

TemplateProcessor, Serialized Form

Field Summary

static String	currentClass Public variable to hold the String that represents the class to be searched on.
static String	currentTask Public variable to hold the String representing the task to be performed after the user completes the search (i.e.

Fields inherited from class wt.enterprise.BasicTemplateProcessor

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

Fields inherited from interface wt.templateutil.processor.ContextTranslator

CONTEXT_LIST_IN, CONTEXT_LIST_OUT

Fields inherited from interface wt.templateutil.processor.ContextHolder

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

Constructor Summary

ChooserHtml()
The noarg constructor for ChooserHtml

Method Summary

static void	buildChooserHTML(HTTPRequest req, HTTPResponse resp) public method to process a template for a given a task (UPDATE, or VIEW) and the name of the class to be searched on (i.e.
void	currentClass(Properties parameters, Locale locale, OutputStream os) Template processed method returning the currentClass to be searched for (ie WTChangeRequest).
void	currentTask(Properties parameters, Locale locale, OutputStream os) Template processed method returning the currentTask (ie UPDATE, or VIEW).
void	getAppletParameters(Properties parameters, Locale locale, OutputStream os) When the ChooserHtml processes a template with a call to getAppletParameters, this method is called.
void	getBackground(Properties parameters, Locale locale, OutputStream os) When the ChooserHtml processes a template with a call to getBackground, this method is called.
HTMLTemplate	getTemplate(Vector preferences)
void	handleRequest(HTTPRequest req, HTTPResponse resp) The initial method called to initiate template processing, its parameters give access to the HTML request and response.

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, addHiddenProperty, addHTMLHelpLink, addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, allVersions, bcwti, buildFormProcessorURL, buildFormProcessorURL, comment, createActionsBar, createFederationNavigationBar, createGlobalNavigationBar, createNavigationBar, createParentFolderLink, currentTimestamp, displayAllCabinets, displayAttributeName, displayAttributesTable, displayAttributeValue, displayFolderContents, displayFolderObject, displayFolderTrail, displayGoToLatestLink, displayOrganizationIdentifier, displayPendingChangeIndicator, displayStyleSheetAttributesTable, displayVisualData, formatDate, getActionPairs, getAllCabinetsURL, getBaselineItems, getCharsetEncoding, getCheckedOutFolderURL, getClassIcon, getClassInfo, getContextAction, getContextClass, getContextClassName, getContextListIn, getContextListOut, 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, getWTContainerRef, handleExceptionTP, handleExceptionTP, handleProcessorException, hiddenContextString, include, initJavaScriptManager, isDndMicroAppletEnabled, isEqual, listContent, objectActionLink, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectBackground, objectIdentification, objectIdentifier, objectProperties, objectPropertyName, objectPropertyNameAux, objectPropertyNameAux2, objectPropertyValue, objectPropertyValueAux, objectPropertyValueAux2, objectPropertyValueString, outputLink, outputPropertyFromPropertyFile, parameterValue, partUsedBy, PDMLinkIsInstalled, printQueryTable, printTable, printTextArea, processSubTemplate, readContext, readExternal, readVersion, setColumnProperties, setContextAction, setContextClass, setContextClassName, setContextListIn, setContextListOut, 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, writeExternal, writeHiddenContext, writeQueryStringContext

Methods inherited from class java.lang.Object

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

Field Detail

currentTask

public static String currentTask

Public variable to hold the String representing the task to be performed after the user completes the search (i.e. UPDATE, or VIEW)

currentClass

public static String currentClass

Public variable to hold the String that represents the class to be searched on. (i.e. WTChangeRequest)

Constructor Detail

ChooserHtml

public ChooserHtml()

The noarg constructor for ChooserHtml

Method Detail

handleRequest

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

Description copied from interface: TemplateProcessor

The initial method called to initiate template processing, its parameters give access to the HTML request and response.

Supported API: true

Parameters:

req -

resp -

Throws:

WTException

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Throws:

WTException

buildChooserHTML

public static void buildChooserHTML(HTTPRequest req,
                                    HTTPResponse resp)
                             throws WTException

public method to process a template for a given a task (UPDATE, or VIEW) and the name of the class to be searched on (i.e. WTChangeRequest).

Supported API: false.

Parameters:

req - The HTTPRequest passed into the method called by the URL. The req contains a query string with the task (i.e. UPDATE, or VIEW) and the class to be searched on (i.e. WTChangeRequest).

resp - The HTTPResponse object passed into the method called by the URL (Not something you provided on the URL, but put on by HTTPGateway).

Throws:

WTException

getBackground

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

When the ChooserHtml processes a template with a call to getBackground, this method is called. It creates the body for the HTML page with the background and flushes it to the OutputStream.

Supported API: false.

Parameters:

parameters - Properties

locale - The current Locale used for internationalization

os - The OutputStream where the body of the HTML page is flushed to.

Throws:

WTException

currentTask

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

Template processed method returning the currentTask (ie UPDATE, or VIEW).

Supported API: false.

Parameters:

parameters - Properties

locale - The current Locale used for internationalization

os - The OutputStream

Throws:

WTException

currentClass

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

Template processed method returning the currentClass to be searched for (ie WTChangeRequest).

Supported API: false.

Parameters:

parameters - Properties

locale - The current Locale used for internationalization

os - The OutputStream

Throws:

WTException

getAppletParameters

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

When the ChooserHtml processes a template with a call to getAppletParameters, this method is called. It creates the String that contains the task (i.e. UPDATE, or VIEW) and the class to be searched for (i.e. WTChangeRequest) and flushes it to the OutputStream.

Supported API: false.

Parameters:

parameters - Properties

locale - The current Locale used for internationalization

os - The OutputStream where the String representing the ObjectIdentifier is flushed to.

Throws:

WTException