uk.ac.ed.epcc.webapp.forms.transition

Interface ViewTransitionFactory<K,T>

Type Parameters:

K - key type

T - target type

All Superinterfaces:

Contexed, TransitionFactory<K,T>

All Known Subinterfaces:

ViewPathTransitionProvider<K,T>, ViewTransitionProvider<K,T>

All Known Implementing Classes:

AbstractPartTransitionProvider, AbstractViewIndexedTransitionProvider, AbstractViewPathTransitionProvider, AbstractViewTransitionFactory, AbstractViewTransitionProvider, AppUserTransitionProvider, DomTransitionProvider, DynamicFormTransitionProvider, EmailTransitionProvider, LandingPageAppUserTransitionProvider, PartPathTransitionProvider, PreferenceTransitionProvider, ResponseTransitionProvider, SimpleViewTransitionProvider, TableTransitionProvider

public interface ViewTransitionFactory<K,T>
extends TransitionFactory<K,T>

A TransitionFactory that can use the generic view_target pages. These show a html summary of the object and give buttons to invoke the possible transitions on the target. The view page is shown if no specific transition is requested. This is incompatible with DefaultingTransitionFactory if both interfaces are implemented the view operation will take precedence.

See Also:

ViewTransitionProvider, ViewPathTransitionProvider

Method Summary

Modifier and Type	Method and Description
boolean	canView(T target, SessionService<?> sess) Can the current person view this target
default <X extends ContentBuilder> X	getBottomContent(X cb, T target, SessionService<?> sess) Get the content to be displayed at the bottom of the target page.
default java.lang.String	getHelp(K key) Get tooltip help string for an operation
<X extends ContentBuilder> X	getLogContent(X cb, T target, SessionService<?> sess) Get the content to be displayed on the view target page as part of the target pane.
default java.lang.String	getText(K key) get custom button content.
default <X extends ContentBuilder> X	getTopContent(X cb, T target, SessionService<?> sess) Get the content to be displayed at the top of the target page.
default boolean	showTransition(AppContext c, T target, K key) Should the transition be listed on the view page.

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.transition.TransitionFactory

accept, allowTransition, getSummaryContent, getTargetName, getTransition, getTransitions, lookupTransition

Methods inherited from interface uk.ac.ed.epcc.webapp.Contexed

getContext

Method Detail

canView

boolean canView(T target,
                SessionService<?> sess)

Can the current person view this target

Parameters:

target -

sess -

Returns:

boolean

getTopContent

default <X extends ContentBuilder> X getTopContent(X cb,
                                                   T target,
                                                   SessionService<?> sess)

Get the content to be displayed at the top of the target page. This content is at the top level of the page

Parameters:

cb -

target -

sess -

Returns:

boolean

getBottomContent

default <X extends ContentBuilder> X getBottomContent(X cb,
                                                      T target,
                                                      SessionService<?> sess)

Get the content to be displayed at the bottom of the target page. This content is at the top level of the page

Parameters:

cb -

target -

sess -

Returns:

boolean

getLogContent

<X extends ContentBuilder> X getLogContent(X cb,
                                           T target,
                                           SessionService<?> sess)

Get the content to be displayed on the view target page as part of the target pane.

Parameters:

cb -

target -

sess -

Returns:

ContentBuilder

getHelp

default java.lang.String getHelp(K key)

Get tooltip help string for an operation

Parameters:

key -

Returns:

String or null

getText

default java.lang.String getText(K key)

get custom button content. should default to the string representation of the key

Parameters:

key -

Returns:

String

showTransition

default boolean showTransition(AppContext c,
                               T target,
                               K key)

Should the transition be listed on the view page. Normally this just shows enabled transitions but we might want to hide some of these. The show a disabled button for some transitions implement ShowDisabledTransitions

Parameters:

c -

target -

key -

Returns: