com.filenet.wcm.apps.server.ui.wizard

Class WcmFileSelectWizardPage

java.lang.Object
com.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.base.GlobalEventModule
com.filenet.wcm.toolkit.server.base.WcmUiModule
com.filenet.wcm.apps.server.ui.wizard.WcmFileSelectWizardPage

All implemented interfaces:

com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmPanelInterface, com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

Direct known subclasses:

WcmEntryFileSelectWizardPage

public class WcmFileSelectWizardPage
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface

This wizard page is used to select the file to upload for adding a new document or checking in a modified document.

Nested Class Summary

Modifier and Type	Class and Description
class	`WcmFileSelectWizardPage.FileUploadManagementModule`

Field Summary

Modifier and Type	Field and Description
protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider	`adp`
protected WcmAuthoringState	`authorState`
protected boolean	`bAutoClassify`
protected WcmWorkplaceConfig	`config`
protected static java.lang.String	`FORM_NAME`
protected MultiTransferItemsListView	`listView`
protected WcmNavigationState	`naviState`
protected int	`nType`
protected java.util.Map	`requestParams`
protected WcmSitePrefs	`sitePrefs`
protected com.filenet.wcm.toolkit.server.util.WcmUploadInputStream	`uploader`
protected java.util.List	`visibleRefServices`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsAfter`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsAssociation`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsBefore`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsContinue`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsContinueText`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsExample`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsExternalFile`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsFile`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsLocalFile`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsNone`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsPathLabel`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsRequired`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsSavedFile`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsType`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsUndefined`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsUseSavedFile`
protected static com.filenet.wcm.toolkit.util.WcmString	`wsWarning`

Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
`locale, NAME_DELIMITER`

Constructor Summary

Constructor and Description
`WcmFileSelectWizardPage(int type)` Sets the type and the module name.

Method Summary

Modifier and Type	Method and Description
void	`addShortcut()` Subclass of this will add shortcut
protected void	`completeWizard()`
java.lang.String	`getFormName()`
protected java.lang.String	`getImageServiceTableHTML()`
void	`initialize()` Creates the data provider and retrieves the Authoring state.
boolean	`isFinished()` This page always accepts what the user inputs, so it is always ready for the finish event.
boolean	`isUsingActiveXControl()` Returns true if the file selection page is using an activeX control.
void	`onContinue(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)`
void	`onFinishedActiveX(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Handles the Complete event triggered after the Active-X control has finished its operations
void	`onStartPage(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` The default event handler sets up the display objects for rendering.
void	`panelCancel(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Empty function - nothing to cleanup.
void	`panelFinish(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` When the Finish button is pressed, this first checks to see the type of file it is, putting it in the WcmUploadStream object if it is a file, or passing the URL if appropriate.
void	`panelInit()` Empty function - nothing to initialize or cleanup.
void	`panelSave(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)`
void	`render(java.io.Writer w)`
protected java.lang.String	`renderExternalSection(java.io.Writer w)`
protected void	`renderFileUploadSection(java.io.Writer w)`
protected void	`renderFooterSection(java.io.Writer w)`
protected void	`renderHeaderSection(java.io.Writer w)`
protected boolean	`showMultiSelectOperations()`
protected boolean	`validateExternalUrl(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response,java.lang.String url)`
protected boolean	`validateLocalFileName(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)`

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule
`getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP`

getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP

Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
`subscribeGlobalEvent`

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
`addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty`

addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
`addDataProvider, addDataProvider`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
`addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent`

Field Detail

wsType

protected static final com.filenet.wcm.toolkit.util.WcmString wsType

wsFile

protected static final com.filenet.wcm.toolkit.util.WcmString wsFile

wsLocalFile

protected static final com.filenet.wcm.toolkit.util.WcmString wsLocalFile

wsSavedFile

protected static final com.filenet.wcm.toolkit.util.WcmString wsSavedFile

wsExternalFile

protected static final com.filenet.wcm.toolkit.util.WcmString wsExternalFile

wsNone

protected static final com.filenet.wcm.toolkit.util.WcmString wsNone

wsAssociation

protected static final com.filenet.wcm.toolkit.util.WcmString wsAssociation

wsExample

protected static final com.filenet.wcm.toolkit.util.WcmString wsExample

wsUseSavedFile

protected static final com.filenet.wcm.toolkit.util.WcmString wsUseSavedFile

wsContinueText

protected static final com.filenet.wcm.toolkit.util.WcmString wsContinueText

wsContinue

protected static final com.filenet.wcm.toolkit.util.WcmString wsContinue

wsWarning

protected static final com.filenet.wcm.toolkit.util.WcmString wsWarning

wsPathLabel

protected static final com.filenet.wcm.toolkit.util.WcmString wsPathLabel

wsRequired

protected static final com.filenet.wcm.toolkit.util.WcmString wsRequired

wsUndefined

protected static final com.filenet.wcm.toolkit.util.WcmString wsUndefined

wsBefore

protected static final com.filenet.wcm.toolkit.util.WcmString wsBefore

wsAfter

protected static final com.filenet.wcm.toolkit.util.WcmString wsAfter

FORM_NAME

protected static final java.lang.String FORM_NAME

adp

protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp

authorState

protected WcmAuthoringState authorState

naviState

protected WcmNavigationState naviState

config

protected WcmWorkplaceConfig config

sitePrefs

protected WcmSitePrefs sitePrefs

visibleRefServices

protected java.util.List visibleRefServices

nType

protected int nType

requestParams

protected java.util.Map requestParams

bAutoClassify

protected boolean bAutoClassify

uploader

protected com.filenet.wcm.toolkit.server.util.WcmUploadInputStream uploader

listView

protected MultiTransferItemsListView listView

Constructor Detail

WcmFileSelectWizardPage

public WcmFileSelectWizardPage( int type)
throws java.lang.Exception

Sets the type and the module name.

Parameters:

type - One of the defined int types for this module.

Throws:

java.lang.Exception

Method Detail

initialize

public void initialize()
throws java.lang.Exception

Creates the data provider and retrieves the Authoring state.

Specified by:

initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface

Overrides:

initialize in class com.filenet.wcm.toolkit.server.base.WcmModule

Throws:

java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

The default event handler sets up the display objects for rendering.

Specified by:

onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

Overrides:

onStartPage in class com.filenet.wcm.toolkit.server.base.GlobalEventModule

Parameters:

request - HttpServletRequest object

response - HttpServletResponse object

Throws:

java.lang.Exception - If any errors occured

showMultiSelectOperations

protected boolean showMultiSelectOperations( )
throws java.lang.Exception

Throws:

java.lang.Exception

panelInit

public void panelInit()
throws java.lang.Exception

Empty function - nothing to initialize or cleanup.

Specified by:

panelInit in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface

Throws:

java.lang.Exception

panelCancel

public void panelCancel(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Empty function - nothing to cleanup.

Specified by:

panelCancel in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface

Parameters:

request - HttpServletRequest object

response - HttpServletResponse object

Throws:

java.lang.Exception

validateLocalFileName

protected boolean validateLocalFileName( javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Throws:

java.lang.Exception

validateExternalUrl

protected boolean validateExternalUrl( javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
java.lang.String url)
throws java.lang.Exception

Throws:

java.lang.Exception

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

When the Finish button is pressed, this first checks to see the type of file it is, putting it in the WcmUploadStream object if it is a file, or passing the URL if appropriate. Then it completes the check-in or add functionality by calling the Authoring data provider.

Specified by:

panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface

Parameters:

request - HttpServletRequest object

response - HttpServletResponse object

Throws:

java.lang.Exception

onContinue

public void onContinue(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Throws:

java.lang.Exception

completeWizard

protected void completeWizard()
throws java.lang.Exception

Throws:

java.lang.Exception

render

public void render(java.io.Writer w)
throws java.lang.Exception

Description copied from class: com.filenet.wcm.toolkit.server.base.WcmUiModule

Default render method. Outputs the string "empty module".

Specified by:

render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

Overrides:

render in class com.filenet.wcm.toolkit.server.base.WcmUiModule

Parameters:

w - Writer object

Throws:

java.lang.Exception

renderFileUploadSection

protected void renderFileUploadSection( java.io.Writer w)
throws java.lang.Exception

Throws:

java.lang.Exception

renderHeaderSection

protected void renderHeaderSection( java.io.Writer w)
throws java.lang.Exception

Throws:

java.lang.Exception

renderFooterSection

protected void renderFooterSection( java.io.Writer w)
throws java.lang.Exception

Throws:

java.lang.Exception

renderExternalSection

protected java.lang.String renderExternalSection( java.io.Writer w)
throws java.lang.Exception

Throws:

java.lang.Exception

getImageServiceTableHTML

protected java.lang.String getImageServiceTableHTML( )

isUsingActiveXControl

public boolean isUsingActiveXControl( )

Returns true if the file selection page is using an activeX control.

Returns:

true when using the activeX control

isFinished

public boolean isFinished()

This page always accepts what the user inputs, so it is always ready for the finish event.

Specified by:

isFinished in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface

Returns:

true always.

getFormName

public java.lang.String getFormName( )

Description copied from class: com.filenet.wcm.toolkit.server.base.WcmUiModule

Returns form name. Base behavior returns null.

Specified by:

getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

Overrides:

getFormName in class com.filenet.wcm.toolkit.server.base.WcmUiModule

Returns:

The String value of the form name or null.

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Description copied from interface: com.filenet.wcm.toolkit.server.base.WcmPanelInterface

This event occurs when user switches between panels in WcmMultiPanelModule

Specified by:

panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface

Throws:

java.lang.Exception

addShortcut

public void addShortcut()
throws java.lang.Exception

Subclass of this will add shortcut

Throws:

java.lang.Exception

onFinishedActiveX

public void onFinishedActiveX(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Handles the Complete event triggered after the Active-X control has finished its operations

Parameters:

request - HttpServletRequest object

response - HttpServletResponse object

Throws:

java.lang.Exception