com.filenet.wcm.apps.server.ui
Class SearchForm

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
              extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
                  extended bycom.filenet.wcm.toolkit.server.ui.WcmXSLModule
                      extended bycom.filenet.wcm.apps.server.ui.SearchForm
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
SelectOperation.SelectionSearchForm, ShortcutsPage.ShortcutSearchForm

public class SearchForm
extends com.filenet.wcm.toolkit.server.ui.WcmXSLModule

Displays Search Template criteria.


Field Summary
protected  com.filenet.wcm.apps.server.presentation.ui.PathView pathView
           
protected  WcmSearchState state
           
protected  com.filenet.wcm.apps.server.presentation.ui.ToolBar toolBar
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
transformUtil
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
SearchForm()
           
 
Method Summary
protected  void addGetInfoLink()
           
protected  void addSetAsDefaultLink()
           
protected  void addSwitchToSimpleButton()
           
protected  void configPath()
           
protected  void configToolBar()
           
static java.lang.String fixSlashes(java.lang.String value)
           
protected static com.filenet.wcm.toolkit.server.util.ui.WcmAnchor getDisabledAnchor(java.lang.String sLabel)
           
 java.lang.String getFormName()
           
static java.lang.String getLikeOperatorValue(java.lang.String literal)
           
protected  int getListViewMode()
          Returns the list view mode (detail or magazine) to be used.
static java.lang.String getOperator(java.lang.String literal)
           
 com.filenet.wcm.apps.server.presentation.ui.ToolBar getToolBar()
           
 void initialize()
           
 void onClearObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onClearUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onDebug(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onExecuteSearch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event that occurs when user clicks on "Search" button
 void onHideSearch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event that happens when clicking on "Hide Search Criteria" link.
 void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
          global even handler.
 void onRestoreDefaults(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event that occurs when user clicks on "Restore Defaults" button
 void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event that happens when clicking on an item in the Navigation list view.
 void onSelectClass(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSelectIncludeSubclasses(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSelectObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSelectUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSetAsDefault(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSetFolder(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSetObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSetUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onShowSearch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event that happens when clicking on "Show Search Criteria" link.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onStateChanged(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
          If the current search is deleted, go back to the root
 void onViewChange(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 void render(java.io.Writer w)
           
 void setInitializeFromPageParams(boolean on)
           
 void setRenderBookmarkLink(boolean on)
          Sets a flag that indicates whether to render the bookmark link.
 void setRenderInfoLink(boolean on)
          Sets a flag that indicates whether to render the info link.
 void setRenderPath(boolean on)
          Sets a flag that indicates whether to render full path module.
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
convertToNodeList, getXML, getXSLParameter, renderXSL, setXML, setXML, setXML, setXML, setXSL, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter
 
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
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
subscribeGlobalEvent
 
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
 
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

pathView

protected com.filenet.wcm.apps.server.presentation.ui.PathView pathView

toolBar

protected com.filenet.wcm.apps.server.presentation.ui.ToolBar toolBar

state

protected WcmSearchState state
Constructor Detail

SearchForm

public SearchForm()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Throws:
java.lang.Exception

getToolBar

public com.filenet.wcm.apps.server.presentation.ui.ToolBar getToolBar()

configPath

protected void configPath()
                   throws java.lang.Exception
Throws:
java.lang.Exception

configToolBar

protected void configToolBar()
                      throws java.lang.Exception
Throws:
java.lang.Exception

addSwitchToSimpleButton

protected void addSwitchToSimpleButton()
                                throws java.lang.Exception
Throws:
java.lang.Exception

addSetAsDefaultLink

protected void addSetAsDefaultLink()
                            throws java.lang.Exception
Throws:
java.lang.Exception

addGetInfoLink

protected void addGetInfoLink()
                       throws java.lang.Exception
Throws:
java.lang.Exception

onSetAsDefault

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

onStartPage

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

getOperator

public static java.lang.String getOperator(java.lang.String literal)

getLikeOperatorValue

public static java.lang.String getLikeOperatorValue(java.lang.String literal)

onShowSearch

public void onShowSearch(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
Event that happens when clicking on "Show Search Criteria" link.


onHideSearch

public void onHideSearch(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
Event that happens when clicking on "Hide Search Criteria" link.


onExecuteSearch

public void onExecuteSearch(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception
Event that occurs when user clicks on "Search" button

Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception - when any errors occur

onRestoreDefaults

public void onRestoreDefaults(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.lang.Exception
Event that occurs when user clicks on "Restore Defaults" button

Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception - when any errors occur

onViewChange

public void onViewChange(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
                  throws java.lang.Exception
Throws:
java.lang.Exception

render

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

onSelect

public void onSelect(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Event that happens when clicking on an item in the Navigation list view.

Throws:
java.lang.Exception

onDebug

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

onReset

public void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
             throws java.lang.Exception
global even handler. indicates that user clicked their Home Link so this page needs to be reset to the top level and state information cleared.

Parameters:
evt - - GlobalEven handler
Throws:
java.lang.Exception

onStateChanged

public void onStateChanged(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
                    throws java.lang.Exception
If the current search is deleted, go back to the root

Parameters:
evt -
Throws:
java.lang.Exception

setRenderPath

public void setRenderPath(boolean on)
Sets a flag that indicates whether to render full path module. by default true, if set to false, will not render Object Stores path item, and the object store item will not be clickable. used in the bookmark page

Parameters:
on - If true, renders full path.

setInitializeFromPageParams

public void setInitializeFromPageParams(boolean on)

setRenderInfoLink

public void setRenderInfoLink(boolean on)
Sets a flag that indicates whether to render the info link.

Parameters:
on - If true, renders the info link.

setRenderBookmarkLink

public void setRenderBookmarkLink(boolean on)
Sets a flag that indicates whether to render the bookmark link.

Parameters:
on - If true, renders the bookmark link.

getDisabledAnchor

protected static com.filenet.wcm.toolkit.server.util.ui.WcmAnchor getDisabledAnchor(java.lang.String sLabel)

fixSlashes

public static java.lang.String fixSlashes(java.lang.String value)

onSetFolder

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

onSetObject

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

onSelectObject

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

onSelectUser

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

onClearObject

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

onClearUser

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

onSetUser

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

onSelectClass

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

onSelectIncludeSubclasses

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

getListViewMode

protected int getListViewMode()
                       throws java.lang.Exception
Returns the list view mode (detail or magazine) to be used. Overwrite this method to force a certain view.

Returns:
WcmConfiguration.LIST_VIEW_MODE_DETAIL or WcmConfiguration.LIST_VIEW_MODE_MAGAZINE
Throws:
java.lang.Exception - If any problems occur

getFormName

public java.lang.String getFormName()


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.