com.manydesigns.portofino.dispatcher

Interface DispatchElement

All Known Subinterfaces:

PageAction

All Known Implementing Classes:

AbstractCrudAction, AbstractPageAction, ActivityStreamAction, ApplicationWizard, CalendarAction, ChartAction, ChartJsAction, CrudAction, CustomAction, DefaultLoginAction, Dispatcher.Root, FormAction, GalleryAction, JFreeChartAction, ManyToManyAction, MapAction, OpenIdLoginAction, PageAdminAction, RootChildrenAction, RootConfigurationAction, RootPermissionsAction, SafeModeAction, TableFormAction, TextAction

public interface DispatchElement

Author:

Angelo Lupo - angelo.lupo@manydesigns.com, Giampiero Granatella - giampiero.granatella@manydesigns.com, Emanuele Poggi - emanuele.poggi@manydesigns.com, Alessio Stalla - alessio.stalla@manydesigns.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	copyright

Method Summary

Methods

Modifier and Type	Method and Description
DispatchElement	consumePathFragment(String pathFragment) Visits a path element.
PageInstance	getPageInstance() Returns the PageInstance of this element.
void	setPageInstance(PageInstance pageInstance) Sets the PageInstance of this element.

Field Detail

copyright

static final String copyright

See Also:

Constant Field Values

Method Detail

getPageInstance

PageInstance getPageInstance()

Returns the PageInstance of this element.

setPageInstance

void setPageInstance(PageInstance pageInstance)

Sets the PageInstance of this element. Invoked automatically by the framework.

consumePathFragment

DispatchElement consumePathFragment(String pathFragment)

Visits a path element.

Parameters:

pathFragment - one of the elements of the path being visited (e.g. in /a/b/c, one path fragment might be the string "a")

Returns:

the next element in the dispatch, or null if not available. Typically it is either a sub-page action matching the specified fragment, or `this` (the same element) if the fragment was used as a path parameter. However, subclasses have freedom to return what they want.