
Overview	Library	Tag	Help

FRAMES NO FRAMES

Oracle Fusion Middleware JSP Tag Java API Reference for Oracle WebLogic Portal
10g Release 3 (10.3.2)
E14256-03

Portal Framework Rendering
Tag customEventUrl


Description

A convenience tag to create URLs to submit custom events. Use this tag to create links to create custom events.

A CustomEventURL is targeted to the portlet that generated it, but the event itself is generated by the portal framework and is not marked as coming from any particular portlet. Any portlets listening for the event that restrict what portlets they are listening to will therefore not receive the event.

The customEventURL tag should not be used inside of Java portlets (JSR168 / JSR286). To get equivalent functionality with a java portlet, use the java portlet tag library's actionURL tag to generate an action URL to the portlet, then have the portlet's processAction() method send the event.

For more information, see the javadoc for com.bea.portlet.CustomEventURL.


Tag Information
Tag Class	com.bea.netuix.servlets.jsp.taglib.CustomEventURLTag
TagExtraInfo Class	com.bea.netuix.servlets.jsp.taglib.URLTagExtraInfo
Body Content	JSP
Display Name	Custom Event Url


Attributes
Name	Required	Request-time	Description

forcedAmpForm	false	true	Forces the form of query separators used for this URL. This overrides the natural mechanisms for determining ampersand entity or character usage based on document type and/or configuration. If the value 'true' is used, then "&" will be the separator. If 'false' is used, then "&" will be the separator.

var	false	true	The name of the variable to which the return value will be assigned. The return value is of type java.lang.String.

scope	false	true	The scope in which the variable should live. Defaults to page scope. Valid values are "REQUEST", "SESSION", or "APPLICATION".

scheme	false	true	Valid values are "http" and "https". If not specified, uses the scheme that was used to make the request.

domain	false	true	Server domain. If not specified, uses the domain that was used to make the request. If requests are made via a proxy, specify the domain of the proxy server.

port	false	true	Server port. If not specified, uses the port from the request. If requests are made via a proxy, specify the port of the proxy server for the scheme used.

pathPrefix	false	true	A prefix that will be applied to the URL template specified. The value is inserted into the {url:prefix} token in the URL template.

encodeSession	false	true	Encodes the URL to include session ID. Defaults to true.

eventName	true	true	The name of the custom event to be fired when this link is accessed.

template	false	true	Sets a URL template for this URL. URL templates should be specified in "beehive-url-template-config.xml" file in WEB-INF directory of the webapp. Defaults to "default".


Variables
No Variables Defined.


Overview	Library	Tag	Help

FRAMES NO FRAMES

Oracle Fusion Middleware JSP Tag Java API Reference for Oracle WebLogic Portal
10g Release 3 (10.3.2)
E14256-03

Portal Framework Rendering Tag customEventUrl

Portal Framework Rendering
Tag customEventUrl