|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.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
This class defines base behavior for all UI modules.
Field Summary |
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Constructor Summary | |
WcmUiModule()
|
Method Summary | |
boolean |
getActive()
Returns the active status of this UI module. |
java.lang.String |
getBasePath()
Returns the URL for the application root, such as "http://host:port/approot". |
java.lang.String |
getBaseUrl()
Return the URL for the current page (ex: http://host:port/approot/WcmPage.jsp). |
WcmURLBuilder |
getBaseURLBuilder()
Return the URL builder for the current page (ex: http://host:port/approot/WcmPage.jsp). |
java.lang.String |
getControllerEventUrl(java.lang.String eventName)
Generate an event URL targeted to the instance of WcmController on the current page. |
java.lang.String |
getControllerEventUrl(java.lang.String eventName,
java.lang.String requestParameters)
Generate an event URL targeted to the instance of WcmController on the current page. |
java.lang.String |
getEventFormFields()
Returns a string of hidden form fields required on all forms in the format: <input type='hidden' name='eventTarget' value='<<my name>>'> <input type='hidden' name='eventName' value='Submit'> <input type='hidden' name='eventParam1' value=''> <input type='hidden' name='eventParam2' value=''> <input type='hidden' name='eventParam3' value=''> |
java.lang.String |
getEventFormFields(java.lang.String eventName,
java.lang.String eventParam1,
java.lang.String eventParam2,
java.lang.String eventParam3)
Returns a string of hidden form fields required on all forms in the format: <input type='hidden' name='eventTarget' value='<<my name>>'> <input type='hidden' name='eventName' value='Submit'> <input type='hidden' name='eventParam1' value=''> <input type='hidden' name='eventParam2' value=''> <input type='hidden' name='eventParam3' value=''> |
java.lang.String |
getEventFormTag(java.lang.String method)
Get the open <form ...> tag using the value of getFormName() in the current module instance. |
java.lang.String |
getEventFormTag(java.lang.String method,
java.lang.String actionURL)
Get the open <form ...> tag using the value of getFormName() in the current module instance. |
java.lang.String |
getEventUrl()
Generate a URL with eventTarget to this module instance on the current page. |
java.lang.String |
getEventUrl(java.lang.String eventName)
Generate a URL with eventTarget to this module instance on the current page. |
java.lang.String |
getEventUrl(java.lang.String eventName,
java.lang.String requestParameters)
Generate a URL with eventTarget to this module instance on the current page. |
java.lang.String |
getEventUrl(java.lang.String eventTarget,
java.lang.String eventName,
java.lang.String requestParameters)
Generate an event URL targeted to the specified module instance on the current page. |
java.lang.String |
getFormName()
Returns form name. |
java.lang.String |
getFormSubmitUrl(java.lang.String formName,
java.lang.String eventName,
java.lang.String requestParameters)
Generate an event URL that submits the named form targeted to this module instance on the current page. |
java.lang.String |
getFormSubmitUrl(java.lang.String formName,
java.lang.String eventTarget,
java.lang.String eventName,
java.lang.String requestParameters)
Generate an event URL that submits the named form targeted to the specified module instance on the current page. |
java.lang.String |
getGlobalEventUrl(java.lang.String eventName)
|
java.lang.String |
getGlobalEventUrl(java.lang.String eventName,
java.lang.String requestParameters)
|
java.lang.String |
getPageUrl()
Generate a URL to go to the specified page. |
java.lang.String |
getPageUrl(boolean addWindowId)
Generate a URL to go to the specified page. |
java.lang.String |
getPageUrl(java.lang.String pageName)
Generate a URL to go to the specified page. |
java.lang.String |
getPageUrl(java.lang.String pageName,
java.lang.String requestParameters)
Generate a URL to go to the specified page, with the specified request parameters. |
WcmUiModuleInterface |
getUiParent()
Returns the parent UI module. |
boolean |
peekEvent(java.lang.String eventName)
Returns true if the specified event is currently queued for this module instance. |
void |
render(java.io.Writer w)
Default render method. |
void |
renderJSP(java.io.Writer w)
The render method writes HTML to the web page using jsp path |
boolean |
routeEvent(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Route the event defined by WcmParameter.EVENT_NAME on the request. |
boolean |
routeEvent(java.lang.String eventName,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Route the specified event. |
void |
serverSideInclude(java.lang.String jspPath,
java.io.Writer w)
Do a server-side include from the specified path below "/" + WcmController.getUIRoot() + "/jsp/modules/". |
void |
serverSideInclude(java.io.Writer w)
Do a server-side include from the specified path below "/" + WcmController.getUIRoot() + "/jsp/modules/". |
boolean |
setActive(boolean value)
Sets the active value to true or false. |
void |
setJSP(java.lang.String path)
Sets the JSP file that will be used included in render() method |
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule |
onStartPage, 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, initialize, 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.WcmUiModuleInterface |
onStartPage |
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface |
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, initialize, persist, queryDataProvider, setController, setModuleProperty, setName, setParent |
Constructor Detail |
public WcmUiModule()
Method Detail |
public void render(java.io.Writer w) throws java.lang.Exception
render
in interface WcmUiModuleInterface
w
- Writer object
java.lang.Exception
public final WcmURLBuilder getBaseURLBuilder() throws java.lang.Exception
java.lang.Exception
public final java.lang.String getBaseUrl() throws java.lang.Exception
java.lang.Exception
public final java.lang.String getPageUrl(boolean addWindowId) throws java.lang.Exception
addWindowId
- set to true if a window id is desired
java.lang.Exception
public final java.lang.String getPageUrl() throws java.lang.Exception
java.lang.Exception
public final java.lang.String getPageUrl(java.lang.String pageName) throws java.lang.Exception
pageName
- The page name to go to. If null, an URL will be generated for the current page.
java.lang.Exception
public final java.lang.String getPageUrl(java.lang.String pageName, java.lang.String requestParameters) throws java.lang.Exception
pageName
- The page name to go to. If null, an URL will be generated for the current page.requestParameters
- A request parameter string in the form "param=value¶m=value&...". null is valid.
java.lang.Exception
public final java.lang.String getEventUrl() throws java.lang.Exception
java.lang.Exception
public final java.lang.String getGlobalEventUrl(java.lang.String eventName) throws java.lang.Exception
java.lang.Exception
public final java.lang.String getGlobalEventUrl(java.lang.String eventName, java.lang.String requestParameters) throws java.lang.Exception
java.lang.Exception
public final java.lang.String getEventUrl(java.lang.String eventName) throws java.lang.Exception
eventName
- The event name that this URL is generated for.
java.lang.Exception
public final java.lang.String getEventUrl(java.lang.String eventName, java.lang.String requestParameters) throws java.lang.Exception
eventName
- The event name that this URL is generated for.requestParameters
- A request parameter string in the form "param=value¶m=value&...". null is valid.
java.lang.Exception
public final java.lang.String getEventUrl(java.lang.String eventTarget, java.lang.String eventName, java.lang.String requestParameters) throws java.lang.Exception
eventTarget
- The module name to target this event to (ex: the value of uiModule.getName()).eventName
- The event name that this URL is generated for.requestParameters
- A request parameter string in the form "param=value¶m=value&...". null is valid.
java.lang.Exception
public final java.lang.String getControllerEventUrl(java.lang.String eventName, java.lang.String requestParameters) throws java.lang.Exception
eventName
- The event name that this URL is generated for.requestParameters
- A request parameter string in the form "param=value¶m=value&...". null is valid.
java.lang.Exception
public final java.lang.String getControllerEventUrl(java.lang.String eventName) throws java.lang.Exception
eventName
- The event name that this URL is generated for.
java.lang.Exception
public final java.lang.String getFormSubmitUrl(java.lang.String formName, java.lang.String eventName, java.lang.String requestParameters) throws java.lang.Exception
formName
- The name of the form to submit. If null is specified, this method reverts to getEventUrl(eventName, requestParameters).eventName
- The event name that this URL is generated for.requestParameters
- A request parameter string in the form "param=value¶m=value&...". null is valid.
java.lang.Exception
public final java.lang.String getFormSubmitUrl(java.lang.String formName, java.lang.String eventTarget, java.lang.String eventName, java.lang.String requestParameters) throws java.lang.Exception
formName
- The name of the form to submit. If null is specified, this method reverts to getEventUrl(eventTarget, eventName, requestParameters).eventTarget
- The module name to target this event to (ex: the value of uiModule.getName()).eventName
- The event name that this URL is generated for.requestParameters
- A request parameter string in the form "param=value¶m=value&...". null is valid.
java.lang.Exception
public final java.lang.String getEventFormTag(java.lang.String method) throws java.lang.Exception
method
- Should be GET or POST. If null, POST is used.
java.lang.Exception
public final java.lang.String getEventFormTag(java.lang.String method, java.lang.String actionURL) throws java.lang.Exception
method
- Should be GET or POST. If null, POST is used.actionURL
- ActionURL. If null or not specified, basePageURL (with window id) will be used
java.lang.Exception
public final java.lang.String getEventFormFields()
public final java.lang.String getEventFormFields(java.lang.String eventName, java.lang.String eventParam1, java.lang.String eventParam2, java.lang.String eventParam3)
eventName
- The event name that this URL is generated for.eventParam1
- An optional event parameter.eventParam2
- An optional event parameter.eventParam3
- An optional event parameter.
public final java.lang.String getBasePath() throws java.lang.Exception
java.lang.Exception
public java.lang.String getFormName()
getFormName
in interface WcmUiModuleInterface
public boolean peekEvent(java.lang.String eventName)
eventName
- The name of the event to peek for.
public void serverSideInclude(java.io.Writer w) throws java.io.IOException, javax.servlet.ServletException, WcmException
w
- The Writer object that writes content back to the client/browser.
java.io.IOException
javax.servlet.ServletException
WcmException
public void serverSideInclude(java.lang.String jspPath, java.io.Writer w) throws java.io.IOException, javax.servlet.ServletException, WcmException
jspPath
- The relative path to the JSP to include.w
- The Writer object that writes content back to the client/browser.
java.io.IOException
javax.servlet.ServletException
WcmException
public boolean setActive(boolean value)
setActive
in interface WcmUiModuleInterface
public boolean getActive()
getActive
in interface WcmUiModuleInterface
public void setJSP(java.lang.String path)
setJSP
in interface WcmUiModuleInterface
path
- path to the jsp file.public final void renderJSP(java.io.Writer w) throws java.lang.Exception
WcmUiModuleInterface
renderJSP
in interface WcmUiModuleInterface
w
- The writer that the method should use to write out HTML to the page.
java.lang.Exception
public boolean routeEvent(java.lang.String eventName, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
eventName
- request
- response
-
java.lang.Exception
public boolean routeEvent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- response
-
java.lang.Exception
public WcmUiModuleInterface getUiParent()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |