org.springframework.richclient.application
Interface ApplicationPage

Show UML class diagram

All Superinterfaces:

ControlFactory

All Known Implementing Classes:

AbstractApplicationPage, DefaultApplicationPage, DesktopApplicationPage, FlexDockApplicationPage, SwingDockingApplicationPage, TabbedApplicationPage, TabbedSwingDockingApplicationPage, VLDockingApplicationPage

public interface ApplicationPage
extends ControlFactory

An ApplicationPage is a container for PageComponent s.

Method Summary

void	addPageComponentListener(PageComponentListener listener)
boolean	close()
boolean	close(PageComponent pageComponent)
boolean	closeAllEditors()
PageComponent	getActiveComponent()
String	getId()
List<PageComponent>	getPageComponents() Returns the list of PageComponents on this ApplicationPage.
<T extends View> T	getView(String id) Returns the View with the given id.
ApplicationWindow	getWindow()
void	openEditor(Object editorInput)
void	removePageComponentListener(PageComponentListener listener)
void	setActiveComponent(PageComponent pageComponent)
View	showView(String id) Shows the View with the given id.
View	showView(String id, Object input) Shows the View with the given id, and passes the input to the View, by calling View.setInput(Object).

Methods inherited from interface org.springframework.richclient.factory.ControlFactory

getControl

Method Detail

getId

String getId()

getWindow

ApplicationWindow getWindow()

addPageComponentListener

void addPageComponentListener(PageComponentListener listener)

removePageComponentListener

void removePageComponentListener(PageComponentListener listener)

getActiveComponent

PageComponent getActiveComponent()

setActiveComponent

void setActiveComponent(PageComponent pageComponent)

showView

View showView(String id)

Shows the View with the given id.

If the View is already opened, the view will be reused.

NOTE: this is NOT the same as calling this.showView(id, null).

Parameters:

id - the view id, cannot be empty

Returns:

the View that is shown

showView

View showView(String id,
              Object input)

Shows the View with the given id, and passes the input to the View, by calling View.setInput(Object).

If the View is already opened, the view will be reused.

Parameters:

id - the view id, cannot be empty

input - the input, can be null

Returns:

the View that is shown

getView

<T extends View> T getView(String id)

Returns the View with the given id. Returns null if no View with the given id is shown.

This method is "generified" to avoid extra casts when calling this method:

 ApplicationPage page = ...; // get a reference to the ApplicationPage
 InitialView initialView = page.getView("initialView");
 

Parameters:

id - the id, cannot be null

Returns:

the View, or null

openEditor

void openEditor(Object editorInput)

closeAllEditors

boolean closeAllEditors()

close

boolean close()

close

boolean close(PageComponent pageComponent)

getPageComponents

List<PageComponent> getPageComponents()

Returns the list of PageComponents on this ApplicationPage.

Returns:

the page components