Package org.apache.tapestry5.services

Class ComponentEventRequestParameters

org.apache.tapestry5.services.ComponentEventRequestParameters

public final class ComponentEventRequestParameters
extends 

Encapsulates all the information that may be provided in a component event request URL.

Constructor Summary

Constructors

Constructor	Description
activePageName, containingPageName, nestedComponentId, eventType, EventContext pageActivationContext, EventContext eventContext)

Method Summary

Modifier and Type	Method	Description
boolean	o)
	getActivePageName()	The name of the active page which rendered the link.
	getContainingPageName()	The name of the page containing the component that was triggered.
EventContext	getEventContext()	The event context information passed in the URL.
	getEventType()	The type of event.
	getNestedComponentId()	The path from the containing page down to the component in question.
EventContext	getPageActivationContext()	The activation context for the active page, possibly empty (but not null).
	toString()

Methods inherited from class java.lang.

, , , , , , , ,

Constructor Detail

ComponentEventRequestParameters

public  activePageName,
                                        containingPageName,
                                        nestedComponentId,
                                        eventType,
                                       EventContext pageActivationContext,
                                       EventContext eventContext)

Method Detail

toString

public  toString()

Overrides:

in class

equals

public boolean  o)

Overrides:

in class

getActivePageName

public  getActivePageName()

The name of the active page which rendered the link. This is usually, but not always, the page which contains the component.

Returns:

canonicalized page name

getContainingPageName

public  getContainingPageName()

The name of the page containing the component that was triggered. Usually this is the same as the active page, but because of Block and similar constructs, a component from other than the active page may be rendered with the active page.

Returns:

canonicalized page name

getNestedComponentId

public  getNestedComponentId()

The path from the containing page down to the component in question. This may be the empty string if the action request is routed directly to the page rather than a component.

getEventType

public  getEventType()

The type of event. When not specified in the URL, a default type of "action" (EventConstants.ACTION) is provided.

getPageActivationContext

public EventContext getPageActivationContext()

The activation context for the active page, possibly empty (but not null).

See Also:

ComponentResourcesCommon.triggerContextEvent(String, org.apache.tapestry5.EventContext, org.apache.tapestry5.ComponentEventCallback)

getEventContext

public EventContext getEventContext()

The event context information passed in the URL. Possibly empty (not not null).

See Also:

ComponentResourcesCommon.triggerContextEvent(String, org.apache.tapestry5.EventContext, org.apache.tapestry5.ComponentEventCallback)