com.filenet.wcm.toolkit.server.base
Interface WcmUiModuleInterface

All Superinterfaces:
WcmModuleInterface
All Known Subinterfaces:
WcmHeaderModuleInterface
All Known Implementing Classes:
WcmHeaderModule, WcmUiModule

public interface WcmUiModuleInterface
extends WcmModuleInterface

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

render

public void render(java.io.Writer w)
            throws java.lang.Exception
The render method writes HTML to the web page, based on its current state, and the state of associated Data Provider modules.

Parameters:
w - The writer that the method should use to write out HTML to the page.
Throws:
java.lang.Exception

getFormName

public java.lang.String getFormName()
Returns the name of the <form ...> produced when the render method is called.

Returns:
The name of the form as a String.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Event that is fired for all UI modules before the page is rendered

Parameters:
request - HttpServletRequest
response - HttpServletResponse
Throws:
java.lang.Exception - If any errors occured

getActive

public boolean getActive()
Returns the active status of this UI module. Controls whether or not onStartPage gets called by the controller on this module and all its children.

Returns:
boolean true or false

setActive

public boolean setActive(boolean value)
Sets the active value to true or false.
When set to false, onStartPage will not be called on this module or its contained descendants. For use when you don't plan to be rendering this UI module onto the page.

Returns:
The previous set value.

setJSP

public void setJSP(java.lang.String path)
Sets the Java™Server Pages (JSP) file that will be used included in render() method

Parameters:
path - path to the JSP file.

renderJSP

public void renderJSP(java.io.Writer w)
               throws java.lang.Exception
The render method writes HTML to the web page using jsp path

Parameters:
w - The writer that the method should use to write out HTML to the page.
Throws:
java.lang.Exception


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