org.springframework.richclient.application.mdi
Class DesktopApplicationPage

Show UML class diagram

java.lang.Object
  org.springframework.richclient.application.support.ApplicationServicesAccessor
      org.springframework.richclient.factory.AbstractControlFactory
          org.springframework.richclient.application.support.AbstractApplicationPage
              org.springframework.richclient.application.mdi.DesktopApplicationPage

All Implemented Interfaces:

ApplicationPage, PageLayoutBuilder, ControlFactory

Direct Known Subclasses:

SwingDockingApplicationPage

public class DesktopApplicationPage
extends AbstractApplicationPage
implements PageLayoutBuilder

Author:

Peter De Bruycker

Field Summary

Fields inherited from class org.springframework.richclient.application.support.ApplicationServicesAccessor

logger

Constructor Summary

DesktopApplicationPage(ApplicationWindow window, PageDescriptor pageDescriptor, int dragMode, DesktopCommandGroupFactory desktopCommandGroupFactory)

Method Summary

void	addView(String viewDescriptorId)
protected void	configureFrame(PageComponent component, JInternalFrame frame)
protected JComponent	createControl() Subclasses must override this method to create a new instance of the control that this factory produces.
protected JDesktopPane	createDesktopPane()
protected JInternalFrame	createInternalFrame(PageComponent pageComponent)
protected void	doAddPageComponent(PageComponent pageComponent) This method must add the given PageComponent in the ui.
protected void	doRemovePageComponent(PageComponent pageComponent) This method must remove the given PageComponent from the ui.
protected JInternalFrame	getInternalFrame(PageComponent pageComponent)
protected boolean	giveFocusTo(PageComponent pageComponent) This method must transfer the focus to the given PageComponent.
protected void	keepFrameDetails(PageComponent pageComponent, JInternalFrame internalFrame) Having this method allows subclasses to enrich/wrap the internal frame, for instance with a visible resizer.
protected void	setActiveComponent() Overridden so it will leave iconified frames iconified.
void	setScrollable(boolean scrollable)
protected void	updatePageComponentProperties(PageComponent pageComponent) Called when the PageComponent changes any of its properties (display name, caption, icon, ...).

Methods inherited from class org.springframework.richclient.application.support.AbstractApplicationPage

addPageComponent, addPageComponentListener, close, close, closeAllEditors, createPageComponent, createPageComponentPane, findPageComponent, fireClosed, fireFocusGained, fireFocusLost, fireOpened, getActiveComponent, getApplicationEventMulticaster, getId, getPageComponentPaneFactory, getPageComponents, getPageDescriptor, getView, getViewDescriptor, getViewDescriptorRegistry, getWindow, openEditor, removePageComponentListener, setActiveComponent, setApplicationWindow, setDescriptor, setPageComponentPaneFactory, setViewDescriptorRegistry, showView, showView

Methods inherited from class org.springframework.richclient.factory.AbstractControlFactory

createControlIfNecessary, getControl, isControlCreated, isSingleton, setSingleton

Methods inherited from class org.springframework.richclient.application.support.ApplicationServicesAccessor

getActiveWindow, getApplication, getApplicationContext, getApplicationName, getApplicationServices, getCommandConfigurer, getComponentFactory, getConversionService, getIconSource, getImageSource, getMessage, getMessage, getMessage, getMessage, getMessages, getMessageSource, getObjectConfigurer, getService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getControl

Constructor Detail

DesktopApplicationPage

public DesktopApplicationPage(ApplicationWindow window,
                              PageDescriptor pageDescriptor,
                              int dragMode,
                              DesktopCommandGroupFactory desktopCommandGroupFactory)

Method Detail

setScrollable

public void setScrollable(boolean scrollable)

giveFocusTo

protected boolean giveFocusTo(PageComponent pageComponent)

Description copied from class: AbstractApplicationPage

This method must transfer the focus to the given PageComponent. This could involve making an internal frame visible, selecting a tab in a tabbed pane, ...

Specified by:

giveFocusTo in class AbstractApplicationPage

Parameters:

pageComponent - the PageComponent

Returns:

true if the operation was successful, false otherwise

addView

public void addView(String viewDescriptorId)

Specified by:

addView in interface PageLayoutBuilder

doAddPageComponent

protected void doAddPageComponent(PageComponent pageComponent)

Description copied from class: AbstractApplicationPage

This method must add the given PageComponent in the ui.

Implementors may choose to add the PageComponent's control directly, or add the PageComponentPane's control.

Specified by:

doAddPageComponent in class AbstractApplicationPage

Parameters:

pageComponent - the PageComponent to add

createInternalFrame

protected JInternalFrame createInternalFrame(PageComponent pageComponent)

keepFrameDetails

protected void keepFrameDetails(PageComponent pageComponent,
                                JInternalFrame internalFrame)

Having this method allows subclasses to enrich/wrap the internal frame, for instance with a visible resizer.

configureFrame

protected void configureFrame(PageComponent component,
                              JInternalFrame frame)

getInternalFrame

protected JInternalFrame getInternalFrame(PageComponent pageComponent)

doRemovePageComponent

protected void doRemovePageComponent(PageComponent pageComponent)

Description copied from class: AbstractApplicationPage

This method must remove the given PageComponent from the ui.

Specified by:

doRemovePageComponent in class AbstractApplicationPage

Parameters:

pageComponent - the PageComponent to remove

createControl

protected JComponent createControl()

Description copied from class: AbstractControlFactory

Subclasses must override this method to create a new instance of the control that this factory produces.

Specified by:

createControl in class AbstractControlFactory

Returns:

The newly created control, never null.

createDesktopPane

protected JDesktopPane createDesktopPane()

updatePageComponentProperties

protected void updatePageComponentProperties(PageComponent pageComponent)

Description copied from class: AbstractApplicationPage

Called when the PageComponent changes any of its properties (display name, caption, icon, ...).

This method should be overridden when these changes must be reflected in the ui.

Overrides:

updatePageComponentProperties in class AbstractApplicationPage

Parameters:

pageComponent - the PageComponent that has changed

setActiveComponent

protected void setActiveComponent()

Overridden so it will leave iconified frames iconified.

Overrides:

setActiveComponent in class AbstractApplicationPage