io.crysknife.ui.navigation.client.local

Annotation Type PageHiding

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface PageHiding

Indicates that the target method should be called when the Page it belongs to is about to be removed from the navigation content panel.

The target method is permitted an optional parameter of type NavigationControl. If the parameter is present, the page navigation will not be carried out until NavigationControl#proceed() is invoked. This is useful for interrupting page navigations and then resuming at a later time (for example, to prompt the user to save their work before transitioning to a new page).

The target method's return type will must be void.

The target method can have any access type: public, protected, default, or private.

If the target method throws an exception when called, behaviour is undefined.

Author:

Jonathan Fuerth

See Also:

Page, Navigation, PageHidden