PageCallback (Tapestry API - 5.7.2)

PageCallback (Tapestry API - 5.7.2)

- org.apache.tapestry5.PageCallback

All Implemented Interfaces:
```
@ImmutableSessionPersistedObject
public class PageCallback
extends 
implements 
```
A way of capturing the name of a page and the page activation context so that, at a future date, the page can be invoked with that data. This kind of callback is very useful when creating more complicated workflows, where access to a page is "interrupted" with some operation before returning (via a callback) to the original flow. Since the callback is serializable, it can be stored in the session.

Since:

5.2.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

pageName)

pageName, [] activationContext)

pageName, EventContext activationContext)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected`	`activationContextDescription()`	Returns the activation context as a string of value separated by slashes.
	`getPageName()`
`protected boolean`	`hasActivationContext()`	Does the activation context have any values? Used, typically, inside an override of `toString()`.
`Link`	`toLink(PageRenderLinkSource linkSource)`	Converts the callback (the page name and activation context) to a link; such a link may be returned from a event handler method to cause Tapestry to redirect to the page.
	`toString()`

Methods inherited from class java.lang.
, , , , , , , , ,

- Constructor Detail
  - PageCallback
```
public  pageName,
                    [] activationContext)
```
  - PageCallback
```
public  pageName,
                    EventContext activationContext)
```
  - PageCallback
```
public  pageName)
```
- Method Detail
  - getPageName
```
public  getPageName()
```
  - toString
```
public  toString()
```
    Overrides:
    
    in class
  - hasActivationContext
```
protected final boolean hasActivationContext()
```
    Does the activation context have any values? Used, typically, inside an override of toString().
  - activationContextDescription
```
protected final  activationContextDescription()
```
    Returns the activation context as a string of value separated by slashes. Typically used inside an override of toString().
  - toLink
```
public Link toLink(PageRenderLinkSource linkSource)
```
    Converts the callback (the page name and activation context) to a link; such a link may be returned from a event handler method to cause Tapestry to redirect to the page. Most of the details are encapsulated inside the PageRenderLinkSource service.
    
    Parameters:
    
    linkSource - used to generate the link
    
    Returns:
    
    link corresponding to this callback