Common Methods Used In Portlet.cfc; Coldfusion Portlet Components - Adobe 38043740 - ColdFusion Standard - Mac Development Manual

DEVELOPING COLDFUSION 9 APPLICATIONS
ColdFusion Portlets

Common methods used in portlet.cfc

Some common methods that are used frequently while creating the ColdFusion component portlet, such as
HelloPortlet.cfc, are:
Method Description
doView() This method renders the
portlet content. It is called by
the portlet container to allow
the portlet to generate the
content of the response based
on its current state.
doHelp() Helper method to serve up the
HELP mode.
doEdit() Helper method to serve up the
EDIT mode.
ProcessAction Called by the portlet container
() to allow the portlet to process
an action request
Init() Called by the portlet container
to indicate to a portlet that the
portlet is being placed into
service
processEvent This is used to consume the
event once it is published.

ColdFusion portlet components

You can configure your ColdFusion portlet components to define its modes, window states, title, scope, and
parameters.
For references of ColdFusion Portlet API, see the
Currently, WSRP 1.0 is the supported standard for portlets.
Syntax
<cffunction name="doView" returntype="void" output="true">
<cfargument name="renderRequest" type="any" required="true" hint="A
javax.portlet.RenderRequest java object">
<cfargument name="renderResponse" type="any" required="true"
hint="A javax.portlet.RenderResponse java object">
<!--- User code goes here --?>
</cffunction>
<cffunction name="doHelp" returntype="void" output="true">
<cfargument name="renderRequest" type="any" required="true" hint="A
javax.portlet.RenderRequest java object">
<cfargument name="renderResponse" type="any" required="true"
hint="A javax.portlet.RenderResponse java object">
<!--- User code goes here --? </cffunction>
<cffunction name="doEdit" returntype="void" output="true">
<cfargument name="renderRequest" type="any" required="true" hint="A
javax.portlet.RenderRequest java object"><cfargument
name="renderResponse" type="any" required="true" hint="A
javax.portlet.RenderResponse java object">
<!--- User code goes here --? </cffunction>
<cffunction name="processAction" returntype="void" access="public"
output="false" hint="Called by the portlet container to allow the
portlet to process an action request.">
<cfargument name="actionRequest" type="any" required="true" hint="A
javax.portlet.ActionRequest java object">
<cfargument name="actionResponse" type="any" required="true"
hint="A javax.portlet.ActionResponse java object">
<!--- User code goes here --? </cffunction>
<cffunction name="init" returntype="void" access="public"
output="false" hint="Called by the portlet container to indicate to
a portlet that the portlet is being placed into service.">
<cfargument name="portletConfig" type="any" required="true" hint="A
javax.portlet.PortletConfig java object">
<!--- User code goes here --? </cffunction>
<cffunction name="processEvent" returntype="void" access="public"
output="false" hint="Called by the portlet container requesting the
portlet to process a specific event.">
<!---user code--->
</cffunction>
JSR-168 specification for all
Last updated 1/20/2012
classes.
javax.portlet.*
906