org.springframework.richclient.application.docking.vldocking
Class VLDockingApplicationPage

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.docking.vldocking.VLDockingApplicationPage

All Implemented Interfaces:

ApplicationPage, PageLayoutBuilder, ControlFactory

public class VLDockingApplicationPage
extends AbstractApplicationPage
implements PageLayoutBuilder

Author:

Rogan Dawes

Field Summary

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

logger

Constructor Summary

VLDockingApplicationPage(ApplicationWindow window, PageDescriptor pageDescriptor)

Method Summary

void	addView(String viewDescriptorId)
boolean	close() Closes this ApplicationPage.
protected JComponent	createControl() Subclasses must override this method to create a new instance of the control that this factory produces.
protected com.vlsolutions.swing.docking.Dockable	createDockable(PageComponent pageComponent)
protected com.vlsolutions.swing.docking.Dockable	createDockable(ViewDescriptor descriptor, 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 com.vlsolutions.swing.docking.Dockable	getDockable(PageComponent pageComponent)
com.vlsolutions.swing.docking.DockingContext	getDockingContext()
protected PageComponent	getPageComponent(com.vlsolutions.swing.docking.Dockable dockable)
protected boolean	giveFocusTo(PageComponent pageComponent) This method must transfer the focus to the given PageComponent.
void	setInitialLayout(Resource initialLayout)
void	setLayoutManager(VLDockingLayoutManager layoutManager)
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, closeAllEditors, createPageComponent, createPageComponentPane, findPageComponent, fireClosed, fireFocusGained, fireFocusLost, fireOpened, getActiveComponent, getApplicationEventMulticaster, getId, getPageComponentPaneFactory, getPageComponents, getPageDescriptor, getView, getViewDescriptor, getViewDescriptorRegistry, getWindow, openEditor, removePageComponentListener, setActiveComponent, 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

VLDockingApplicationPage

public VLDockingApplicationPage(ApplicationWindow window,
                                PageDescriptor pageDescriptor)

Method Detail

getPageComponent

protected PageComponent getPageComponent(com.vlsolutions.swing.docking.Dockable dockable)

getDockable

protected com.vlsolutions.swing.docking.Dockable getDockable(PageComponent pageComponent)

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

createDockable

protected com.vlsolutions.swing.docking.Dockable createDockable(PageComponent pageComponent)

createDockable

protected com.vlsolutions.swing.docking.Dockable createDockable(ViewDescriptor descriptor,
                                                                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.

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

getDockingContext

public com.vlsolutions.swing.docking.DockingContext getDockingContext()

Returns:

the dockingContext

setLayoutManager

public void setLayoutManager(VLDockingLayoutManager layoutManager)

Parameters:

layoutManager - the layoutManager to set

setInitialLayout

public void setInitialLayout(Resource initialLayout)

Parameters:

initialLayout - the initialLayout to set

close

public boolean close()

Description copied from class: AbstractApplicationPage

Closes this ApplicationPage. This method calls AbstractApplicationPage.close(PageComponent) for each open PageComponent.

Specified by:

close in interface ApplicationPage

Overrides:

close in class AbstractApplicationPage

Returns:

true if the operation was successful, false otherwise.