|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
WcmUiModuleInterface extends WcmModuleInterface, and adds methods for handling events, rendering, and generating event URL's.
Method Summary | |
boolean |
getActive()
Returns the active status of this UI module. |
java.lang.String |
getFormName()
Returns the name of the <form ...> produced when the render method is called. |
void |
onStartPage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event that is fired for all UI modules before the page is rendered |
void |
render(java.io.Writer w)
The render method writes HTML to the web page, based on its current state, and the state of associated Data Provider modules. |
void |
renderJSP(java.io.Writer w)
The render method writes HTML to the web page using jsp path |
boolean |
setActive(boolean value)
Sets the active value to true or false. |
void |
setJSP(java.lang.String path)
Sets the Java™Server Pages (JSP) file that will be used included in render() method |
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface |
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, initialize, persist, queryDataProvider, setController, setModuleProperty, setName, setParent |
Method Detail |
public void render(java.io.Writer w) throws java.lang.Exception
w
- The writer that the method should use to write out HTML to the page.
java.lang.Exception
public java.lang.String getFormName()
public void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequestresponse
- HttpServletResponse
java.lang.Exception
- If any errors occuredpublic boolean getActive()
public boolean setActive(boolean value)
public void setJSP(java.lang.String path)
path
- path to the JSP file.public void renderJSP(java.io.Writer w) throws java.lang.Exception
w
- The writer that the method should use to write out HTML to the page.
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |